diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 2ca86829..00000000 --- a/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -_site/ -.sass-cache/ -.jekyll-cache/ -.jekyll-metadata diff --git a/README.md b/README.md deleted file mode 100644 index c9113302..00000000 --- a/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# NetApp Console Automation - -Welcome to the open-source documentation for the NetApp Console REST API and related automation technologies. - -We'd appreciate your help to ensure the accuracy and usefulness of this content. If you see an error or have a recommendation, either open an issue at this repo or make the changes yourself and create a pull request. For more details about contributing, see our [Contributor's Guide](https://docs.netapp.com/us-en/contribute/). - -If you'd like to view the documentation, go to https://docs.netapp.com/us-en/console-automation/. diff --git a/_include/README.md b/_include/README.md deleted file mode 100644 index 11b74ec9..00000000 --- a/_include/README.md +++ /dev/null @@ -1 +0,0 @@ -# This README file exists to cause the empty folder to be created. Delete this file when you add your first include file to this folder. diff --git a/_index.yml b/_index.yml deleted file mode 100644 index 243c5652..00000000 --- a/_index.yml +++ /dev/null @@ -1,72 +0,0 @@ -indexpage: - title: NetApp Console API documentation - lead: The NetApp Console enables you to build, protect, and govern your hybrid multi-cloud data from a single control plane. The Console is composed of distinct services, each of which exposes an associated REST API that enables you to automate the administration of your cloud-based and on-premises resources. Use this site to learn about the REST implementations and common REST workflows in the Console, and to access the REST API details for many of the Console services. - summary: The NetApp Console enables you to build, protect, and govern your hybrid multi-cloud data from a single control plane. The Console is composed of distinct services, each of which exposes an associated REST API that enables you to automate the administration of your cloud-based and on-premises resources. Use this site to learn about the REST implementations and common REST workflows in the Console, and to access the REST API details for many of the Console services. - keywords: automation, automating, bluexp, netapp, console - tiles: - - title: Get started - links: - - title: NetApp Console control plane - url: /platform/overview.html - - title: Common REST implementation - url: /platform/concepts.html - - title: Workflow processes and tasks - url: /platform/workflows_tasks.html - - title: Authentication and authorization - url: /platform/aa_concepts.html - - title: NetApp Console common workflows and tasks - url: /platform/get_identifiers.html - - title: Storage services - links: - - title: ONTAP management - Cloud Volumes ONTAP - url: /cm/overview.html#cloud-volumes-ontap-operations - - title: ONTAP management - On-premises ONTAP - url: /cm/overview.html#cloud-volumes-ontap-operations - - title: Amazon FSx for NetApp ONTAP management - url: /fsx/overview.html - - title: ONTAP management workflows - links: - - title: Cloud Volumes ONTAP typical deployment - url: /cm/cvo_deployment.html - - title: Cloud Volumes ONTAP AWS workflows - url: /cm/wf_aws_cloud_create_we_capacity.html - - title: Cloud Volumes ONTAP Azure workflows - url: /cm/wf_azure_cloud_create_we_capacity.html - - title: Cloud Volumes ONTAP Google Cloud workflows - url: /cm/wf_gcp_cloud_create_we_capacity.html - - title: On-premises ONTAP workflows - url: /cm/wf_onprem_before.html - - title: Common workflows - url: /cm/wf_common_before.html - - title: Platform services - links: - - title: Accounts (tenancy) - url: /tenancy/overview.html - - title: Audit - url: /audit/overview.html - - title: Backup and Recovery - url: /cbs/overview.html - - title: Copy and Sync - url: /copysync/overview.html - - title: Credentials - url: /credential/overview.html - - title: Licenses and subscriptions - url: /dw/overview.html - - title: Federation - url: /federation/overview.html - - title: IPA - url: /ipa/overview.html - - title: Identity and access management - url: /tenancyv4/overview.html - - title: More resources - links: - - title: NetApp Console solutions - url: https://www.netapp.com/cloud-services/ - - title: NetApp Console automation hub - url: https://docs.netapp.com/us-en/netapp-automation/solutions/bac-overview.html - - title: ONTAP 9 documentation - url: https://docs.netapp.com/us-en/ontap/ - - title: Additional resources - url: /support/additional_resources.html - - \ No newline at end of file diff --git a/audit/audit-x-doc.json b/audit/audit-x-doc.json deleted file mode 100644 index a91bef6d..00000000 --- a/audit/audit-x-doc.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "overview": "Audit REST API for the NetApp Console", - "permalink": "overview.html", - "paths": { - "/audit/{accountId}": { - "get": { - "x-doc": { - "title": "Retrieve account records", - "category": null, - "filename": "get-audit.html", - "subcategory": null, - "explorer": false - } - } - }, - "/audit/{accountId}/{service}/{requestId}/records": { - "get": { - "x-doc": { - "title": "Retrieve records by service", - "category": null, - "filename": "get-audit--records.html", - "subcategory": null, - "explorer": false - } - } - }, - "/audit/{accountId}/options": { - "get": { - "x-doc": { - "title": "Retrieve audit options", - "category": null, - "filename": "get-audit-options.html", - "subcategory": null, - "explorer": false - } - } - - } - } - } diff --git a/audit/audit.json b/audit/audit.json deleted file mode 100644 index 3c28c084..00000000 --- a/audit/audit.json +++ /dev/null @@ -1,495 +0,0 @@ -{ - - "openapi": "3.0.0", - "info": { - "title": "Audit service API", - "description": "
Overview\n

The Audit service records information about the operations performed by the NetApp Console services. This includes the originating IP addresses, workspaces, Console agents used, and other telemetry data.\n

\n\n You can use this data to determine what actions were performed, who performed them, and when they occurred. This information can be useful in forensic situations or environments where compliance is required. The associated REST API provides several endpoints you can use to retrieve the audit data and account options. The identity of the API caller and account are established through a user access token that must be included with each call. All Audit service API calls in this document are short-lived and run synchronously.

\n

Note: Before using the API reference documentation, review the\nGet started section for the NetApp Console APIs. For more information about the security tokens and identifiers you’ll need when using the API, review the Common workflows and tasks section.\n\n

\n
\n
\nREST implementation\n

HTTP methods

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MethodDescription
GETRetrieve an object instance or collection
\n

Request headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Request HeaderDescription
AuthorizationRequired. Contains the JWT access token
\n

Query parameters

\n

A list of all the possible query parameters available for each service component is provided in the table below. This is a summary by component, however not every query parameter can be used with each endpoint in a specific component. See the detailed descriptions of the individual API calls for more details.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ComponentQuery Parameter
Auditaccount (required)
fromLastModified
toLastModified
fromStartTime
qAction
qService
qStatus
qAgent
qResource
qUser
includeUserAudits
toStartTime
offset
includeUserData
\n

Response headers

\n

This API uses the standard HTTP response headers common with all NetApp Console APIs. See REST implementation for more information.

\n

HTTP status codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP Status CodeDescription
200OK: Returned for successful operation completion
400Bad Request: Returned if the input is malformed and could not be parsed
401Unauthorized: Returned if user authentication failed or the token has expired
403Forbidden: Returned for authorization errors depending on the resource and token
\n
\n
\n
\nError handling\n

There are two processes involved with error handling and processing:

\n\n
\n
\n
\ncURL examples\n

Retrieve audit records for a specified account

\n

This example retrieves the audit records for a specified account.

\n
curl -X GET "https://cloudmanager.cloud.netapp.com/audit/<account_id>" -H  "accept: application/json" -H  "authorization: <user token>"\n
\n
\n
\n

", - "version": "1.0", - "contact": {} - }, - "tags": [ - { - "name": "audit", - "description": "
\nOverview\n
\n

The Audit endpoints enable you to perform the following operations:

\n\n
\n
\n" - } - ], - "servers": [ - { - "url": "/" - } - ], - "components": { - "securitySchemes": { - "bearer": { - "scheme": "bearer", - "bearerFormat": "JWT", - "type": "http" - } - }, - "schemas": { - "AuditOptionItem": { - "type": "object", - "properties": { - "column": { - "type": "string", - "description": "Column name for the audit option", - "example": "service" - }, - "identifier": { - "type": "string", - "description": "Unique identifier for the audit option", - "example": "license-service" - }, - "label": { - "type": "string", - "description": "Display label for the audit option", - "example": "License Service" - } - } - }, - "GetAuditGroupResDto": { - "type": "object", - "properties": { - "accountId": { - "type": "string", - "readOnly": true - }, - "startTime": { - "type": "number", - "readOnly": true, - "description": "The start time of the event. Unix epoch in milliseconds", - "example": 1676559600 - }, - "endTime": { - "type": "number", - "readOnly": true, - "description": "The start time of the event. Unix epoch in milliseconds", - "example": 1676669600 - }, - "action": { - "type": "string", - "readOnly": true, - "description": "Action name of the event.", - "example": "Create Replication Vsa" - }, - "status": { - "enum": [ - "success", - "failed", - "pending", - "aborted" - ], - "type": "string", - "readOnly": true, - "description": "Status of the operation.", - "example": "success" - }, - "requestId": { - "type": "string", - "readOnly": true, - "description": "RequestId of the operation. globally unique for the service.", - "example": "c53qRZlA" - }, - "service": { - "type": "string", - "readOnly": true, - "description": "Service in which the operation was performed.", - "example": "fsx" - }, - "principalId": { - "type": "string", - "readOnly": true, - "description": "Id of the entity performing the operation.", - "example": "auth0|5cd02b613c58e90888cd5741" - }, - "userEmail": { - "type": "string", - "readOnly": true, - "description": "Email-id of the entity performing the operation.", - "example": "abcd@efgh.com" - }, - "agentName": { - "type": "string", - "readOnly": true, - "description": "Name of the agent which performed the operation.", - "example": "agent-1" - }, - "agentId": { - "type": "string", - "readOnly": true, - "description": "Id of the agent which performed the operation.", - "example": "123-456-769" - }, - "resourceName": { - "type": "string", - "readOnly": true, - "description": "Name of the resource acted upon by the operation.", - "example": "CVO" - }, - "resourceId": { - "type": "string", - "readOnly": true, - "description": "Id of the resource acted upon by the operation.", - "example": "resource-123" - }, - "errors": { - "readOnly": true, - "description": "Array of error message/s if exists. that related to this auditGroup", - "example": "[error1,error2]", - "type": "array", - "items": { - "type": "string" - } - }, - "requestData": { - "type": "string", - "readOnly": true, - "description": "Parameters related to request of operation. a string, can be JSON string", - "example": "\"{\"replicationRequest\":{\"policyName\":\"MirrorAllSnapshots\",\"destinationWorkingEnvironmentId\":\"VsaWorkingEnvironment-LspTA9zs\",\"sourceWorkingEnvironmentId\":\"VsaWorkingEnvironment-bMyCULIC\",\"destinationInterclusterLifIps\":[\"10.0.0.35\"],\"sourceInterclusterLifIps\":[\"1.1.1.1\"],\"maxTransferRate\":null,\"scheduleName\":\"weekly\"},\"replicationVolume\":{\"destinationProviderVolumeType\":\"Standard_LRS\",\"destinationVolumeName\":\"vol2_1000g_case3_copy\",\"sourceVolumeName\":\"vol2_1000g\",\"advancedMode\":false,\"numOfDisksApprovedToAdd\":1,\"destinationCapacityTier\":null,\"destinationAggregateName\":\"aggr2\",\"sourceSvmName\":\"svm_srcVsa1\"}}\"" - }, - "responseData": { - "type": "string", - "readOnly": true, - "description": "Response of the operation. Must be a string, can be JSON in a string.", - "example": "\"{\"response\":{\"policyName\":\"MirrorAllSnapshots\",\"destinationWorkingEnvironmentId\":\"VsaWorkingEnvironment-LspTA9zs\",\"sourceWorkingEnvironmentId\":\"VsaWorkingEnvironment-bMyCULIC\",\"destinationInterclusterLifIps\":[\"10.0.0.35\"],\"sourceInterclusterLifIps\":[\"1.1.1.1\"],\"maxTransferRate\":null,\"scheduleName\":\"weekly\"},\"replicationVolume\":{\"destinationProviderVolumeType\":\"Standard_LRS\",\"destinationVolumeName\":\"vol2_1000g_case3_copy\",\"sourceVolumeName\":\"vol2_1000g\",\"advancedMode\":false,\"numOfDisksApprovedToAdd\":1,\"destinationCapacityTier\":null,\"destinationAggregateName\":\"aggr2\",\"sourceSvmName\":\"svm_srcVsa1\"}}\"" - }, - "workspaceId": { - "type": "string", - "readOnly": true, - "description": "Id of the workspace in which the resource is contained.", - "example": "workspace-3778fs72" - }, - "hasRecords": { - "type": "boolean", - "readOnly": true, - "example": true - }, - "hasFailedRecord": { - "type": "boolean", - "readOnly": true, - "example": false - }, - "lastModified": { - "type": "number", - "readOnly": true, - "description": "Last modified time. Unix epoch in milliseconds", - "example": 1684050775135 - } - }, - "required": [ - "accountId", - "startTime", - "endTime", - "action", - "status", - "requestId", - "service", - "principalId", - "hasRecords", - "hasFailedRecord", - "lastModified" - ] - }, - "GetAuditRecordResDto": { - "type": "object", - "properties": { - "creationTime": { - "type": "number", - "description": "Creation time of the record. Unix epoch in milliseconds.", - "example": 1676559600, - "readOnly": true - }, - "action": { - "type": "string", - "description": "Action name of the event.", - "example": "Create Replication Vsa", - "readOnly": true - }, - "status": { - "enum": [ - "success", - "failed", - "pending", - "aborted" - ], - "type": "string", - "description": "Status of the operation.", - "example": "success", - "readOnly": true - }, - "data": { - "type": "string", - "description": "Any optional data of the record. String value can be stringified JSON.", - "example": "\"{\"replicationRequest\":{\"policyName\":\"MirrorAllSnapshots\",\"destinationWorkingEnvironmentId\":\"VsaWorkingEnvironment-LspTA9zs\",\"sourceWorkingEnvironmentId\":\"VsaWorkingEnvironment-bMyCULIC\",\"destinationInterclusterLifIps\":[\"10.0.0.35\"],\"sourceInterclusterLifIps\":[\"1.1.1.1\"],\"maxTransferRate\":null,\"scheduleName\":\"weekly\"},\"replicationVolume\":{\"destinationProviderVolumeType\":\"Standard_LRS\",\"destinationVolumeName\":\"vol2_1000g_case3_copy\",\"sourceVolumeName\":\"vol2_1000g\",\"advancedMode\":false,\"numOfDisksApprovedToAdd\":1,\"destinationCapacityTier\":null,\"destinationAggregateName\":\"aggr2\",\"sourceSvmName\":\"svm_srcVsa1\"}}\"", - "readOnly": true - }, - "errors": { - "description": "Array of error message/s if exists. that related to this auditRecord", - "example": "[error1,error2]", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "recordId": { - "type": "number", - "description": "Record id - is unique per requestId per service.", - "example": 234543, - "readOnly": true - } - }, - "required": [ - "creationTime", - "status", - "recordId" - ] - } - } - }, - "paths": { - "/audit/{accountId}": { - "get": { - "operationId": "AuditController_audit", - "summary": "", - "description": "Retrieves account records by a specified account public ID.\n
\n

Token usage: NetApp Console user token.

", - "parameters": [ - { - "name": "accountId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "fromLastModified", - "required": false, - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "toLastModified", - "required": false, - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "fromStartTime", - "required": false, - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "qAction", - "required": false, - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "qService", - "required": false, - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "qStatus", - "required": false, - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "qAgent", - "required": false, - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "qResource", - "required": false, - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "qUser", - "required": false, - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "includeUserAudits", - "required": false, - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "toStartTime", - "required": false, - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "offset", - "required": false, - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "includeUserData", - "required": false, - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetAuditGroupResDto" - } - } - } - } - } - }, - "tags": [ - "audit" - ], - "security": [ - { - "bearer": [] - } - ] - } - }, - "/audit/{accountId}/{service}/{requestId}/records": { - "get": { - "operationId": "AuditController_auditRecords", - "summary": "", - "description": "Retrieves specified records by account, service, and request ID.\n
\n

Token usage: NetApp Console user token.

", - "parameters": [ - { - "name": "accountId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "service", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "requestId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetAuditRecordResDto" - } - } - } - } - } - }, - "tags": [ - "audit" - ], - "security": [ - { - "bearer": [] - } - ] - } - }, - "/audit/{accountId}/options": { - "get": { - "operationId": "AuditController_auditOptions", - "summary": "", - "description": "Retrieves filter options by a specified account ID.\n
\n

Token usage: NetApp Console user token.

", - "parameters": [ - { - "name": "accountId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AuditOptionItem" - } - } - } - } - } - } - }, - "tags": [ - "audit" - ], - "security": [ - { - "bearer": [] - } - ] - } - } - } - } diff --git a/audit/get-audit--records.adoc b/audit/get-audit--records.adoc new file mode 100644 index 00000000..e68ed557 --- /dev/null +++ b/audit/get-audit--records.adoc @@ -0,0 +1,116 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'audit/get-audit--records.html' +summary: 'Retrieve records by service' +--- + += Retrieve records by service + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/audit/{accountId}/{service}/{requestId}/records`# + + + +Retrieves specified records by account, service, and request ID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|service +|string +|path +|True +a| + +|requestId +|string +|path +|True +a| + +|=== + +== Response + +``` +Status: 200, +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|creationTime +|number +|True +a|Creation time of the record. Unix epoch in milliseconds. + + +|action +|string +|False +a|Action name of the event. + + +|status +|string +|True +a|Status of the operation. + + +|data +|string +|False +a|Any optional data of the record. String value can be stringified JSON. + + +|errors +|array[string] +|False +a|Array of error message/s if exists. that related to this auditRecord + + +|recordId +|number +|True +a|Record id - is unique per requestId per service. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "creationTime": 1676559600, + "action": "Create Replication Vsa", + "status": "success", + "data": "\"{\"replicationRequest\":{\"policyName\":\"MirrorAllSnapshots\",\"destinationWorkingEnvironmentId\":\"VsaWorkingEnvironment-LspTA9zs\",\"sourceWorkingEnvironmentId\":\"VsaWorkingEnvironment-bMyCULIC\",\"destinationInterclusterLifIps\":[\"10.0.0.35\"],\"sourceInterclusterLifIps\":[\"1.1.1.1\"],\"maxTransferRate\":null,\"scheduleName\":\"weekly\"},\"replicationVolume\":{\"destinationProviderVolumeType\":\"Standard_LRS\",\"destinationVolumeName\":\"vol2_1000g_case3_copy\",\"sourceVolumeName\":\"vol2_1000g\",\"advancedMode\":false,\"numOfDisksApprovedToAdd\":1,\"destinationCapacityTier\":null,\"destinationAggregateName\":\"aggr2\",\"sourceSvmName\":\"svm_srcVsa1\"}}\"", + "errors": "[error1,error2]", + "recordId": 234543 +} +==== + diff --git a/audit/get-audit-options.adoc b/audit/get-audit-options.adoc new file mode 100644 index 00000000..ba74b24e --- /dev/null +++ b/audit/get-audit-options.adoc @@ -0,0 +1,86 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'audit/get-audit-options.html' +summary: 'Retrieve audit options' +--- + += Retrieve audit options + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/audit/{accountId}/options`# + + + +Retrieves filter options by a specified account ID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|=== + +== Response + +``` +Status: 200, +``` + +Hash mapping strings to array[link:#AuditOptionItem[AuditOptionItem]] + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AuditOptionItem] +[.api-collapsible-fifth-title] +AuditOptionItem + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|column +|string +|False +a|Column name for the audit option + + +|identifier +|string +|False +a|Unique identifier for the audit option + + +|label +|string +|False +a|Display label for the audit option + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/audit/get-audit.adoc b/audit/get-audit.adoc new file mode 100644 index 00000000..6fad91d9 --- /dev/null +++ b/audit/get-audit.adoc @@ -0,0 +1,277 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'audit/get-audit.html' +summary: 'Retrieve account records' +--- + += Retrieve account records + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/audit/{accountId}`# + + + +Retrieves account records by a specified account public ID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|fromLastModified +|number +|query +|False +a| + +|toLastModified +|number +|query +|False +a| + +|fromStartTime +|number +|query +|False +a| + +|qAction +|string +|query +|False +a| + +|qService +|string +|query +|False +a| + +|qStatus +|string +|query +|False +a| + +|qAgent +|string +|query +|False +a| + +|qResource +|string +|query +|False +a| + +|qUser +|string +|query +|False +a| + +|includeUserAudits +|boolean +|query +|False +a| + +|toStartTime +|number +|query +|False +a| + +|offset +|number +|query +|False +a| + +|includeUserData +|boolean +|query +|False +a| + +|=== + +== Response + +``` +Status: 200, +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|True +a| + +|startTime +|number +|True +a|The start time of the event. Unix epoch in milliseconds + + +|endTime +|number +|True +a|The start time of the event. Unix epoch in milliseconds + + +|action +|string +|True +a|Action name of the event. + + +|status +|string +|True +a|Status of the operation. + + +|requestId +|string +|True +a|RequestId of the operation. globally unique for the service. + + +|service +|string +|True +a|Service in which the operation was performed. + + +|principalId +|string +|True +a|Id of the entity performing the operation. + + +|userEmail +|string +|False +a|Email-id of the entity performing the operation. + + +|agentName +|string +|False +a|Name of the agent which performed the operation. + + +|agentId +|string +|False +a|Id of the agent which performed the operation. + + +|resourceName +|string +|False +a|Name of the resource acted upon by the operation. + + +|resourceId +|string +|False +a|Id of the resource acted upon by the operation. + + +|errors +|array[string] +|False +a|Array of error message/s if exists. that related to this auditGroup + + +|requestData +|string +|False +a|Parameters related to request of operation. a string, can be JSON string + + +|responseData +|string +|False +a|Response of the operation. Must be a string, can be JSON in a string. + + +|workspaceId +|string +|False +a|Id of the workspace in which the resource is contained. + + +|hasRecords +|boolean +|True +a| + +|hasFailedRecord +|boolean +|True +a| + +|lastModified +|number +|True +a|Last modified time. Unix epoch in milliseconds + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountId": "string", + "startTime": 1676559600, + "endTime": 1676669600, + "action": "Create Replication Vsa", + "status": "success", + "requestId": "c53qRZlA", + "service": "fsx", + "principalId": "auth0|5cd02b613c58e90888cd5741", + "userEmail": "abcd@efgh.com", + "agentName": "agent-1", + "agentId": "123-456-769", + "resourceName": "CVO", + "resourceId": "resource-123", + "errors": "[error1,error2]", + "requestData": "\"{\"replicationRequest\":{\"policyName\":\"MirrorAllSnapshots\",\"destinationWorkingEnvironmentId\":\"VsaWorkingEnvironment-LspTA9zs\",\"sourceWorkingEnvironmentId\":\"VsaWorkingEnvironment-bMyCULIC\",\"destinationInterclusterLifIps\":[\"10.0.0.35\"],\"sourceInterclusterLifIps\":[\"1.1.1.1\"],\"maxTransferRate\":null,\"scheduleName\":\"weekly\"},\"replicationVolume\":{\"destinationProviderVolumeType\":\"Standard_LRS\",\"destinationVolumeName\":\"vol2_1000g_case3_copy\",\"sourceVolumeName\":\"vol2_1000g\",\"advancedMode\":false,\"numOfDisksApprovedToAdd\":1,\"destinationCapacityTier\":null,\"destinationAggregateName\":\"aggr2\",\"sourceSvmName\":\"svm_srcVsa1\"}}\"", + "responseData": "\"{\"response\":{\"policyName\":\"MirrorAllSnapshots\",\"destinationWorkingEnvironmentId\":\"VsaWorkingEnvironment-LspTA9zs\",\"sourceWorkingEnvironmentId\":\"VsaWorkingEnvironment-bMyCULIC\",\"destinationInterclusterLifIps\":[\"10.0.0.35\"],\"sourceInterclusterLifIps\":[\"1.1.1.1\"],\"maxTransferRate\":null,\"scheduleName\":\"weekly\"},\"replicationVolume\":{\"destinationProviderVolumeType\":\"Standard_LRS\",\"destinationVolumeName\":\"vol2_1000g_case3_copy\",\"sourceVolumeName\":\"vol2_1000g\",\"advancedMode\":false,\"numOfDisksApprovedToAdd\":1,\"destinationCapacityTier\":null,\"destinationAggregateName\":\"aggr2\",\"sourceSvmName\":\"svm_srcVsa1\"}}\"", + "workspaceId": "workspace-3778fs72", + "hasRecords": true, + "hasFailedRecord": false, + "lastModified": 1684050775135 +} +==== + diff --git a/audit/overview.adoc b/audit/overview.adoc new file mode 100644 index 00000000..e4552f51 --- /dev/null +++ b/audit/overview.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'audit/overview.html' +summary: 'Audit REST API for the NetApp Console' +--- + += Audit REST API for the NetApp Console + + + +The Audit service records information about the operations performed by the NetApp Console services. This includes the originating IP addresses, workspaces, Console agents used, and other telemetry data. + +You can use this data to determine what actions were performed, who performed them, and when they occurred. This information can be useful in forensic situations or environments where compliance is required. The associated REST API provides several endpoints you can use to retrieve the audit data and account options. The identity of the API caller and account are established through a user access token that must be included with each call. All Audit service API calls in this document are short-lived and run synchronously. + +NOTE: Before using the API reference documentation, review the https://docs.netapp.com/us-en/cloud-manager-automation/platform/overview.html[Get started] section for the NetApp Console APIs. For more information about the security tokens and identifiers you'll need when using the API, review the https://docs.netapp.com/us-en/cloud-manager-automation/platform/get_identifiers.html[Common workflows and tasks] section. + +''' + +== REST implementation + +=== HTTP methods + +|=== +| Method | Description + +| `GET` +| Retrieve an object instance or collection +|=== + +=== Request headers + +|=== +| Request Header | Description + +| `Authorization` +| Required. Contains the JWT access token +|=== + +=== Query parameters + +A list of all the possible query parameters available for each service component is provided in the table below. This is a summary by component, however not every query parameter can be used with each endpoint in a specific component. See the detailed descriptions of the individual API calls for more details. + +|=== +| Component | Query Parameter + +| Audit +| account (required) + +fromLastModified + +toLastModified + +fromStartTime + +qAction + +qService + +qStatus + +qAgent + +qResource + +qUser + +includeUserAudits + +toStartTime + +offset + +includeUserData +|=== + +=== Response headers + +This API uses the standard HTTP response headers common with all NetApp Console APIs. See https://docs.netapp.com/us-en/cloud-manager-automation/platform/http_details.html[REST implementation] for more information. + +=== HTTP status codes + +|=== +| HTTP Status Code | Description + +| `200` +| OK: Returned for successful operation completion + +| `400` +| Bad Request: Returned if the input is malformed and could not be parsed + +| `401` +| Unauthorized: Returned if user authentication failed or the token has expired + +| `403` +| Forbidden: Returned for authorization errors depending on the resource and token +|=== + +''' + +== Error handling + +There are two processes involved with error handling and processing: + +* The error is logged for supportability +* The error is also returned to the caller for any specific handling + +''' + +== cURL examples + +=== Retrieve audit records for a specified account + +This example retrieves the audit records for a specified account. + +.... + + curl -X GET "https://cloudmanager.cloud.netapp.com/audit/" -H "accept: application/json" -H "authorization: " +.... + +''' + +{blank} + + + + + diff --git a/audit/sidebar.yml b/audit/sidebar.yml deleted file mode 100644 index 1aa0c9ee..00000000 --- a/audit/sidebar.yml +++ /dev/null @@ -1,3 +0,0 @@ -section: audit -title: Audit -generate: audit \ No newline at end of file diff --git a/cbs/backup_overview.adoc b/cbs/backup_overview.adoc new file mode 100644 index 00000000..85d40e53 --- /dev/null +++ b/cbs/backup_overview.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/backup_overview.html' +summary: 'Backup endpoints in the NetApp Backup and Recovery REST API' +--- + += Backup endpoints in the NetApp Backup and Recovery REST API + + + +The backup endpoints manage backup operations of cloud and on-premises resources and retrieve details of the backup data when required. You can perform the following operations by using the Backup endpoints: + +* Retrieve details of the backup data of a system, volumes, and snapshots. + + +* Enable cloud backup on a system, back up volumes, and create on-demand backups. + + +* Modify the backup configuration of systems and volumes. + + +* Disable backups for systems and volumes, and delete backups. + + diff --git a/cbs/catalog_overview.adoc b/cbs/catalog_overview.adoc new file mode 100644 index 00000000..469b9be6 --- /dev/null +++ b/cbs/catalog_overview.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/catalog_overview.html' +summary: 'Catalog endpoints in the NetApp Backup and Recovery REST API' +--- + += Catalog endpoints in the NetApp Backup and Recovery REST API + + + +The catalog endpoints manage the indexed catalog search for files based on a query. You can perform the following operations by using the Catalog endpoints: + +* Initiate an indexed catalog search based on a query + + +* Retrieve a list of snapshots related to a particular volume by using the Catalog Index query + + +* Configure an indexed catalog service on AWS, Azure, Google Cloud and on-premises or dark sites. + + +* Modify the state of an indexed catalog service. + + diff --git a/cbs/cbs-x-doc.yml b/cbs/cbs-x-doc.yml deleted file mode 100644 index b8a6fca7..00000000 --- a/cbs/cbs-x-doc.yml +++ /dev/null @@ -1,1376 +0,0 @@ ---- -overview: NetApp Backup and Recovery REST API -permalink: overview.html -paths: - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/volume/{volumeId}/file-explore/start": - post: - x-doc: - title: Start a file explore operation - category: SFR - filename: post-account-providers-cloudmanager_cbs-api-v1-sfr-volume-file-explore-start.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/volume/{volumeId}/file-explore/status": - get: - x-doc: - title: Retrieve file explore status (v1) - category: SFR - filename: get-account-providers-cloudmanager_cbs-api-v1-sfr-volume-file-explore-status.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/sfr/volume/{volumeId}/file-explore/status": - get: - x-doc: - title: Retrieve file explore status (v2) - category: SFR - filename: get-account-providers-cloudmanager_cbs-api-v2-sfr-volume-file-explore-status.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/volume/{volumeId}/snapshot/{snapshotId}/file-explore/list": - get: - x-doc: - title: Retrieve files (v1) - category: SFR - filename: get-account-providers-cloudmanager_cbs-api-v1-sfr-volume-snapshot-file-explore-list.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/sfr/volume/{volumeId}/snapshot/{snapshotId}/file-explore/list": - get: - x-doc: - title: Retrieve files (v2) - category: SFR - filename: get-account-providers-cloudmanager_cbs-api-v2-sfr-volume-snapshot-file-explore-list.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/volume/{volumeId}/backup/export": - post: - x-doc: - title: Export a filesystem - category: SFR - filename: post-account-providers-cloudmanager_cbs-api-v1-sfr-volume-backup-export.html - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/backup/export": - delete: - x-doc: - title: Unexport a filesystem - category: SFR - filename: delete-account-providers-cloudmanager_cbs-api-v1-sfr-backup-export.html - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment": - get: - x-doc: - title: Retrieve system details - category: Backup - filename: get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}": - get: - x-doc: - title: Retrieve specific system details - category: Backup - filename: get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.html - explorer: false - subcategory: - explorer: false - post: - x-doc: - title: Enable the Backup and Recovery service - category: Backup - filename: post-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.html - explorer: false - subcategory: - explorer: false - put: - x-doc: - title: Modify the Backup and Recovery service - category: Backup - filename: put-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.html - explorer: false - subcategory: - explorer: false - delete: - x-doc: - title: Unregister a system - category: Backup - filename: delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/status": - get: - x-doc: - title: Retrieve the backup status - category: Backup - filename: get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-status.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment/{workingEnvironmentId}": - post: - x-doc: - title: Enable Backup and Recovery (v2) - category: Backup - filename: post-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-.html - explorer: false - subcategory: - explorer: false - put: - x-doc: - title: Modify the Backup and Recovery service backup configuration - category: Backup - filename: put-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v3/backup/working-environment/{workingEnvironmentId}": - post: - x-doc: - title: Enable Backup and Recovery (v3) - category: Backup - filename: post-account-providers-cloudmanager_cbs-api-v3-backup-working-environment-.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}": - post: - x-doc: - title: Enable backup for a volume - category: Backup - filename: post-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.html - explorer: false - subcategory: - explorer: false - get: - x-doc: - title: Retrieve volume information - category: Backup - filename: get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.html - explorer: false - subcategory: - explorer: false - put: - x-doc: - title: Modify a backed up volume - category: Backup - filename: put-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.html - explorer: false - subcategory: - explorer: false - delete: - x-doc: - title: Remove backup settings - category: Backup - filename: delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}": - post: - x-doc: - title: Enable backup for a volume (v2) - category: Backup - filename: post-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-volume-.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v3/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}": - post: - x-doc: - title: Enable backup for a volume (v3) - category: Backup - filename: post-account-providers-cloudmanager_cbs-api-v3-backup-working-environment-volume-.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume": - get: - x-doc: - title: Retrieve volume details - category: Backup - filename: get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume.html - explorer: false - subcategory: - explorer: false - post: - x-doc: - title: Enable backup of multiple volumes - category: Backup - filename: post-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume.html - explorer: false - subcategory: - explorer: false - put: - x-doc: - title: Modify multiple backed up volumes - category: Backup - filename: put-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment/{workingEnvironmentId}/volume": - post: - x-doc: - title: Enable backup for multiple volumes (v2) - category: Backup - filename: post-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-volume.html - explorer: false - subcategory: - explorer: false - ? "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}" - : get: - x-doc: - title: Retrieve specific snapshot information for a volume - category: Backup - filename: get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot-.html - explorer: false - subcategory: - explorer: false - delete: - x-doc: - title: Delete a snapshot - category: Backup - filename: delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot-.html - explorer: false - subcategory: - explorer: false - ? "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot" - : get: - x-doc: - title: Retrieve snapshot information for a volume - category: Backup - filename: get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot.html - explorer: false - subcategory: - explorer: false - delete: - x-doc: - title: Delete all snapshots (volume) - category: Backup - filename: delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment/{workingEnvironmentId}/snapshot": - delete: - x-doc: - title: Delete all snapshots (system) - category: Backup - filename: delete-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-snapshot.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/restore": - post: - x-doc: - title: Perform a volume and file-level restore - category: Restore - filename: post-account-providers-cloudmanager_cbs-api-v1-restore.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/restore": - post: - x-doc: - title: Perform a volume and file-level restore (v2) - category: Restore - filename: post-account-providers-cloudmanager_cbs-api-v2-restore.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/restore/status": - get: - x-doc: - title: Retrieve volume-level restore status - category: Restore - filename: get-account-providers-cloudmanager_cbs-api-v1-restore-status.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy": - get: - x-doc: - title: Retrieve ONTAP backup policies - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy.html - explorer: false - subcategory: - explorer: false - post: - x-doc: - title: Create a backup policy - category: System - filename: post-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy/{policyName}": - put: - x-doc: - title: Update a backup policy - category: System - filename: put-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy-.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/ip-space": - get: - x-doc: - title: Retrieve IP spaces - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-ip-space.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment": - get: - x-doc: - title: Retrieve systems - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}": - get: - x-doc: - title: Retrieve system details - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/svm": - get: - x-doc: - title: Retrieve storage VMs - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-svm.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume": - get: - x-doc: - title: Retrieve volumes - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/configure-object-store": - post: - x-doc: - title: Configure object storage - category: System - filename: post-account-providers-cloudmanager_cbs-api-v1-working-environment-configure-object-store.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/configure-object-store": - post: - x-doc: - title: Configure object storage (v2) - category: System - filename: post-account-providers-cloudmanager_cbs-api-v2-working-environment-configure-object-store.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/list": - get: - x-doc: - title: Retrieve system volume directories - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-list.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/object-store-config/status": - get: - x-doc: - title: Retrieve an object store configuration status - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-object-store-config-status.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/account": - get: - x-doc: - title: Retrieve AWS accounts - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-aws-account.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/region": - get: - x-doc: - title: Retrieve subscribed AWS regions - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-aws-region.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/region/{regionCode}/key": - get: - x-doc: - title: Retrieve AWS keys - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-region-key.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/region/{regionCode}/privateLink": - get: - x-doc: - title: Retrieve AWS private links - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-region-privatelink.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/archival-storage-class": - get: - x-doc: - title: Retrieve AWS storage classes - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-aws-archival-storage-class.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/region": - get: - x-doc: - title: Retrieve regions - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-region.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resource-group": - post: - x-doc: - title: Create an Azure resource group - category: Cloud - filename: post-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resource-group.html - explorer: false - subcategory: - explorer: false - get: - x-doc: - title: Retrieve Azure resource groups - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resource-group.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vnet": - get: - x-doc: - title: Retrieve Azure virtual networks - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vnet.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription": - get: - x-doc: - title: Retrieve Azure subscriptions - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-azure-subscription.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vault/{vaultName}/key": - get: - x-doc: - title: Retrieve Azure vault keys - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vault-key.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vault": - get: - x-doc: - title: Retrieve Azure vaults - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vault.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project": - get: - x-doc: - title: Retrieve Google Cloud projects - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-gcp-project.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region": - get: - x-doc: - title: Retrieve Google Cloud regions - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/job": - get: - x-doc: - title: Retrieve jobs - category: Job - filename: get-account-providers-cloudmanager_cbs-api-v1-job.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/job/{jobId}": - get: - x-doc: - title: Retrieve particular job details - category: Job - filename: get-account-providers-cloudmanager_cbs-api-v1-job-.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/working-environments/{workingEnvironmentId}/setup": - post: - x-doc: - title: Configure a service - category: Catalog - filename: post-account-providers-cloudmanager_cbs-api-v1-catalog-working-environments-setup.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/search": - post: - x-doc: - title: Search a specific file - category: Catalog - filename: post-account-providers-cloudmanager_cbs-api-v1-catalog-search.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/snapshots": - post: - x-doc: - title: Retrieve snapshots - category: Catalog - filename: post-account-providers-cloudmanager_cbs-api-v1-catalog-snapshots.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/working-environments/{workingEnvironmentId}": - put: - x-doc: - title: Enable or disable the service - category: Catalog - filename: put-account-providers-cloudmanager_cbs-api-v1-catalog-working-environments-.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/license/working-environment/{workingEnvironmentId}": - get: - x-doc: - title: Retrieve license validity - category: License - filename: get-account-providers-cloudmanager_cbs-api-v1-license-working-environment-.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/backup-policy": - put: - x-doc: - title: Update a backup policy (v2) - category: System - filename: put-account-providers-cloudmanager_cbs-api-v2-working-environment-backup-policy.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/catalog/working-environments/{workingEnvironmentId}/setup": - post: - x-doc: - title: Configure a service - category: Catalog - filename: post-account-providers-cloudmanager_cbs-api-v2-catalog-working-environments-setup.html - explorer: false - subcategory: - explorer: false - "/api/account/{accountId}/v1/jobs": - get: - x-doc: - title: Retrieve job list - category: Jobs - filename: get-api-account-v1-jobs.html - explorer: false - post: - x-doc: - title: Register a job - category: Jobs - filename: post-api-account-v1-jobs.html - explorer: false - "/api/account/{accountId}/v1/jobs/{jobId}": - get: - x-doc: - title: Retrieve job details - category: Jobs - filename: get-api-account-v1-jobs-.html - explorer: false - patch: - x-doc: - title: Update a job - category: Jobs - filename: patch-api-account-v1-jobs-.html - explorer: false - delete: - x-doc: - title: Delete a job - category: Jobs - filename: delete-api-account-v1-jobs-.html - explorer: false - ? "/account/{accountId}/providers/cloudmanager_cbs/api/v1/ransomware/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}" - : post: - x-doc: - title: Initiate a ransomware scan - category: Ransomware Scan - filename: post-account-providers-cloudmanager_cbs-api-v1-ransomware-working-environment-volume-snapshot-.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/sfr/volume/{volumeId}/file-explore/start": - post: - x-doc: - title: Start a file and folder explore operation - category: SFR - filename: post-account-providers-cloudmanager_cbs-api-v2-sfr-volume-file-explore-start.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v3/restore": - post: - x-doc: - title: Perform a volume, file, and folder-level restore operation (v3) - category: Restore - filename: post-account-providers-cloudmanager_cbs-api-v3-restore.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/svm": - get: - x-doc: - title: Retrieve a list of storage VMs - category: System - filename: get-account-providers-cloudmanager_cbs-api-v2-working-environment-svm.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region/{locationId}/keyrings": - get: - x-doc: - title: Retrieve a list of KeyRings for a region - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region-keyrings.html - explorer: false - subcategory: - explorer: false - ? "/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region/{locationId}/keyrings/{keyRingId}/cryptokey" - : get: - x-doc: - title: Retrieve a list of CryptoKeys - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region-keyrings-cryptokey.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/version": - post: - x-doc: - title: Retrieve StorageGRID server version - category: StorageGRID - filename: post-account-providers-cloudmanager_cbs-api-v1-sg-version.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg": - get: - x-doc: - title: Retrieve StorageGRID WebScale servers - category: StorageGRID - filename: get-account-providers-cloudmanager_cbs-api-v1-sg.html - explorer: false - subcategory: - explorer: false - post: - x-doc: - title: Discover a new StorageGRID WebScale server - category: StorageGRID - filename: post-account-providers-cloudmanager_cbs-api-v1-sg.html - explorer: false - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/credentials/working-environment/{workingEnvironmentId}": - post: - x-doc: - title: Save StorageGRID credentials - category: StorageGRID - filename: post-account-providers-cloudmanager_cbs-api-v1-sg-credentials-working-environment-.html - explorer: false - subcategory: - explorer: false - ? "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/file-explore/start" - : post: - x-doc: - title: Start a file and folder explore operation (v1) - category: SFR - filename: post-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-file-explore-start.html - explorer: false - subcategory: - explorer: false - ? "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}/file-explore/list" - : get: - x-doc: - title: Retrieve a list of files and folders - category: SFR - filename: get-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-snapshot-file-explore-list.html - explorer: false - subcategory: - explorer: false - ? "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}/files/status" - : get: - x-doc: - title: Retrieve the file and folder status - category: SFR - filename: get-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-snapshot-files-status.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment": - get: - x-doc: - title: Retrieve the details of all the systems that are backed up - category: Backup - filename: get-account-providers-cloudmanager_cbs-api-v2-backup-working-environment.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/volume/{volumeId}/snapshot": - get: - x-doc: - title: Retrieve a list of snapshots using the volume ID - category: Backup - filename: get-account-providers-cloudmanager_cbs-api-v1-backup-volume-snapshot.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/snapshot": - get: - x-doc: - title: Retrieve a list of snapshots using the account ID - category: Backup - filename: get-account-providers-cloudmanager_cbs-api-v1-backup-snapshot.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}": - post: - x-doc: - title: Activate comprehensive protection in a system (v1) - category: Panoramic Protection - filename: post-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-.html - subcategory: - explorer: false - put: - x-doc: - title: Modify the comprehensive protection configuration in a system (v1) - category: Panoramic Protection - filename: put-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/panoramic-protection/working-environment/{workingEnvironmentId}": - post: - x-doc: - title: Activate comprehensive protection in a system (v2) - category: Panoramic Protection - filename: post-account-providers-cloudmanager_cbs-api-v2-panoramic-protection-working-environment-.html - subcategory: - explorer: false - put: - x-doc: - title: Modify the comprehensive protection configuration in a system (v2) - category: Panoramic Protection - filename: put-account-providers-cloudmanager_cbs-api-v2-panoramic-protection-working-environment-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}/volume": - post: - x-doc: - title: Enable comprehensive panoramic protection for multiple volumes (v1) - category: Panoramic Protection - filename: post-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-volume.html - subcategory: - explorer: false - put: - x-doc: - title: Modify comprehensive protection for multiple volumes (v1) - category: Panoramic Protection - filename: put-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-volume.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/snapshot": - get: - x-doc: - title: Retrieve snapshot information for a volume - category: Backup - filename: get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-snapshot.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/replication/working-environment/{workingEnvironmentId}/relationship": - patch: - x-doc: - title: Perform an action on a volume with SnapMirror replication - category: Replication - filename: patch-account-providers-cloudmanager_cbs-api-v1-replication-working-environment-relationship.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/revert/working-environment/{workingEnvironmentId}/volume/{volumeId}": - post: - x-doc: - title: Revert a snapshot for a volume - category: Restore - filename: post-account-providers-cloudmanager_cbs-api-v1-revert-working-environment-volume-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy/{policyId}": - delete: - x-doc: - title: Delete a backup policy - category: System - filename: delete-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/byPage/volume": - get: - x-doc: - title: Retrieve a list of volumes from a system - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-bypage-volume.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policies": - get: - x-doc: - title: List the snapshot policies associated with a system - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policies.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policies/{policyId}": - delete: - x-doc: - title: Delete a snapshot policy using the UUID - category: System - filename: delete-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policies-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy": - get: - x-doc: - title: Retrieve a list of ONTAP replication policies - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy.html - subcategory: - explorer: false - post: - x-doc: - title: Create a replication policy in a system - category: System - filename: post-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy/{policyId}": - delete: - x-doc: - title: Delete a replication policy - category: System - filename: delete-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy-.html - subcategory: - explorer: false - patch: - x-doc: - title: Modify a replication policy in a system - category: System - filename: patch-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/relationship": - get: - x-doc: - title: Retrieve a list of ONTAP relationships associated with a system - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-relationship.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/peercluster": - get: - x-doc: - title: Retrieve a list of ONTAP clusters peered to a system - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-peercluster.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot": - get: - x-doc: - title: Retrieve a list of snapshot details for a volume - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot.html - subcategory: - explorer: false - post: - x-doc: - title: Create a snapshot for a volume - category: System - filename: post-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot.html - subcategory: - explorer: false - ? "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}" - : delete: - x-doc: - title: Delete a snapshot for a volume - category: System - filename: delete-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/relationship/{relationshipId}": - get: - x-doc: - title: List the relationship details associated with a volume SnapMirror - replication - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-relationship-.html - subcategory: - explorer: false - ? "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot-policy" - : put: - x-doc: - title: Modify a snapshot policy - category: System - filename: put-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot-policy.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/schedules": - get: - x-doc: - title: Retrieve a list of schedules in a system - category: System - filename: get-account-providers-cloudmanager_cbs-api-v1-working-environment-schedules.html - subcategory: - explorer: false - post: - x-doc: - title: Create a new cron schedule in a system - category: System - filename: post-account-providers-cloudmanager_cbs-api-v1-working-environment-schedules.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policy": - post: - x-doc: - title: Create a snapshot policy - category: System - filename: post-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policy.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policy/{policyId}": - patch: - x-doc: - title: Modify the snapshot policy in a system - category: System - filename: patch-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policy-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/discover/volumes": - post: - x-doc: - title: Discovers all volumes for a list of systems - category: System - filename: post-account-providers-cloudmanager_cbs-api-v1-working-environment-discover-volumes.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/discover/volumes": - post: - x-doc: - title: Discover all volumes with relationships for a list of systems - category: System - filename: post-account-providers-cloudmanager_cbs-api-v2-working-environment-discover-volumes.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/buckets": - get: - x-doc: - title: Retrieve a list of AWS S3 buckets from a region - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-buckets.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/buckets/{bucketName}": - get: - x-doc: - title: Retrieve an AWS S3 bucket from a region - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-buckets-.html - subcategory: - explorer: false - ? "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resourceGroup/{resourceGroup}/storageAccounts" - : get: - x-doc: - title: Retrieve a list of Azure storage accounts for a subscription ID - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resourcegroup-storageaccounts.html - subcategory: - explorer: false - ? "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resourceGroup/{resourceGroup}/storageAccounts/{storageAccountName}" - : get: - x-doc: - title: Retrieve a specific Azure storage account for a subscription ID - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resourcegroup-storageaccounts-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/buckets": - get: - x-doc: - title: Retrieve a list of Google Cloud buckets in a region - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-gcp-project-buckets.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/buckets/{bucketName}": - get: - x-doc: - title: Retrieve a Google Cloud bucket in a region - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v1-gcp-project-buckets-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials": - get: - x-doc: - title: List Google Cloud credentials - category: Cloud - filename: get-account-providers-cloudmanager_cbs-api-v2-gcp-credentials.html - subcategory: - explorer: false - post: - x-doc: - title: Register Google Cloud credentials - category: Cloud - filename: post-account-providers-cloudmanager_cbs-api-v2-gcp-credentials.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials/{credentialsId}": - put: - x-doc: - title: Update Google Cloud credentials - category: Cloud - filename: put-account-providers-cloudmanager_cbs-api-v2-gcp-credentials-.html - subcategory: - explorer: false - delete: - x-doc: - title: Delete Google Cloud credentials - category: Cloud - filename: delete-account-providers-cloudmanager_cbs-api-v2-gcp-credentials-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/iamra/config-status": - get: - x-doc: - title: Retrieve IAMRA enabled status - category: iamra - filename: get-account-providers-cloudmanager_cbs-api-v1-iamra-config-status.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/iamra/config-data": - get: - x-doc: - title: Retrieve IAMRA data status - category: iamra - filename: get-account-providers-cloudmanager_cbs-api-v1-iamra-config-data.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/iamra/security-data": - get: - x-doc: - title: Retrieve IAMRA security data - category: iamra - filename: get-account-providers-cloudmanager_cbs-api-v1-iamra-security-data.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/feature-flags": - get: - x-doc: - title: Retrieve a list of features which are enabled or disabled for the - account - category: Features - filename: get-account-providers-cloudmanager_cbs-api-v1-feature-flags.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/catalog/re-index": - post: - x-doc: - title: Re-index the catalog for all of the systems in an account - category: Catalog - filename: post-account-providers-cloudmanager_cbs-api-v2-catalog-re-index.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/search/job": - get: - x-doc: - title: Search for a specific file (on premises) - category: Catalog - filename: get-account-providers-cloudmanager_cbs-api-v1-catalog-search-job.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/license/working-environment/{workingEnvironmentId}/validity": - get: - x-doc: - title: Verify the valid licenses in a system - category: License - filename: get-account-providers-cloudmanager_cbs-api-v1-license-working-environment-validity.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/buckets": - post: - x-doc: - title: Retrieve a list of StorageGRID buckets - category: StorageGRID - filename: post-account-providers-cloudmanager_cbs-api-v1-sg-buckets.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/buckets/{bucketName}": - post: - x-doc: - title: Retrieve details of a bucket from the StorageGRID server - category: StorageGRID - filename: post-account-providers-cloudmanager_cbs-api-v1-sg-buckets-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/sg": - get: - x-doc: - title: List StorageGRID servers - category: StorageGRID - filename: get-account-providers-cloudmanager_cbs-api-v2-sg.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/sg/credentials": - post: - x-doc: - title: Register new StorageGRID credentials - category: StorageGRID - filename: post-account-providers-cloudmanager_cbs-api-v2-sg-credentials.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/sg/credentials/{storageServerName}": - put: - x-doc: - title: Update StorageGRID credentials - category: StorageGRID - filename: put-account-providers-cloudmanager_cbs-api-v2-sg-credentials-.html - subcategory: - explorer: false - delete: - x-doc: - title: Delete StorageGRID credentials - category: StorageGRID - filename: delete-account-providers-cloudmanager_cbs-api-v2-sg-credentials-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/report": - post: - x-doc: - title: Generate an inventory report - category: Report - filename: post-account-providers-cloudmanager_cbs-api-v1-report.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/report/job/{jobId}": - get: - x-doc: - title: Retrieve inventory report data - category: Report - filename: get-account-providers-cloudmanager_cbs-api-v1-report-job-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/report/snapshot/job/{jobId}": - get: - x-doc: - title: Retrieve the local snapshots report - category: Report - filename: get-account-providers-cloudmanager_cbs-api-v1-report-snapshot-job-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/report/replication/job/{jobId}": - get: - x-doc: - title: Retrieve replication report data - category: Report - filename: get-account-providers-cloudmanager_cbs-api-v1-report-replication-job-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/internal/working-environment/{workingEnvironmentId}/volume/{volumeId}": - patch: - x-doc: - title: Modify the charging flag for volumes - category: Volumes - filename: patch-account-providers-cloudmanager_cbs-api-internal-working-environment-volume-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/migration/validate": - post: - x-doc: - title: Validate migration operations - category: Migration - filename: post-account-providers-cloudmanager_cbs-api-v1-migration-validate.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/migration": - post: - x-doc: - title: Trigger backup migration - category: Migration - filename: post-account-providers-cloudmanager_cbs-api-v1-migration.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage": - post: - x-doc: - title: Create a bucket for a cloud provider - category: Object storage - filename: post-account-providers-cloudmanager_cbs-api-v1-object-storage.html - subcategory: - explorer: false - put: - x-doc: - title: Modify bucket properties for a cloud provider - category: Object storage - filename: put-account-providers-cloudmanager_cbs-api-v1-object-storage.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage/{provider}": - get: - x-doc: - title: Retrieve buckets for a cloud provider - category: Object storage - filename: get-account-providers-cloudmanager_cbs-api-v1-object-storage-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage/{provider}/{objectStoreName}": - get: - x-doc: - title: Retrieve a bucket for a cloud provider - category: Object storage - filename: get-account-providers-cloudmanager_cbs-api-v1-object-storage-provider.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v3/credentials": - post: - x-doc: - title: Register credentials for a cloud provider (v3) - category: Credentials - filename: post-account-providers-cloudmanager_cbs-api-v3-credentials.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v3/credentials/{credentialUuid}": - delete: - x-doc: - title: Delete the credentials for a cloud provider (v3) - category: Credentials - filename: delete-account-providers-cloudmanager_cbs-api-v3-credentials-.html - subcategory: - explorer: false - put: - x-doc: - title: Update a credential UUID (v3) - category: Credentials - filename: put-account-providers-cloudmanager_cbs-api-v3-credentials-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/configurations": - put: - x-doc: - title: Modify the configuration - category: Configuration - filename: put-account-providers-cloudmanager_cbs-api-v1-configurations.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v1/configurations/{key}": - get: - x-doc: - title: Retrieve the configuration value for the specified key - category: Configuration - filename: get-account-providers-cloudmanager_cbs-api-v1-configurations-.html - subcategory: - explorer: false - "/account/{accountId}/providers/cloudmanager_cbs/api/v2/panoramic-protection/working-environment/{workingEnvironmentId}/volume": - post: - x-doc: - title: Enable comprehensive panoramic protection for multiple volumes (v2) - category: Panoramic Protection - filename: post-account-providers-cloudmanager_cbs-api-v2-panoramic-protection-working-environment-volume.html - subcategory: - explorer: false - put: - x-doc: - title: Modify panoramic protection settings for multiple volumes (v2) - category: Panoramic Protection - filename: put-account-providers-cloudmanager_cbs-api-v2-panoramic-protection-working-environment-volume.html - subcategory: - explorer: false -categories: -- id: sfr - title: Single file restore endpoints in the NetApp Backup and Recovery REST API - permalink: sfr_overview.html -- id: backup - title: Backup endpoints in the NetApp Backup and Recovery REST API - permalink: backup_overview.html -- id: restore - title: Restore endpoints in the NetApp Backup and Recovery REST API - permalink: restore_overview.html -- id: system - title: System endpoints in the NetApp Backup and Recovery REST API - permalink: system_overview.html -- id: cloud - title: Cloud endpoints in the NetApp Backup and Recovery REST API - permalink: cloud_overview.html -- id: job - title: Job endpoints in the NetApp Backup and Recovery REST API - permalink: job_overview.html -- id: catalog - title: Catalog endpoints in the NetApp Backup and Recovery REST API - permalink: catalog_overview.html -- id: license - title: License endpoints in the NetApp Backup and Recovery REST API - permalink: license_overview.html -- id: ransomware scan - title: Ransomware scan endpoints in the NetApp Backup and Recovery REST API - permalink: ransomware_scan_overview.html -- id: panoramic protection - title: Panoramic protection endpoints in the NetApp Backup and Recovery REST API - permalink: panoramic_protection_overview.html -- id: replication - title: Replication endpoints in the NetApp Backup and Recovery REST API - permalink: replication_overview.html -- id: report - title: Report endpoints in the NetApp Backup and Recovery REST API - permalink: report_overview.html -- id: storagegrid - title: StorageGRID endpoints in the NetApp Backup and Recovery REST API - permalink: storagegrid_overview.html \ No newline at end of file diff --git a/cbs/cbs.yaml b/cbs/cbs.yaml deleted file mode 100644 index 7bd48342..00000000 --- a/cbs/cbs.yaml +++ /dev/null @@ -1,9656 +0,0 @@ -swagger: "2.0" -info: - title: NetApp Backup and Recovery REST API Reference - version: 4.0.6 - description: '
Overview

NetApp - Backup and Recovery is a service embedded within the NetApp Console platform - that provides backup and restore capabilities for protection and long-term - archiving of your data residing in Cloud Volumes ONTAP and on-premises ONTAP - clusters (AFF/FAS/OTS). By using this service, you can automatically - generate and store backups in an object store in the public or private cloud - account of your choice, and you can easily restore data any time and to any - location, as per your requirements.

There are 17 categories of - endpoints defined within the Backup and Recovery service:

  • backup -
  • catalog
  • cloud
  • configuration
  • features
  • job
  • license
  • migration
  • object store
  • - restore
  • single file-level restore (SFR)
  • system -
  • StorageGRID (sg)
  • ransomware scan
  • panoramic - protection
  • replication
  • reports

Note: Before - using the API reference documentation, review the - Get - started section for the NetApp Console APIs. For more information about the - security tokens and identifiers you’ll need when using the API, review the - Common workflows and tasks section - Common - workflows and tasks section.


- REST implementation

HTTP methods

MethodDescription
POSTCreate - an object instance
GETRetrieve - an object instance - or collection
PATCHUpdate an - existing object
DELETERemove an - existing object

Request headers

Request - HeaderDescription
AuthorizationRequired. Contains - a JWT access - token.
X-Agent-IdRequired. Contains - the Console agent ID. -
X-NetApp-Cache-ControlUsing this - header will bypass the local cache and retrieve actual data from upstream - sources like a NetApp Console SaaS application and ONTAP - clusters.

Query parameters

You can use - query parameters with endpoints in the - following components:

ComponentQuery Parameter
sfraccountId(required),
volumeId,
snapshotId.
backupaccountId(required),
workingEnvironmentId,
volumeId,
snapshotId.
restoreaccountId(required).
system accountId(required),
workingEnvironmentId,
volumeId,
snapshotId.
cloudaccountId(required),
workingEnvironmentId,
volumeId,
snapshotId,awsAccountId,
regionCode,
subscriptionId,
vaultName,
projectId,
jobId. -
licenseaccountId(required),
workingEnvironmentId.
catalogaccountId(required),
workingEnvironmentId.
jobaccountId(required),
jobId.

Response - headers

This API uses the standard HTTP response headers common with - all NetApp Console APIs. See - REST - implementation for more information.

HTTP - status codes

HTTP - Status CodeDescription
200OK:Returned for - successful - operation completion
400Bad - Request:Returned if the input is malformed and could not - be parsed
401Unauthorized:Returned - if user authentication failed or the token - has expired
403Forbidden:Returned - for authorization errors depending on the resource - and token
- Error handling

There are two - processes involved with error handling and processing.

  • The error - is logged for supportability
  • The error is also returned to the - caller for any specific handling
-
cURL examples

Retrieve - specific volume details

This example retrieves the details of a - specific volume that has been backed up by using the Backup and Recovery - service.

curl -X
-    GET    "https://cloudmanager.cloud.netapp.com/account/(account_id)/providers/cloudmanager_cbs/api/v1/backup/working-environment/(working_environment_id)/volume/(volume_id)"   -H
-    "accept: application/json" -H "authorization: (user
-    token)"
Frequently asked - questions

There are multiple versions of the - same command. Which version should I use?

If there are - multiple versions of the same API endpoint, make sure to use the latest - version of the API. The version of each endpoint is mentioned in the path. -

Whats the difference between a user token and service token - and why do we need two types of token authorization ?

A user - token is used for communication between a user (or the UI) and the NetApp Console - REST APIs, whereas the service token is used for communication between - two services (machine-to-machine interaction) in the NetApp Console platform. The - type of token required to invoke an API is documented in the description of - each endpoint.

What is the difference between SFR NetApp Backup - and Recovery APIs and Catalog NetApp Backup and Recovery - APIs?

The SFR NetApp Backup and Recovery APIs provide the - option to use the "Browse and Restore" feature while performing a volume - level or single/multiple file restore operation from backups stored on the - cloud. The Catalog NetApp Backup and Recovery APIs have introduced a new - "Search and Restore" feature, which enables you to search for a specific - file from all backups stored on Amazon S3 cloud storage and then perform a - restore operation. It enables you to perform a quick and focused search for - files across all the backups in the cloud and gives you the option to narrow - down the searches by using multiple search criteria.

Why has - the export file system API endpoint under the SFR category been - deprecated?

Previously, NetApp Backup and Recovery relied on - an additional Cloud Restore VM instance for exporting the snapshots - and creating a file list when you initiated a "File Restore" operation from - the Restore dashboard. Instead of creating an additional cloud restore - virtual machine (VM) instance during a file-level restore operation, the NetApp Backup and Recovery service deploys a restore container on the Agent VM - instance. These containers contain the latest Active Data Agent - image (version 1.4). This implementation does not require the file system to - be exported, therefore - the export file system API endpoint under the SFR category has been - deprecated.

Why have the API endpoints under the jobs - category changed?

The old job API endpoints have been - replaced with a set of new job API endpoints. The functionality of the new - endpoints differ from the old ones. Previously, the job endpoints were - used to retrieve a list of jobs and the details of a particular job. The new - job API endpoints allow services to create job entries, update the status of - a job directly in the database, and retrieve the current status of a job - from the database.

How - to use the Backup and Recovery REST APIs

Getting - started

To get started with the Backup and Recovery - APIs, obtain a user token, a NetApp Console account ID, and the Console agent - ID. When making API calls, add the user token in the Authorization header - and the console agent ID in the X-Agent-Id header. Use the NetApp Console - account ID in the APIs.

Obtain a user token from NetApp Console. -

Make sure to generate the refresh token from the - following link: https://services.cloud.netapp.com/refresh-token/. The - refresh token is an alpha-numeric string that is used to generate a user - token. 

curl -X
-    GET    "https://netapp-cloud-account.auth0.com/oauth/token?=" -H
-    "Content-Type: application/json" -d   "grant_type"
-    "refresh_token", "refresh_token"
-    "{REDACTED}",
-    "client_id"{REDACTED}"}

Obtain your NetApp Console account - ID

curl -X
-    GET  "https://cloudmanager.cloud.netapp.com/tenancy/account"    -H
-    "accept: application/json"  -H "authority:
-    cloudmanager.cloud.netapp.com" -H "accept-language:
-    en-GB,en;q=0.9"  -H "authorization: Bearer
-    {REDACTED}"

This API will return a - response like the following. You can retrieve the account ID by parsing the - output from [0].[ accountPublicId].

-

Response:

"[{"accountPublicId":"{ACCOUNT_ID}","accountName":"{ACCOUNT_NAME}","isSaas":true,"isGov":false,"isPrivatePreviewEnabled":false,"is3rdPartyServicesEnabled":false,"accountSerial":"{REDACTED}","userRole":"Role-1"}………" -

Obtain the X-Agent-Id that contains the Agent ID.

- 
curl -X GET
-    "https://api.services.cloud.netapp.com/occm/list-occms/{ACCOUNT_ID}?excludeStandalone=true&source=saas"     -H
-    "accept: application/json"  -H "authority:
-    api.services.cloud.netapp.com" -H "accept-language:
-    en-GB,en;q=0.9"  -H "authorization: Bearer
-    {REDACTED}"

This API will return a - response like the following. You can retrieve the agent ID by parsing the - output from occm.[0].[agent].[agentId].

-

Response:

"{"occms":[{"account":"{ACCOUNT_ID}","accountName":"{ACCOUNT_NAME}","occm":"{REDACTED}","agentId":"{REDACTED}","status":"ready","occmName":"{AGENT_NAME}","primaryCallbackUri":"","manualOverrideUris":[],"automaticCallbackUris":[],"createDate":"1652120369286","agent":{"useDockerInfra":true,"network":"default","name":"{AGENT_NAME}","agentId":"{REDACTED}","provider":"gcp","systemId":"{SYSTEM_ID}"

Example - using the APIs

The following example shows an API call - to activate a backup on a system with a new policy that has daily, hourly, - and weekly labels set, and archive after days set as 180 days in East-US-2 - region in Azure cloud. This enables backup only on a system but no volumes - are backed up. If you choose "auto-backup-enabled": true, then any volumes - already existing in the system are backed up and future volumes added. - 

curl -X
-    GET     "https://cloudmanager.cloud.netapp.com/account/account-DpTFcxN3/providers/cloudmanager_cbs/api/v3/backup/working-environment/VsaWorkingEnvironment-99hPYEgk"     -H
-    "accept: application/json"  -H "X-Agent-Id:
-    {REDACTED}"  -H
-    "authorization: Bearer {REDACTED}" -d
-    "{"provider":"AZURE","backup-policy": {"archive-after-days":
-    180,"rule": [{"label": "hourly","retention": "2"},{"label":
-    "daily","retention": "30"},{"label": "weekly", "retention":
-    "52"}]},"ip-space": "Default","region": "eastus2","azure":
-    {"resource-group": "rn-test-backup-rg",     "subscription":
-    "3beb4dd0-25d4-464f-9bb0-303d7cf5c0c2"}}"
' -definitions: - Authorization: - type: object - required: - - authorization - properties: - authorization: - type: string - description: Authorization JWT Service Token - X-Service-Request-Id: - type: string - description: Request identifier - AuthorizationUser: - type: object - required: - - authorization - properties: - authorization: - type: string - description: Authorization JWT User Token - X-Service-Request-Id: - type: string - description: Request identifier - Error: - type: object - description: Error response - properties: - error: - type: string - description: Error code/category - message: - type: string - description: Error description message -paths: - /account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/file-explore/start: - post: - description:

Starts a file and folder explore operation while initiating a - single file restore (SFR) operation. This API endpoint initiates the - deployment of an Active Data Connector container on the Console agent - and mounts the snapshot under the /tmp folder to browse the files - and folders. This API endpoint is currently supported on Cloud Volumes - ONTAP on AWS, Azure, Google Cloud, and on-premises ONTAP systems. It - supports retrieving files and folders from backups stored on AWS, Azure, - Google Cloud, and StorageGRID cloud storage - providers.

Token usage:NetApp Console user - token.

- tags: - - SFR - parameters: - - type: string - description: Location of the snapshot - enum: - - LOCAL - - CLOUD - required: false - in: query - name: snapshotLocation - - type: string - description: Snapshot ID of the source snapshot - required: false - in: query - name: snapshotId - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: File system ID/Volume ID - required: true - in: path - name: volumeId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}/file-explore/list: - get: - description:

Retrieves a list of files and folders within a specified volume - snapshot in a paginated format during a file or folder restore - operation (V2 version of the file-explore/list API). You can pass the - number of pages and limit of the number of files that the API endpoint - should retrieve while fetching the details in a paginated format. The - volume snapshot is mounted on under the /tmp folder of the - Console agent instance to create a file catalog for the "Browse and Restore" - option.

Token usage: NetApp Console user - token.

- tags: - - SFR - parameters: - - type: string - description: Location of the snapshot - enum: - - LOCAL - - CLOUD - required: false - in: query - name: snapshotLocation - - type: string - description: Type of the file - enum: - - FILE - - DIRECTORY - - ALL - required: false - in: query - name: fileType - - type: string - description: The column name to sort with - enum: - - name - - size - - mtime - required: false - in: query - name: sortBy - - type: string - description: Order of the results, either ASCENDING or DESCENDING - enum: - - ASC - - DESC - required: false - in: query - name: orderBy - - type: string - description: Name of the file or directory - required: false - in: query - name: name - - type: string - description: Path of files to browse - required: false - in: query - name: path - - type: number - description: Number of the page - required: false - in: query - name: page - - type: number - description: Limit of files - required: false - in: query - name: limit - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: File system ID/Volume ID - required: true - in: path - name: volumeId - - type: string - description: Snapshot ID - required: true - in: path - name: snapshotId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - pageConfig: - type: object - properties: - next: - type: object - properties: - page: - type: number - description: Next page number - limit: - type: number - description: Limit of files - previous: - type: object - properties: - page: - type: number - description: Previous page number - limit: - type: number - description: Limit of files - startIndex: - type: number - description: Starting index of file list - endIndex: - type: number - description: Ending index of file list - context: - type: array - items: - type: object - properties: - inode: - type: string - name: - type: string - path: - type: string - type: - type: string - size: - type: number - mtime: - type: number - /account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}/files/status: - get: - description:

Returns the file and folder status when you initiate a file or - folder search during a restore operation.

Token - usage: NetApp Console user token.

- tags: - - SFR - parameters: - - type: string - description: The path of the directory - required: false - in: query - name: path - - type: string - description: Location of the snapshot - enum: - - LOCAL - - CLOUD - required: false - in: query - name: snapshotLocation - - type: boolean - description: By default, the count is retrieved from the browsestatus table. When - this flag is true, it retrieves the count of the actual records - existing in the browsedb table. - required: false - in: query - name: actualCount - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: File system ID/Volume ID - required: true - in: path - name: volumeId - - type: string - description: Snapshot ID - required: true - in: path - name: snapshotId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - counter: - type: integer - inProgress: - type: boolean - /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment: - get: - description:

Retrieves the details of all systems that are - backed up using the NetApp Backup and Recovery service within an account. - It retrieves the backup enablement status, archive storage class, archive - after days, catalog enablement status, auto enablement status, maximum - transfer status, backup policy details, cloud storage pool, and remote - MetroCluster ID.

Token usage: NetApp Console user - token.

- tags: - - Backup - parameters: - - type: boolean - description: Returns only a partial response for the systems - required: false - in: query - name: partial - - type: boolean - default: true - description: A filter to include/exclude fields named provider-access-key and - ip-space - required: false - in: query - name: object-store-details - - type: boolean - default: true - description: A filter to include/exclude fields named used-capacity-gb, - charging-capacity,logical-used-size,backed-up-volume-count - required: false - in: query - name: capacity-details - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - working-environment: - type: array - items: - type: object - properties: - name: - type: string - id: - type: string - clusterId: - type: string - region: - type: string - status: - type: string - ontap-version: - type: string - backup-enablement-status: - type: string - type: - type: string - provider: - type: string - provider-account-id: - type: string - provider-account-name: - type: string - bucket: - type: string - archive-storage-class: - type: string - resource-group: - type: string - storage-account: - type: string - storage-server: - type: string - used-capacity-gb: - type: string - charging-capacity: - type: string - logical-used-size: - type: string - backed-up-volume-count: - type: string - total-volumes-count: - type: string - backup-policy-count: - type: string - failed-backup-volume-count: - type: string - catalog-enabled: - type: boolean - object-lock: - type: string - max-transfer-rate: - type: number - backup-policy: - type: object - properties: - name: - type: string - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - private-endpoint-required: - type: boolean - license: - type: object - properties: - free-trial-end: - type: number - eligible: - type: boolean - ip-space: - type: string - provider-access-key: - type: string - delete-yearly-snapshots: - type: boolean - export-existing-snapshots: - type: boolean - storage-grid-id: - type: string - sgws-archival: - type: object - properties: - cloud-storage-pool: - type: object - properties: - provider: - type: string - description: Cloud provider where the cloud storage pool is hosted - enum: - - AWS - - AZURE - provider-account-id: - type: string - description: Cloud provider account ID where the cloud storage pool is hosted - region: - type: string - description: Cloud provider region where the cloud storage pool is hosted - access-key: - type: string - archive-storage-class: - type: string - description: Storage class of a cloud storage pool to store archived objects - enum: - - GLACIER - - DEEP_ARCHIVE - required: - - provider - - provider-account-id - - region - remote-mcc-id: - type: string - architecture: - type: string - snapshot-policy: - type: string - replication-target: - type: object - properties: - id: - type: string - name: - type: string - policy-name: - type: string - prefix: - type: string - suffix: - type: string - svm: - type: string - aggregate: - type: array - items: - type: string - fix-mismatch-labels: - type: boolean - rsw-scheduled-scan: - type: boolean - rsw-scan-interval: - type: string - object-store-size: - type: object - properties: - standard: - type: number - archive: - type: number - cmek: - type: object - properties: - enabled: - type: boolean - keyDetails: - type: object - additionalProperties: true - description: JSON data containing data specific to Customer Managed Encryption Keys - /account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment: - get: - description:

Retrieves the details of all systems that are - backed up using the NetApp Backup and Recovery service within an account. - It retrieves backup enablement status, archive storage class, archive - after days, catalog enablement status, auto enablement status, maximum - transfer status, backup policy details, cloud storage pool, and remote - MetroCluster ID.

Token usage: NetApp Console user - token.

- tags: - - Backup - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - working-environment: - type: array - items: - type: object - properties: - id: - type: string - name: - type: string - publicId: - type: string - clusterId: - type: string - ontapVersion: - type: string - status: - type: string - type: - type: string - provider: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}: - get: - description:

Retrieves the details of a specific system backed up - by using the NetApp Backup and Recovery service within an account. It - retrieves backup enablement status, archive storage class, archive after - days, catalog enablement status, auto enablement status, maximum - transfer status, backup policy details, cloud storage pool, and remote - MetroCluster ID.

Token usage: NetApp Console user - token.

- tags: - - Backup - parameters: - - type: boolean - description: Returns only a partial response for a system. - required: false - in: query - name: partial - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - name: - type: string - id: - type: string - region: - type: string - status: - type: string - ontap-version: - type: string - backup-enablement-status: - type: string - type: - type: string - provider: - type: string - provider-account-id: - type: string - provider-account-name: - type: string - bucket: - type: string - archive-storage-class: - type: string - resource-group: - type: string - storage-account: - type: string - storage-server: - type: string - used-capacity-gb: - type: string - charging-capacity: - type: string - logical-used-size: - type: string - backed-up-volume-count: - type: string - total-volumes-count: - type: string - backup-policy-count: - type: string - failed-backup-volume-count: - type: string - catalog-enabled: - type: boolean - object-lock: - type: string - auto-backup-enabled: - type: boolean - max-transfer-rate: - type: number - backup-policy: - type: object - properties: - name: - type: string - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - private-endpoint-required: - type: boolean - license: - type: object - properties: - free-trial-end: - type: number - eligible: - type: boolean - ip-space: - type: string - provider-access-key: - type: string - delete-yearly-snapshots: - type: boolean - export-existing-snapshots: - type: boolean - storage-grid-id: - type: string - sgws-archival: - type: object - properties: - cloud-storage-pool: - type: object - properties: - provider: - type: string - description: Cloud provider where the cloud storage pool is hosted - enum: - - AWS - provider-account-id: - type: string - description: Cloud provider account ID where the cloud storage pool is hosted - region: - type: string - description: Cloud provider region where the cloud storage pool is hosted - access-key: - type: string - archive-storage-class: - type: string - description: Storage class of a cloud storage pool to store archived objects - enum: - - GLACIER - - DEEP_ARCHIVE - required: - - provider - - provider-account-id - - region - remote-mcc-id: - type: string - architecture: - type: string - snapshot-policy: - type: string - replication-target: - type: object - properties: - id: - type: string - name: - type: string - policy-name: - type: string - prefix: - type: string - suffix: - type: string - svm: - type: string - aggregates: - type: array - items: - type: string - fix-mismatch-labels: - type: boolean - rsw-scheduled-scan: - type: boolean - object-store-size: - type: object - properties: - standard: - type: number - archive: - type: number - cmek: - type: object - properties: - enabled: - type: boolean - keyDetails: - type: object - additionalProperties: true - description: JSON data containing data specific to Customer Managed Encryption Keys - rsw-scan-interval: - type: string - delete: - description:

Unregisters a system. You can remove the NetApp Backup - and Recovery service from a system. Before you unregister, - make sure that you delete all backups and disable the Backup and - Recovery service on a system. This action also deletes the - backup folder.

Token usage: NetApp Console - user token.

- tags: - - Backup - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/status: - get: - description:

Retrieves the backup status of a specified system - backed up by using the NetApp Backup and Recovery service within an account. - It retrieves backup enablement status, archive storage class, archive - after days, catalog enablement status, auto enablement status, maximum - transfer status, backup policy details, cloud storage pool, and remote - MetroCluster ID.

Token usage: NetApp Console user - token.

- tags: - - Backup - parameters: - - type: boolean - description: Returns only a partial response for a system - required: false - in: query - name: partial - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - name: - type: string - id: - type: string - region: - type: string - status: - type: string - ontap-version: - type: string - backup-enablement-status: - type: string - type: - type: string - provider: - type: string - provider-account-id: - type: string - provider-account-name: - type: string - bucket: - type: string - archive-storage-class: - type: string - resource-group: - type: string - storage-account: - type: string - storage-server: - type: string - used-capacity-gb: - type: string - charging-capacity: - type: string - logical-used-size: - type: string - backed-up-volume-count: - type: string - total-volumes-count: - type: string - backup-policy-count: - type: string - failed-backup-volume-count: - type: string - catalog-enabled: - type: boolean - auto-backup-enabled: - type: boolean - backup-policy: - type: object - properties: - name: - type: string - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - private-endpoint-required: - type: boolean - license: - type: object - properties: - free-trial-end: - type: number - eligible: - type: boolean - ip-space: - type: string - provider-access-key: - type: string - delete-yearly-snapshots: - type: boolean - export-existing-snapshots: - type: boolean - /account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment/{workingEnvironmentId}: - put: - description:

Modifies the NetApp Backup and Recovery service backup configuration - for a particular system synchronously (V2 version). You can modify - the state, backup policy, archive storage class, cloud storage pool, - AWS/Azure/Google Cloud/StorageGRID access and secret key, IPspace, maximum - transfer rate, and enable automatic backup.

Token - usage: NetApp Console user token.

- tags: - - Backup - parameters: - - name: body - in: body - schema: - type: object - properties: - state: - type: string - description: Updates the SnapMirror relationship state in the system to the specified state - enum: - - ENABLE - - DISABLE - backup-policy: - type: object - description: Uses an existing policy or creates a new policy if not found in the - list of ONTAP policies and modifies the backed up system relationships to use the existing one. - properties: - name: - type: string - description: Policy name of the existing policy or any custom name with which a - new policy needs to be created. If not specified, a policy - with the NetApp Backup and Recovery service default naming - convention is created. - rule: - type: array - description: Specifies the rules for a new policy - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - object-lock: - type: string - enum: - - NONE - - COMPLIANCE - - GOVERNANCE - sgws-archival: - type: object - properties: - cloud-storage-pool: - type: object - properties: - provider: - type: string - description: Cloud provider where the cloud storage pool is hosted - enum: - - AWS - - AZURE - provider-account-id: - type: string - description: Cloud provider account ID where the cloud storage pool is hosted - region: - type: string - description: Cloud provider region where the cloud storage pool is hosted - access-key: - type: string - description: Required input field if the provider is AWS - secret-password: - type: string - description: Required input field if the provider is AWS - archive-storage-class: - type: string - description: Required for AWS to specify which storage class to use for - archiving - enum: - - GLACIER - - DEEP_ARCHIVE - resource-group: - type: string - description: Required when the provider is Azure - required: - - provider - - provider-account-id - - region - archive-storage-class: - type: string - description: Required for AWS if modifying the storage class or enabling archive - for the first time. - enum: - - GLACIER - - DEEP_ARCHIVE - auto-backup-enabled: - type: boolean - description: Automatically backs up all volumes in the systems - max-transfer-rate: - type: number - description: Modifies node-level throttling of an ONTAP cluster. Value to be - specified in kilo bytes per second(kbps). A value of 0 implies - unlimited throttling - delete-yearly-snapshots: - type: boolean - description: Disables the deletion of local yearly snapshots after being - transferred to object store - export-existing-snapshots: - type: boolean - description: Exports pre-existing snapshots to object storage - ip-space: - type: string - description: IP space for the backed up system - toggle-rsw-scan: - type: boolean - description: Toggles RSW scheduled scan on or off - rsw-scan-interval: - type: string - description: RSW scheduled scans interval - enum: - - 1d - - 2d - - 3d - - 4d - - 5d - - 6d - - 7d - aws: - type: object - description: Accesses key and secret password for the system - properties: - access-key: - type: string - secret-password: - type: string - gcp: - type: object - description: Accesses key and secret password for the system - properties: - access-key: - type: string - secret-password: - type: string - sgws: - type: object - description: Accesses key and secret password for the system - properties: - access-key: - type: string - secret-password: - type: string - storage-grid-id: - type: string - description: StorageGRID ID. Required input field for StorageGRID provider - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID of the source Cloud Volumes ONTAP instance - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - - /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}: - get: - description:

Retrieves information for a specified volume backed up by - using the NetApp Backup and Recovery service. It retrieves the - details of the volume from the NetApp Console SaaS application. It retrieves the - archive after days, backup status, relationship policy name, and - capacity details. It also retrieves details of the archive after days, - object lock, ransomware scan status, last ransomware scan, and - ransomware detected snapshots with last ransomware scan - information.

Token usage:NetApp Console user - token.

- tags: - - Backup - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Volume ID - required: true - in: path - name: volumeId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - file-system-id: - type: string - name: - type: string - protocol: - type: string - svm: - type: string - status: - type: string - backup-status: - type: string - last-backup-creation-time: - type: number - snapshot-count: - type: string - backup-policy: - type: object - properties: - name: - type: string - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - lag: - type: string - capacity: - type: object - properties: - allocated: - type: string - used: - type: string - charging: - type: string - logicalUsedSize: - type: string - type: - type: string - snaplock-type: - type: string - style: - type: string - object-lock: - type: string - enum: - - GOVERNANCE - - COMPLIANCE - - NONE - - LOCKED - - UNLOCKED - ransomware-scan-status: - type: string - enum: - - RANSOMWARE_DETECTED - - IN_PROGRESS - - PROTECTED - - FAILED - last-ransomware-scan: - type: number - ransomware-detected-snapshots: - type: array - items: - type: object - properties: - snapshot-id: - type: string - snapshot-name: - type: string - last-ransomware-scan: - type: number - geometry: - type: number - aggregate-count: - type: number - cbsChargingEnabled: - type: boolean - put: - description:

Modifies a specified backed up volume. You can use this API - endpoint to modify the volume state, backup policy, backup policy - rule-retention, and archive-after-days parameters.

Token - usage: NetApp Console user token.

- tags: - - Backup - parameters: - - name: body - in: body - schema: - type: object - properties: - state: - type: string - enum: - - PAUSE - - RESUME - - DELETE - backup-policy: - type: object - properties: - name: - type: string - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - object-lock: - type: string - enum: - - NONE - - COMPLIANCE - - GOVERNANCE - - LOCKED - - UNLOCKED - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Volume ID - required: true - in: path - name: volumeId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - state: - type: string - delete: - description:

Removes the backup settings on a specified backed up volume. To - disable backup on a volume, the volume snapshots must be deleted.

Token usage:NetApp Console user - token.

- tags: - - Backup - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: File system ID/Volume ID - required: true - in: path - name: volumeId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v3/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}: - post: - description:

Enables backup for a specified volume (version V3). This version - of the endpoint runs the job asynchronously. Backup is not allowed - for a volume enabled with a SnapLock license (WORM license). You can - configure the different backup modes. The AD_HOC mode creates an - on-demand snapshot and stores a backup on the respective cloud. - SCHEDULED mode (default mode) creates snapshots as per the ONTAP - snapshot policy and stores a backup on the cloud as per the backup - policy. Based on the defined backup policy, this API endpoint creates a - SnapMirror to cloud relationship with a specific cloud object storage - system. Using this endpoint, you can set the archive after days - parameter to move the volume data to the archive tier and also enable - object lock and ransomware detection feature on the volume. -

Token usage: NetApp Console user token.

- tags: - - Backup - parameters: - - name: body - in: body - schema: - type: object - properties: - mode: - type: string - description: AD_HOC mode creates an on-demand snapshot and backs it up on - the respective cloud. SCHEDULED mode creates snapshots - as per the ONTAP snapshot policy and backs it up to the cloud as - per the backup policy. [Deprecated] IMMEDIATE mode is designed - for internal use cases and cannot be used for newer - integrations - enum: - - AD_HOC - - SCHEDULED - - IMMEDIATE - adhoc-backup-details: - type: object - properties: - name: - type: string - snapmirrorLabel: - type: string - backup-policy: - type: object - properties: - name: - type: string - description: Required input - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - object-lock: - type: string - enum: - - NONE - - COMPLIANCE - - GOVERNANCE - - LOCKED - - UNLOCKED - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Volume ID - required: true - in: path - name: volumeId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume: - get: - description:

Retrieves details of all the volumes for a specified system backed up by using the NetApp Backup and Recovery service. It - retrieves the volume name, volume type, protocol, storage VM, backup - status, last backup creation time, snapshot count, associated - backup policy, and backup policy rules. It also retrieves details of the - archive after days, object lock, ransomware scan status, last ransomware - scan, and ransomware detected snapshots with last ransomware - scan information.

Token usage: NetApp Console - user token.

- tags: - - Backup - parameters: - - type: boolean - description: Returns only a partial response from the NetApp Backup and Recovery - service database. API calls with this query parameter skips fetching - data from ONTAP - required: false - in: query - name: partial - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - volume: - type: array - items: - type: object - properties: - file-system-id: - type: string - name: - type: string - type: - type: string - style: - type: string - protocol: - type: string - svm: - type: string - status: - type: string - backup-status: - type: string - last-backup-creation-time: - type: number - snapshot-count: - type: string - backup-policy: - type: object - properties: - name: - type: string - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - snaplock-type: - type: string - lag: - type: string - capacity: - type: object - properties: - allocated: - type: string - used: - type: string - charging: - type: string - logicalUsedSize: - type: string - object-lock: - type: string - enum: - - GOVERNANCE - - COMPLIANCE - - NONE - - LOCKED - - UNLOCKED - ransomware-scan-status: - type: string - enum: - - RANSOMWARE_DETECTED - - IN_PROGRESS - - PROTECTED - - FAILED - last-ransomware-scan: - type: number - ransomware-detected-snapshots: - type: array - items: - type: object - properties: - snapshot-id: - type: string - snapshot-name: - type: string - last-ransomware-scan: - type: number - geometry: - type: number - aggregate-count: - type: number - cbsChargingEnabled: - type: boolean - put: - description:

Modifies multiple backed-up volumes in a specific system. This API endpoint modifies the volume state, backup-policy, - backup policy rule and retention, and archive-after-days - parameters.

Token usage: NetApp Console user - token.

- tags: - - Backup - parameters: - - name: body - in: body - schema: - type: object - properties: - volume: - type: array - items: - type: object - properties: - state: - type: string - enum: - - PAUSE - - RESUME - - DELETE - file-system-id: - type: string - backup-policy: - type: object - properties: - name: - type: string - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - object-lock: - type: string - enum: - - NONE - - COMPLIANCE - - GOVERNANCE - - LOCKED - - UNLOCKED - required: - - file-system-id - required: - - volume - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}: - get: - description:

Retrieves information of a particular snapshot for a - specified volume backed up by using the NetApp Backup and Recovery - service for a system. This API endpoint retrieves the - details of the volume snapshots from the NetApp Console SaaS application. - It retrieves the snapshot name, snapshot creation time, archive status, - and size. It also retrieves the object-lock, - ransomware-scan-status-failure, and - ransomware-scan-status.

Token usage: - NetApp Console user token.

- tags: - - Backup - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: File system ID/Volume ID - required: true - in: path - name: volumeId - - type: string - description: Snapshot ID - required: true - in: path - name: snapshotId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - id: - type: string - name: - type: string - creation-time: - type: number - archived: - type: boolean - size: - type: number - last-ransomware-scan: - type: number - object-lock: - type: string - enum: - - COMPLIANCE - - GOVERNANCE - - NONE - - LOCKED - - UNLOCKED - ransomware-scan-status-failure: - type: string - ransomware-scan-status: - type: string - enum: - - RANSOMWARE_DETECTED - - IN_PROGRESS - - PROTECTED - - FAILED - volume-id: - type: string - volume-name: - type: string - working-environment-id: - type: string - working-environment-name: - type: string - svm: - type: string - delete: - description:

Deletes a specified snapshot of a specified volume backed - up using the NetApp Backup and Recovery service for a system.

Token usage: NetApp Console user - token.

- tags: - - Backup - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: File system ID/Volume ID - required: true - in: path - name: volumeId - - type: string - description: Snapshot ID - required: true - in: path - name: snapshotId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - state: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot: - get: - description:

Retrieves snapshot information for a specified volume - backed up using the NetApp Backup and Recovery service for a system. This API endpoint retrieves the details of the volume - snapshots from the NetApp Console SaaS application. It retrieves the - snapshot name, snapshot creation time, archive status, and size. It also - retrieves the object-lock, ransomware-scan-status-failure, and - ransomware-scan-status details.

Token - usage: NetApp Console user token.

- tags: - - Backup - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: File system ID/Volume ID - required: true - in: path - name: volumeId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - snapshot: - type: array - items: - type: object - properties: - id: - type: string - name: - type: string - creation-time: - type: number - size: - type: number - last-ransomware-scan: - type: number - object-lock: - type: string - enum: - - COMPLIANCE - - GOVERNANCE - - NONE - - LOCKED - - UNLOCKED - ransomware-scan-status-failure: - type: string - archived: - type: boolean - ransomware-scan-status: - type: string - enum: - - RANSOMWARE_DETECTED - - IN_PROGRESS - - PROTECTED - - FAILED - volume-id: - type: string - volume-name: - type: string - working-environment-id: - type: string - working-environment-name: - type: string - svm: - type: string - delete: - description:

Deletes all the snapshots for a specified volume backed - up by using the NetApp Backup and Recovery service for a system.

Token usage: NetApp Console - user token.

- tags: - - Backup - parameters: - - type: boolean - default: false - description: If set to true, all the metadata for the snapshots will be cleaned - from the database. Please check if the snapshots are in the object - store and then clean them. - required: false - in: query - name: force - - type: boolean - default: false - description: If set to true, the object store configuration that is not being used by - any volume will be cleaned up from the system. - required: false - in: query - name: remove-object-store-config - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: File system ID/Volume ID - required: true - in: path - name: volumeId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/snapshot: - get: - summary: List of snapshots by account id - description:

Retrieves snapshot information for a specified account by - using the account ID. This API endpoint retrieves the details of the snapshots - from the NetApp Console SaaS application. It retrieves the snapshot name, - snapshot creation time, archive status, and size. It also retrieves the - object-lock, ransomware-scan-status-failure, and - ransomware-scan-status.

Token usage: - NetApp Console user token.

- tags: - - Backup - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - snapshot: - type: array - items: - type: object - properties: - id: - type: string - name: - type: string - creation-time: - type: number - size: - type: number - last-ransomware-scan: - type: number - object-lock: - type: string - enum: - - COMPLIANCE - - GOVERNANCE - - NONE - - LOCKED - - UNLOCKED - ransomware-scan-status-failure: - type: string - archived: - type: boolean - ransomware-scan-status: - type: string - enum: - - RANSOMWARE_DETECTED - - IN_PROGRESS - - PROTECTED - - FAILED - /account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment/{workingEnvironmentId}/snapshot: - delete: - description:

Deletes all snapshots for a specified system that are backed up using the NetApp Backup and Recovery service (V2 - version).

Token usage: NetApp Console user - token.

- tags: - - Backup - parameters: - - type: boolean - default: false - description: If set to true, the object store configuration which is not being used by - any volume (other than the current volume being processed) will be - cleaned up from the system. - required: false - in: query - name: remove-object-store-config - - type: boolean - default: false - description: If set to true, all metadata for the snapshots will be removed from - the database without waiting for the deletion of backups from the - object store. Snapshot data in the object store might not be - deleted automatically; you must manually verify and remove the data. - required: false - in: query - name: force - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}: - post: - description:

Activates comprehensive protection in a system. - Based on the cascading or fan-out backup workflow selected on the - system, the API verifies whether a cluster peering - relationship exists between primary and secondary clusters to set up - replication. It creates a cluster peering relationship between - the two clusters if one does not exist. To create a backup to cloud relationship, the API enables backup on - the system and creates a bucket to which the backup will be - transferred.

- tags: - - Panoramic Protection - parameters: - - name: body - in: body - schema: - type: object - properties: - provider: - type: string - description: Required input field for on-premises use cases - enum: - - AWS - - AZURE - - GCP - - SGWS - - ONTAP_S3 - - S3_COMPATIBLE - region: - type: string - description: Required input field for on-premises use cases - aws: - type: object - properties: - account-id: - type: string - description: Required when the provider is AWS - access-key: - type: string - description: Required input field for on-premises use cases - secret-password: - type: string - description: Required input field for on-premises use cases - kms-key-id: - type: string - description: Optional input field for customer managed key use case - private-endpoint: - type: object - properties: - id: - type: string - description: Optional input field for a private endpoint - archive-storage-class: - type: string - description: Required for AWS to specify which storage class to use for - archiving - enum: - - GLACIER - - DEEP_ARCHIVE - azure: - type: object - properties: - resource-group: - type: string - description: Required when the provider is Azure - storage-account: - type: string - description: Required when the provider is Azure - subscription: - type: string - description: Required when the provider is Azure - private-endpoint: - type: object - description: Required input field for private link configuration - properties: - subnet: - type: string - description: Required input field for on-premises private link configuration - skip-creation: - type: boolean - description: Optional input field to skip private endpoint creation - default: false - key-vault: - type: object - properties: - key-vault-id: - type: string - key-name: - type: string - gcp: - type: object - properties: - project-id: - type: string - description: Required when the provider is Google Cloud - access-key: - type: string - description: Required input field for on-premises use cases - secret-password: - type: string - description: Required input field for on-premises use cases - kms: - type: object - properties: - key-ring-id: - type: string - crypto-key-id: - type: string - sgws: - type: object - properties: - storage-grid-id: - type: string - description: StorageGRID ID. Required input field for StorageGRID provider - storage-server: - type: string - description: StorageGRID server URL. Required input field for a StorageGRID - provider - access-key: - type: string - description: Required input field for on-premises use cases - secret-password: - type: string - description: Required input field for on-premises use cases - ontap-s3: - type: object - properties: - storage-server: - type: string - description: ONTAP S3 server URL. Required input field for ONTAP_S3 provider - access-key: - type: string - description: Required input field for on-premises use cases - secret-password: - type: string - description: Required input field for on-premises use cases - s3-compatible: - type: object - properties: - storage-server: - type: string - description: s3 storage server - access-key: - type: string - description: Required input field for on-premises use cases - secret-password: - type: string - description: Required input field for on-premises use cases - bucket: - type: string - description: Optional input - ip-space: - type: string - description: Required input field for on-premises use cases - backup-policy: - type: object - properties: - name: - type: string - description: Required input - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - object-lock: - type: string - enum: - - NONE - - COMPLIANCE - - GOVERNANCE - - LOCKED - - UNLOCKED - sgws-archival: - type: object - properties: - cloud-storage-pool: - type: object - properties: - provider: - type: string - description: Cloud provider where the cloud storage pool will be hosted - enum: - - AWS - - AZURE - provider-account-id: - type: string - description: Cloud provider account ID where the cloud storage pool will be hosted - region: - type: string - description: Cloud provider region where the cloud storage pool will be hosted - access-key: - type: string - description: Required input field if the provider is AWS - secret-password: - type: string - description: Required input field if the provider is AWS - archive-storage-class: - type: string - description: Required for AWS to specify which storage class to use for - archiving - enum: - - GLACIER - - DEEP_ARCHIVE - resource-group: - type: string - description: Required when the provider is Azure - required: - - provider - - provider-account-id - - region - auto-backup-enabled: - type: boolean - description: Automatically backs up all volumes in the system - max-transfer-rate: - type: number - description: Modifies node-level throttling of an ONTAP cluster. Value to be - specified in kilo bytes per second(kbps). A value of 0 implies - unlimited throttling - export-existing-snapshots: - type: boolean - description: Exports pre-existing snapshots to object storage - architecture: - type: string - enum: - - CASCADING - - FANOUT - description: Type of storage architecture. Fan-out or Cascading - snapshot-policy: - type: string - description: Snapshot policy name - replication-target: - type: object - properties: - policy-name: - type: string - working-environment-id: - type: string - working-environment-name: - type: string - svm: - type: string - prefix: - type: string - suffix: - type: string - aggregates: - type: array - items: - type: string - fix-mismatch-labels: - type: boolean - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v2/panoramic-protection/working-environment/{workingEnvironmentId}: - put: - description:

Modifies comprehensive protection configuration in a system. This API enables you to enhance the protection capabilities - within a system by adding replication and backup - functionalities. This enables the creation of fan-out or cascading - backup topologies in the cloud. When replication is selected, the API - first checks for the presence of an existing cluster-peering - relationship. If a relationship is not found, the API creates the - necessary cluster-peering relationship. Alternatively, if backup to the - cloud is selected, the API creates a bucket in the specified cloud - provider or appliance (AWS, AZURE, GCP, SGWS, ONTAP_S3) specifically for - the system. This designated bucket is used for storing - backups taken from the system. Archival tiers or - DataLock/Ransomware capability can be set while enabling backup to - cloud.

Token usage: NetApp Console user - token.

- tags: - - Panoramic Protection - parameters: - - name: body - in: body - schema: - type: object - properties: - state: - type: string - description: Updates the SnapMirror relationship state in the system to the state specified - enum: - - ENABLE - - DISABLE - provider: - type: string - description: Required input field for on-premises use cases - enum: - - AWS - - AZURE - - GCP - - SGWS - - ONTAP_S3 - - S3_COMPATIBLE - region: - type: string - description: Required input field for on-premises - aws: - type: object - properties: - account-id: - type: string - description: Required when the provider is AWS - kms-key-id: - type: string - description: Optional input field for customer managed key use case - private-endpoint: - type: object - properties: - id: - type: string - description: Optional input field for a private endpoint - archive-storage-class: - type: string - description: Required for AWS to specify which storage class to use for - archiving - enum: - - GLACIER - - DEEP_ARCHIVE - azure: - type: object - properties: - resource-group: - type: string - description: Required when the provider is Azure - storage-account: - type: string - description: Required when the provider is Azure - subscription: - type: string - description: Required when the provider is Azure - private-endpoint: - type: object - description: Required input field for private link configuration - properties: - subnet: - type: string - description: Required input field for on-premises private link configuration - skip-creation: - type: boolean - description: Optional input field to skip private endpoint creation - default: false - key-vault: - type: object - properties: - key-vault-id: - type: string - key-name: - type: string - gcp: - type: object - properties: - project-id: - type: string - description: Required when the provider is Google Cloud - credentials-id: - type: string - description: Google Cloud credentials ID. Required when the provider is Google Cloud - kms: - type: object - properties: - key-ring-id: - type: string - crypto-key-id: - type: string - sgws: - type: object - properties: - storage-grid-id: - type: string - description: StorageGRID ID. Required input field for StorageGRID provider - storage-server-name: - type: string - description: StorageGRID server name. Required input field for a StorageGRID - provider - ontap-s3: - type: object - properties: - storage-server: - type: string - description: ONTAP S3 server URL. Required input field for ONTAP_S3 provider - access-key: - type: string - description: Access-key:Required input field for on-premises use cases - secret-password: - type: string - description: Secret-password:Required input field for on-premises use cases - s3-compatible: - type: object - properties: - storage-server: - type: string - description: s3 storage server - access-key: - type: string - description: Required input field for on-premises use cases - secret-password: - type: string - description: Required input field for on-premises use cases - bucket: - type: string - description: Optional input - ip-space: - type: string - description: Required input field for on-premises use cases - backup-policy: - type: object - properties: - name: - type: string - description: Required input - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - object-lock: - type: string - enum: - - NONE - - COMPLIANCE - - GOVERNANCE - - LOCKED - - UNLOCKED - sgws-archival: - type: object - properties: - cloud-storage-pool: - type: object - properties: - provider: - type: string - description: Cloud provider where the cloud storage pool will be hosted - enum: - - AWS - - AZURE - provider-account-id: - type: string - description: Cloud provider account ID where the cloud storage pool will be hosted - region: - type: string - description: Cloud provider region where the cloud storage pool will be hosted - archive-storage-class: - type: string - description: Required for AWS to specify which storage class to use for - archiving - enum: - - GLACIER - - DEEP_ARCHIVE - resource-group: - type: string - description: Required when the provider is Azure - required: - - provider - - provider-account-id - - region - max-transfer-rate: - type: number - description: Modifies node-level throttling of an ONTAP cluster. Value to be - specified in kilo bytes per second(kbps). A value of 0 implies - unlimited throttling - export-existing-snapshots: - type: boolean - description: Exports pre-existing snapshots to object storage - architecture: - type: string - enum: - - CASCADING - - FANOUT - description: Type of storage architecture. Fan-out or Cascading - snapshot-policy: - type: string - description: "Snapshot policy name. To disable local snapshot, pass the value - as: none(case sensitive)." - replication-target: - type: object - properties: - policy-name: - type: string - working-environment-id: - type: string - working-environment-name: - type: string - svm: - type: string - prefix: - type: string - suffix: - type: string - aggregates: - type: array - items: - type: string - fix-mismatch-labels: - type: boolean - toggle-rsw-scan: - type: boolean - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}/volume: - post: - description:

Enables comprehensive panoramic protection for multiple - volumes. Based on the backup workflow chosen, Cascading or Fan-Out, the - API creates a replication relationship with a volume in the secondary - cluster and then creates a backup to cloud relationship with a cloud or - StorageGRID object store. While setting up the replication relationship, - the API verifies whether a cluster peering relationship is set up - between primary and secondary clusters. If there is no relationship, it creates a cluster - peering relationship, storage VM peering, and a DP volume on the - secondary cluster. Once the replication setup is complete, the API - performs a SnapMirror Create and Initialize operation. For creating a - backup to cloud, it first creates a bucket to which the backup is - transferred, and then a SnapMirror cloud relationship is created and - initialized.

Token usage: NetApp Console user - token.

- tags: - - Panoramic Protection - parameters: - - name: body - in: body - schema: - type: object - properties: - volume: - type: array - items: - type: object - properties: - volume-id: - type: string - volume-name: - type: string - workload: - type: string - enum: - - SQL - - VOLUMES - - VMWARE - - ORACLE - - HYPERV - - K8S - - KVM - description: Workload type of the volume. Currently only SQL, VOLUMES, VMWARE, ORACLE, HYPERV, K8S, KVM workloads are supported - architecture: - type: string - enum: - - CASCADING - - FANOUT - description: Type of storage architecture. Fan-out or Cascading - mode: - type: string - enum: - - SCHEDULED - - AD_HOC - type: - type: string - backup-policy: - type: object - properties: - name: - type: string - description: Required input - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - object-lock: - type: string - enum: - - NONE - - COMPLIANCE - - GOVERNANCE - - LOCKED - - UNLOCKED - snapshot-policy: - type: string - description: Snapshot policy name - replication: - type: object - properties: - working-environment-id: - type: string - working-environment-name: - type: string - svm: - type: string - policy-name: - type: string - prefix: - type: string - suffix: - type: string - destination-aggregates: - type: array - items: - type: string - is-enabled: - type: object - properties: - local-snapshot: - type: boolean - replication: - type: boolean - cloud-backup: - type: boolean - required: - - volume-id - - is-enabled - required: - - volume - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - put: - description:

Modifies comprehensive protection for multiple volumes. If the - selected volume already has an existing replication relationship, you - can use the API to modify the replication policy. Otherwise, the API can - be used to create a replication relationship. It creates a cluster-peer - relationship, establishes a storage VM-peer relationship, creates a DP - volume, and then performs the SnapMirror update/initialize process. - Similarly, if the selected volume already has an existing "backup to the - cloud" relationship, the API enables you to modify the backup policy. - Alternatively, if there is no existing relationship, the API can be used - to create SnapMirror cloud relationship. It creates a bucket in - the specified cloud provider and then performs a SnapMirror cloud - update/initialize operation.

Token usage: NetApp Console - user token.

- tags: - - Panoramic Protection - parameters: - - name: body - in: body - schema: - type: object - properties: - volume: - type: array - items: - type: object - properties: - volume-id: - type: string - volume-name: - type: string - workload: - type: string - enum: - - SQL - - VOLUMES - - VMWARE - - ORACLE - - HYPERV - - K8S - - KVM - description: Workload type of the volume. Currently only SQL, VOLUMES, VMWARE, ORACLE, HYPERV, K8S, KVM workloads are supported - type: - type: string - backup-policy: - type: object - properties: - name: - type: string - description: Required input - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - object-lock: - type: string - enum: - - NONE - - COMPLIANCE - - GOVERNANCE - - LOCKED - - UNLOCKED - state: - type: string - enum: - - PAUSE - - RESUME - - DELETE - snapshot-policy: - type: string - description: Snapshot policy name - architecture: - type: string - enum: - - CASCADING - - FANOUT - description: Type of storage architecture. Fan-out or Cascading - replication: - type: object - properties: - working-environment-id: - type: string - working-environment-name: - type: string - svm: - type: string - policy-name: - type: string - prefix: - type: string - suffix: - type: string - destination-aggregates: - type: array - items: - type: string - is-enabled: - type: object - properties: - local-snapshot: - type: boolean - replication: - type: boolean - cloud-backup: - type: boolean - required: - - volume-id - - is-enabled - required: - - volume - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/snapshot: - get: - description:

Retrieves snapshot information for a specified volume - backed up using NetApp Backup and Recovery for a system. - This API endpoint retrieves the details of the volume snapshots - from the NetApp Console SaaS application. It retrieves the snapshot name, - snapshot creation time, archive status, and size. It also retrieves the - object-lock, ransomware-scan-status-failure, and ransomware-scan-status - details.

Token usage: NetApp Console user - token.

- tags: - - Backup - parameters: - - type: string - description: SVM names in comma separated values - required: false - in: query - name: svm - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - snapshot: - type: array - items: - type: object - properties: - id: - type: string - name: - type: string - creation-time: - type: number - size: - type: number - last-ransomware-scan: - type: number - object-lock: - type: string - enum: - - COMPLIANCE - - GOVERNANCE - - NONE - - LOCKED - - UNLOCKED - ransomware-scan-status-failure: - type: string - archived: - type: boolean - ransomware-scan-status: - type: string - enum: - - RANSOMWARE_DETECTED - - IN_PROGRESS - - PROTECTED - - FAILED - volume-id: - type: string - volume-name: - type: string - working-environment-id: - type: string - working-environment-name: - type: string - svm: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/replication/working-environment/{workingEnvironmentId}/relationship: - patch: - description:

Performs an action on a volume that has SnapMirror replication enabled. Using this API, you will be able to perform a SnapMirror - relationship update, delete, pause, resync, reverse-resync, abort, and - resume functionality on a replicated volume.

Token - usage: NetApp Console user token.

- tags: - - Replication - parameters: - - type: boolean - description: Updates snapshot information in the database after a transfer to the object store. Default - value is false. - default: false - required: false - in: query - name: update-backup-inventory - - name: body - in: body - schema: - type: object - properties: - relationships: - type: array - items: - type: object - properties: - working-environment-id: - type: string - description: System ID (replication ONTAP cluster) where the - relationship resides - relationship-id: - type: string - mode: - type: string - description: Action to perform on replicated volume - enum: - - UPDATE - - BREAK - - PAUSE - - DELETE - - RESYNC - - REVERSE_RESYNC - - ABORT - - RESUME - create-snapshot: - type: boolean - description: Boolean variable describing whether to create a snapshot on - the source volume. - enum: - - true - - false - source-volume-id: - type: string - description: ID of the source volume - source-snapshot: - type: string - description: Snapshot name to be transferred when mode is UPDATE. This parameter - is optional and is exclusive to create-snapshot being - true. - required: - - working-environment-id - - relationship-id - - mode - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v2/restore: - post: - description:

Performs a volume and file level restore (V2 version) operation. - This API validates whether a backup of a volume exists. The restore - operation is not supported on data protection volumes, on a target - volume with a different language code than the source volume, and for - volumes with size less than 1GB. The restore operation is not allowed on a - volume enabled with a SnapLock license (WORM license). It checks whether - the source and target cloud provider matches. It also verifies whether - the backup and restore operation is supported in the system.

If DataLock and ransomware protection is enabled on - a system, ransomware scan is performed on the specified - cloud backup that relates to a particular volume when it is chosen to - be restored. To skip the scan, set the "skip-ransomware-check" parameter - to "true".

Token usage: NetApp Console user - token.

- tags: - - Restore - parameters: - - name: body - in: body - schema: - type: object - properties: - restore: - type: object - properties: - type: - type: string - restore-source: - type: string - description: Specifies the source of the restore - enum: - - LOCAL - - CLOUD - archive-restore-priority: - type: string - description: Required to specify the archival retrieval priority to determine - the restoration time - enum: - - High - - Standard - - Low - source: - type: object - properties: - working-environment-id: - type: string - working-environment-name: - type: string - bucket: - type: string - volume-name: - type: string - volume-id: - type: string - snapshot: - type: string - required: - - working-environment-id - - working-environment-name - - bucket - - volume-name - - volume-id - - snapshot - target: - type: object - properties: - working-environment-id: - type: string - working-environment-name: - type: string - svm: - type: string - aggregate: - type: string - volume-name: - type: string - path: - type: string - retain-source-path: - type: boolean - required: - - working-environment-id - - working-environment-name - - svm - - volume-name - file: - type: array - items: - type: object - properties: - inode: - type: number - path: - type: string - minLength: 1 - type: - type: string - size: - type: number - mtime: - type: number - required: - - inode - - path - - type - - size - - mtime - minItems: 1 - skip-ransomware-check: - type: boolean - description: Skips a ransomware scan - skip-file-rename: - type: boolean - description: Skips file rename while restore - is-on-demand-restore: - type: boolean - description: Triggers an on-demand restore - skip-azure-private-endpoint-creation: - type: boolean - description: Optional input field to skip private endpoint creation for Azure - default: false - required: - - type - - source - - target - required: - - restore - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v3/restore: - post: - description:

Performs a volume, file, and folder-level restore (version - 3) operation. It is also possible to do a multi-level or nested-level - folder restore operation. This API validates whether a backup of a volume exists. - The restore operation is not supported on data protection volumes, a target - volume with a different language code than the source volume, volumes - with a size of less than 1GB, and volumes enabled with a SnapLock license - (WORM license). In addition, restoring both files and folders is not - supported. Restoring multiple folders is also not supported. The API checks - whether the source and target cloud providers match and also verifies - whether the backup and restore operation is supported in the system.

If DataLock and ransomware protection is enabled on - a system, a ransomware scan is performed on the specified cloud - backup related to the volume that is to be - restored. To skip the scan, set the "skip-ransomware-check" parameter to - "true".

To indicate that the volume restore is part - of an application restore workflow, set the "is-app-volume-restore" - parameter to "true". This disables certain steps such as mounting the - volume after the storage volume restore.

This version adds support - for accepting a list of target aggregates.

Token - usage: NetApp Console user token.

- tags: - - Restore - parameters: - - name: body - in: body - schema: - type: object - properties: - restore: - type: object - properties: - type: - type: string - restore-source: - type: string - description: Specifies the source of the restore - enum: - - LOCAL - - CLOUD - restore-to-replication-source: - type: boolean - archive-restore-priority: - type: string - description: Required to specify the archival retrieval priority to determine - the restoration time - enum: - - High - - Standard - - Low - source: - type: object - properties: - working-environment-id: - type: string - working-environment-name: - type: string - bucket: - type: string - volume-name: - type: string - volume-id: - type: string - snapshot: - type: string - required: - - working-environment-id - - working-environment-name - - bucket - - volume-name - - volume-id - - snapshot - target: - type: object - properties: - working-environment-id: - type: string - working-environment-name: - type: string - svm: - type: string - volume-name: - type: string - path: - type: string - retain-source-path: - type: boolean - aggregates: - type: array - items: - type: string - required: - - working-environment-id - - working-environment-name - - svm - - volume-name - file: - type: array - items: - type: object - properties: - inode: - type: string - path: - type: string - minLength: 1 - type: - type: string - size: - type: number - mtime: - type: number - source-file-path: - type: string - required: - - inode - - path - - type - - size - - mtime - minItems: 1 - skip-ransomware-check: - type: boolean - description: Skips a ransomware scan - skip-file-rename: - type: boolean - description: Skips file rename during the restore - is-on-demand-restore: - type: boolean - description: Triggers an on-demand restore - is-app-volume-restore: - type: boolean - description: Indicates that the volume restore is part of an application - restore workflow - skip-azure-private-endpoint-creation: - type: boolean - description: Optional input field to skip private endpoint creation for Azure - default: false - required: - - type - - source - - target - required: - - restore - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/revert/working-environment/{workingEnvironmentId}/volume/{volumeId}: - post: - description:

Reverts a snapshot for a volume. It restores a snapshot - to be the read-write parent volume for the volume family. This - replaces the current working copy of the volume with the snapshot - that results in a loss of all changes made since the snapshot was - created. The system ID and volume ID are passed as - parameters in the API REST call and the required snapshot to which - the volume needs to restored to should be sent in the input body of the - REST API.

Token usage: NetApp Console user token.

- tags: - - Restore - parameters: - - name: body - in: body - schema: - type: object - properties: - snapshot-name: - type: string - required: - - snapshot-name - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Volume ID - required: true - in: path - name: volumeId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy: - get: - description:

Retrieves a list of ONTAP backup policies associated with a - system. You can filter the policies based on the archival - enablement status. This API endpoint retrieves the backup-policy name, - rule, attached volume count, archive-after-days, and object-lock mode - information.

Token usage: NetApp Console user - token.

- tags: - - System - parameters: - - type: boolean - description: Filters the policies based on the archival enablement status - required: false - in: query - name: archived - - type: boolean - description: Filters the policies based on the remote-mcc-id environment - required: false - in: query - name: is-mcc-cluster - - type: boolean - description: Returns the attached-volumes-count with the policy if set to true - required: false - in: query - name: partial - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - backup-policy: - type: array - items: - properties: - name: - type: string - id: - type: string - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - period: - type: string - attached-volumes-count: - type: string - archive-after-days: - type: string - object-lock: - type: string - enum: - - NONE - - COMPLIANCE - - GOVERNANCE - - LOCKED - - UNLOCKED - transfer-schedule: - type: object - properties: - uuid: - type: string - name: - type: string - cron: - type: object - properties: - minutes: - type: array - items: - type: integer - hours: - type: array - items: - type: integer - weekdays: - type: array - items: - type: integer - days: - type: array - items: - type: integer - months: - type: array - items: - type: integer - interval: - type: string - allow-policy-deletion: - type: boolean - type: object - post: - description:

Creates a backup policy in a system. The number - of retained backups can be up to a maximum of 1018 when no backup - policies are assigned to a volume. You can edit a policy to create up to - 4000 backups after you assign volumes to a policy through ONTAP CLI. - This API endpoint validates whether the ONTAP version used by a system supports archiving. You can archive the backups to a cloud - archive tier by setting the archive-after-days in the policy. You can - archive to AWS Glacier, Deep Glacier, Azure Archive, and Google - Archive.

You can enable DataLock and Ransomware protection - beginning with ONTAP 9.11.1 and later (supported for AWS, Azure, and - StorageGRID). This is applicable only for new backup activation. - Interoperability with archival policy is not supported. For AWS, - DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" - mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection - can be enabled in the "UNLOCKED" mode or "LOCKED" - mode.

Token usage: NetApp Console user token.

- tags: - - System - parameters: - - name: body - in: body - schema: - type: object - properties: - name: - type: string - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - period: - type: string - transfer-schedule: - type: string - sgws-archival: - type: object - properties: - cloud-storage-pool: - type: object - properties: - provider: - type: string - description: Cloud provider where the cloud storage pool is hosted - provider-account-id: - type: string - description: Cloud provider account ID where the cloud storage pool is hosted - region: - type: string - description: Cloud provider region where the cloud storage pool is hosted - access-key: - type: string - description: Required input field if the provider is AWS - secret-password: - type: string - description: Required input field if the provider is AWS - archive-storage-class: - type: string - description: Required for AWS to specify which storage class to use for - archiving - enum: - - GLACIER - - DEEP_ARCHIVE - required: - - provider - - provider-account-id - - region - archive-after-days: - type: string - provider: - type: string - enum: - - AWS - - AZURE - - GCP - - SGWS - - ONTAP_S3 - object-lock: - type: string - enum: - - NONE - - COMPLIANCE - - GOVERNANCE - - LOCKED - - UNLOCKED - required: - - rule - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - name: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy/{policyId}: - delete: - summary: Delete backup policy - description:

Deletes the backup policies associated with a - system.

Token usage: NetApp Console - user token.

- tags: - - System - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Policy ID - required: true - in: path - name: policyId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - /account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/backup-policy: - put: - description:

Updates a backup policy in a system. This V2 - version of the API endpoint facilitates modification of the rule, label, - retention, archive-after-days, and StorageGRID archival details which also - includes cloud storage pool information.

Token - usage: NetApp Console user token.

- tags: - - System - parameters: - - name: body - in: body - schema: - type: object - properties: - policyName: - type: string - description: Backup policy name - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - period: - type: string - sgws-archival: - type: object - properties: - cloud-storage-pool: - type: object - properties: - provider: - type: string - description: Cloud provider where the cloud storage pool is hosted - provider-account-id: - type: string - description: Cloud provider account ID where the cloud storage pool is hosted - region: - type: string - description: Cloud provider region where the cloud storage pool is hosted - access-key: - type: string - description: Required input field if the provider is AWS - secret-password: - type: string - description: Required input field if the provider is AWS - archive-storage-class: - type: string - description: Required for AWS to specify which storage class to use for - archiving - enum: - - GLACIER - - DEEP_ARCHIVE - required: - - provider - - provider-account-id - - region - transfer-schedule: - type: string - archive-after-days: - type: string - description: Archive after days value to which the policy will be modified, - "never" implies the removal of the archive-after-days property - from a backup policy. - required: - - policyName - - rule - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - name: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/ip-space: - get: - description:

Retrieves a list of IP spaces within a specified system.

Token usage: NetApp Console user - token.

- tags: - - System - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - ip-space: - type: array - items: - type: object - properties: - id: - type: string - name: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment: - get: - description:

Retrieves a list of systems and their details. - This API endpoint retrieves the name, region, status, type, - cloud-provider, provider-accountId, ontap-version, and - total-volumes-count information.

Token - usage: NetApp Console user token.

- tags: - - System - parameters: - - type: boolean - description: Returns only a partial response without volumes count for systems - required: false - in: query - name: partial - - type: boolean - description: Return systems with minimal fields using cache by - default, if not found in cache triggers live call to fetch details - required: false - in: query - name: cache - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - working-environment: - type: array - items: - type: object - properties: - id: - type: string - cluster-uuid: - type: string - name: - type: string - error: - type: string - region: - type: string - status: - type: string - ontap-version: - type: string - type: - type: string - provider: - type: string - provider-account-id: - type: string - description: AWS account ID/ Azure subscription ID / Google Cloud project ID - total-volumes-count: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}: - get: - description:

Retrieves the details of a specific system. This - API endpoint retrieves the name, region, status, type, - cloud-provider, provider-accountId, ontap-version, and - total-volumes-count of a specific system.

Token usage: NetApp Console user - token.

- tags: - - System - parameters: - - type: boolean - description: Returns only a partial response without a volumes count for a system - required: false - in: query - name: partial - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - id: - type: string - cluster-uuid: - type: string - name: - type: string - region: - type: string - status: - type: string - ontap-version: - type: string - type: - type: string - provider: - type: string - provider-account-id: - type: string - description: AWS account ID/ Azure subscription ID / Google Cloud project ID - total-volumes-count: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/svm: - get: - description:

Retrieves a list of storage VMs and their details from a - specific system. This API retrieves the ID, name, and a - list of aggregate objects that belongs to a storage VM. It also - retrieves the aggregate disk type, aggregate tiering status, aggregate - total size, and aggregate available size.

Token - usage: NetApp Console user token.

- tags: - - System - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - svm: - type: array - items: - type: object - properties: - id: - type: string - name: - type: string - aggregates: - type: array - items: - type: object - properties: - id: - type: string - name: - type: string - disktype: - type: string - is-tiered: - type: boolean - totalsize: - type: number - available: - type: number - used: - type: number - snaplock-type: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume: - get: - description:

Retrieves a list of volumes and their details from a - specific system. This API endpoint retrieves the - name, file-system-id, status, storage VM, type, style, capacity - allocated, capacity used, and SnapMirror label - information.

Token usage: NetApp Console user - token.

- tags: - - System - parameters: - - type: boolean - description: Returns only a partial response - required: false - in: query - name: completeResponse - - type: string - description: Name of the volume. example - volumeName* , *volumeName - required: false - in: query - name: name - - type: string - description: Language of the volume. example - C,C.UTF-8 etc - required: false - in: query - name: language - - type: string - description: "Type of the volume. example - rw/RW (Read-Write) dp/DP (Data - Protection) etc " - required: false - in: query - name: type - - type: string - description: "Style of the volume. example - - flexvol|flexgroup|flexgroup-constituent " - required: false - in: query - name: style - - type: string - description: snaplockType of the volume. example - compliance, enterprise and - non-snaplock - required: false - in: query - name: snaplockType - - type: number - description: Maximum records to return - required: false - in: query - name: max-records - - type: string - description: The next volume UUID to use to retrieve results - required: false - in: query - name: cursor - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - volume: - type: array - items: - type: object - properties: - name: - type: string - file-system-id: - type: string - status: - type: string - svm: - type: string - type: - type: string - style: - type: string - capacity: - type: object - properties: - allocated: - type: number - used: - type: number - logicalUsedByAfs: - type: number - snapmirror-label: - type: array - items: - type: string - snaplock-type: - type: string - language: - type: string - num-records: - type: number - cursor: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/configure-object-store: - post: - description:

Configures an object storage. This is a V2 version of the - object store configure API. It verifies whether a private endpoint is - enabled and a certificate is installed. You can verify whether - previously created private endpoints are enabled for AWS and Azure. This - API endpoint is called if no object stores are found when the NetApp Backup - and Recovery service is enabled.

Token - usage: NetApp Console user token.

- tags: - - System - parameters: - - name: body - in: body - schema: - type: object - properties: - cloud-provider: - type: string - object-store-name: - type: string - ip-space: - type: string - access-key: - type: string - secret-password: - type: string - storage-server: - type: string - region: - type: string - aws: - type: object - properties: - account-id: - type: string - description: Required when the provider is AWS - private-endpoint: - type: object - properties: - id: - type: string - description: Optional input field for private endpoints. - azure: - type: object - properties: - subscription: - type: string - description: Required when the provider is Azure - private-endpoint: - type: object - description: Required input field for an on-premises private link configuration - properties: - subnet: - type: string - description: Required input field for an on-premises private link configuration - required: - - cloud-provider - - object-store-name - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/list: - get: - description:

Retrieves a list of system volume directories. You - can run a query by using a target storage VM and the path of directories to browse - within the volume.

Token usage: NetApp Console - user token.

- tags: - - System - parameters: - - type: string - description: Target SVM - required: false - in: query - name: svm - - type: string - description: Path of directories to browse within a volume - required: false - in: query - name: path - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: File system ID/Volume ID - required: true - in: path - name: volumeId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - context: - type: array - items: - type: object - properties: - inode: - type: number - name: - type: string - type: - type: string - size: - type: number - mtime: - type: number - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/object-store-config/status: - get: - description:

Retrieves an object store configuration status. It uses the GET - /api/cloud/targets ONTAP REST APIs to retrieve the - details.

Token usage: NetApp Console user - token.

- tags: - - System - parameters: - - type: string - required: true - in: query - name: object-store-name - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - status: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policies: - get: - description:

Lists the snapshot policies associated with a system. The API will list the snapshot policies created on the - cluster level for the specified system. The system ID is passed as a parameter for the API REST call. It - returns the snapshot policies and the rules associated with the - policies.

Token usage: NetApp Console user - token.

- tags: - - System - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - snapshot-policy: - type: array - items: - type: object - properties: - id: - type: string - name: - type: string - rule: - type: array - items: - type: object - properties: - retention: - type: string - prefix: - type: string - label: - type: string - schedule-name: - type: string - cron: - type: object - properties: - minutes: - type: array - items: - type: integer - hours: - type: array - items: - type: integer - weekdays: - type: array - items: - type: integer - days: - type: array - items: - type: integer - months: - type: array - items: - type: integer - interval: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policies/{policyId}: - delete: - summary: Deletes a snapshot policy by uuid - description:

Deletes the snapshot policy for the specified - system.

Token usage: NetApp Console - user token.

- tags: - - System - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Policy ID - required: true - in: path - name: policyId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy: - get: - description:

Retrieves a list of ONTAP replication policies associated with - a system. The API will list the SnapMirror policies created - on the cluster level for the specified system. The system ID is passed as a parameter for the REST API call. It - returns the SnapMirror policies and the rules associated with the - policies.

Token usage: NetApp Console user - token.

- tags: - - System - parameters: - - type: boolean - description: Returns the attached-volumes-count with the policy if set to true - required: false - in: query - name: partial - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - replication-policy: - type: array - items: - type: object - properties: - name: - type: string - id: - type: string - svm: - type: string - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - transfer-schedule: - type: object - properties: - uuid: - type: string - name: - type: string - cron: - type: object - properties: - minutes: - type: array - items: - type: integer - hours: - type: array - items: - type: integer - weekdays: - type: array - items: - type: integer - days: - type: array - items: - type: integer - months: - type: array - items: - type: integer - interval: - type: string - policy-type: - type: string - attached-volumes-count: - type: string - copy-latest-source-snapshot: - type: boolean - copy-all-source-snapshots: - type: boolean - allow-policy-deletion: - type: boolean - post: - description:

Creates a replication policy in a system.

Token usage: NetApp Console user - token.

- tags: - - System - parameters: - - name: body - in: body - schema: - type: object - properties: - name: - type: string - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - transfer-schedule: - type: string - description: "Cron-based schedule for transfers. To disable the schedule, pass - the value as: none(case sensitive). By default, an hourly schedule - is selected." - copy-all-source-snapshots: - type: boolean - description: Copies all source snapshots to the replication detstination - copy-latest-source-snapshot: - type: boolean - description: Copies only the latest source snapshot to the replication detstination - svm-name: - type: string - description: Name of the SVM where the replication policy should be created - required: - - name - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy/{policyId}: - delete: - summary: Delete replication policy - description:

Deletes the SnapMirror policies created on the - cluster level for the specified system.

Token - usage: NetApp Console user token.

- tags: - - System - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Policy ID - required: true - in: path - name: policyId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - patch: - description:

Modifies a replication policy in a system.

Token usage: NetApp Console user - token.

- tags: - - System - parameters: - - name: body - in: body - schema: - type: object - properties: - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - transfer-schedule: - type: string - description: "Cron-based schedule for transfers. To disable the schedule, pass - the value as: none(case sensitive). By default, an hourly schedule - is selected." - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Replication policy UUID - required: true - in: path - name: policyId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/relationship: - get: - description:

Retrieves a list of ONTAP relationships associated with a - system. The system ID is passed as a parameter - for the REST API call. You can query by passing parameters to specify - the maximum number of records that should be returned, the next subsequent - volume UUID to get results from, and the type of - relationship.

Token usage: NetApp Console user - token.

- tags: - - System - parameters: - - type: number - description: Maximum records to return - required: false - in: query - name: max-records - - type: string - description: Next volume UUID to get results from - required: false - in: query - name: cursor - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - relationship: - type: array - items: - properties: - uuid: - type: string - source: - type: object - properties: - path: - type: string - svm: - type: string - destination: - type: object - properties: - path: - type: string - policy: - type: object - properties: - name: - type: string - state: - type: string - healthy: - type: string - relationship-type: - type: string - enum: - - intercluster - - intracluster - - backup - transfer: - type: object - properties: - last-transfer-size: - type: string - last-transfer-duration: - type: string - lag: - type: string - end-time: - type: string - state: - type: string - throttle: - type: string - protection-status: - type: string - enum: - - HEALTHY - - IN_PROGRESS - - ERROR - - WARNING - unhealthy-reason: - type: string - working-environment-id: - type: string - working-environment-name: - type: string - type: object - cursor: - type: string - num-records: - type: number - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/peercluster: - get: - description:

Retrieves a list of ONTAP clusters peered to a specific system. The required system ID is passed as a - parameter for the API call.

Token usage: - NetApp Console user token.

- tags: - - System - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - peer-working-environment: - type: array - items: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot: - get: - description:

Retrieves a list of snapshot details pertaining to a - specific volume in a particular system. The system ID, volume ID, and snapshot ID are passed as parameters for - the REST API call. You can query by passing parameters to specify the - maximum number of records that should be returned, the next subsequent - snapshot UUID to get results from, and the next `CP-COUNT` from where - the results should be fetched.

Token - usage: NetApp Console user token.

- tags: - - System - parameters: - - type: number - description: Maximum records to return - required: false - in: query - name: max-records - - type: string - description: Next snapshot UUID to get results from - required: false - in: query - name: cursor - - type: number - description: Next CP count to get results from - required: false - in: query - name: cp-count - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Volume ID - required: true - in: path - name: volumeId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - snapshot: - type: array - items: - type: object - properties: - id: - type: string - name: - type: string - size: - type: number - creation-time: - type: number - num-records: - type: number - cursor: - type: string - cp-count: - type: number - post: - description:

Creates a snapshot for a particular volume. The API - initiates the creation of a snapshot of the volume-based on the - snapshot policy assigned. The system ID, volume ID, and - snapshot ID are passed as parameters for the REST API call. The snapshot - name and label are used as headers.

Token - usage: NetApp Console user token.

- tags: - - System - parameters: - - name: body - in: body - schema: - type: object - properties: - name: - type: string - label: - type: string - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Volume ID - required: true - in: path - name: volumeId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}: - delete: - description:

Deletes a snapshot of a volume. The API deletes a - specific snapshot of a particular volume belonging to a specific - system. The system ID, volume ID, and snapshot - ID are passed as parameters for the REST API call.

Token - usage: NetApp Console user token.

- tags: - - System - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Volume ID - required: true - in: path - name: volumeId - - type: string - description: Snapshot ID - required: true - in: path - name: snapshotId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/relationship/{relationshipId}: - get: - description:

Lists the relationship details associated with a volume - SnapMirror replication relationship. The API returns the source details, destination - details, policy details, status, health, transfer type, and relationship - status details.

Token usage: NetApp Console user - token.

- tags: - - System - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Relationship ID - required: true - in: path - name: relationshipId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - uuid: - type: string - source: - type: object - properties: - path: - type: string - destination: - type: object - properties: - path: - type: string - policy: - type: object - properties: - name: - type: string - state: - type: string - healthy: - type: string - transfer: - type: object - properties: - last-transfer-size: - type: string - last-transfer-duration: - type: string - lag: - type: string - end-time: - type: string - state: - type: string - throttle: - type: string - protection-status: - type: string - enum: - - HEALTHY - - IN_PROGRESS - - ERROR - - WARNING - working-environment-id: - type: string - working-environment-name: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot-policy: - put: - description:

Modifies the snapshot policy to match the volume snapshot policy - based on the SnapMirror relationship associated with the volume in a - system.

Token usage: NetApp Console - user token.

- tags: - - System - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: volume ID - required: true - in: path - name: volumeId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - status: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/schedules: - get: - description:

Retrieves a list of schedules present in a system.

Token usage: NetApp Console user - token.

- tags: - - System - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - schedules: - type: array - items: - type: object - properties: - uuid: - type: string - name: - type: string - cron: - type: object - properties: - minutes: - type: array - items: - type: integer - hours: - type: array - items: - type: integer - weekdays: - type: array - items: - type: integer - days: - type: array - items: - type: integer - months: - type: array - items: - type: integer - interval: - type: string - post: - description:

Creates a new cron schedule in a system. -

Token usage: NetApp Console user token.

- tags: - - System - parameters: - - name: body - in: body - schema: - type: object - properties: - schedules: - type: array - items: - type: object - properties: - schedule-name: - type: string - cron: - type: object - properties: - minutes: - type: array - items: - type: integer - description: The minutes the schedule runs, required on POST for a cron - schedule. - hours: - type: array - items: - type: integer - weekdays: - type: array - items: - type: string - enum: - - SUNDAY - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - days: - type: array - items: - type: integer - months: - type: array - items: - type: string - enum: - - JANUARY - - FEBRUARY - - MARCH - - APRIL - - MAY - - JUNE - - JULY - - AUGUST - - SEPTEMBER - - OCTOBER - - NOVEMBER - - DECEMBER - required: - - minutes - required: - - schedule-name - - cron - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policy: - post: - description:

Creates a snapshot policy with the user specified schedule, - count and SnapMirror labels in a system. -

Token usage: NetApp Console user token.

- tags: - - System - parameters: - - name: body - in: body - schema: - type: object - properties: - name: - type: string - description: Snapshot policy name - copies: - type: array - items: - type: object - properties: - schedule-name: - type: string - label: - type: string - description: Label for SnapMirror operations - count: - type: number - description: Number of snapshots to maintain for this schedule - required: - - schedule-name - - count - required: - - name - - copies - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policy/{policyId}: - patch: - description:

Modifies the snapshot policy in a system. - For existing schedules attached to a snapshot policy, the SnapMirror label and count can be modified, it also supports the addition and - removal of schedules.

Token usage: NetApp Console - user token.

- tags: - - System - parameters: - - name: body - in: body - schema: - type: object - properties: - rules: - type: array - items: - type: object - properties: - name: - type: string - label: - type: string - description: Label for SnapMirror operations - count: - type: number - description: Number of snapshots to maintain for this rule - required: - - name - - label - - count - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Snapshot Policy ID - required: true - in: path - name: policyId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - status: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/discover/volumes: - post: - description:

Discovers all volumes with relationships for a - list of systems.

Token usage: - NetApp Console user token.

- tags: - - System - parameters: - - name: body - in: body - schema: - type: object - properties: - workingEnvironmentIds: - type: array - items: - type: string - discoverRelationships: - type: boolean - default: false - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default Response - schema: - type: object - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/account: - get: - description:

Retrieves a list of AWS accounts from the - NetApp Console.

Token usage: NetApp Console user - token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - account: - type: array - items: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/region: - get: - description:

Retrieves a list of subscribed AWS regions.

Token - usage: NetApp Console user token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - region: - type: array - items: - type: object - properties: - name: - type: string - code: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/region/{regionCode}/key: - get: - description:

Retrieves a list of AWS keys from a specified region that - belongs to a specified AWS account ID.

Token - usage: NetApp Console user token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Region code - required: true - in: path - name: regionCode - - type: string - description: AWS account ID - required: true - in: path - name: awsAccountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - key: - type: array - items: - type: object - properties: - name: - type: string - id: - type: string - origin: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/region/{regionCode}/privateLink: - get: - description:

Retrieves a list of AWS private links from a specified region - that belongs to a specified AWS account ID.

Token - usage: NetApp Console user token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Region code - required: true - in: path - name: regionCode - - type: string - description: AWS account ID - required: true - in: path - name: awsAccountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - privateLink: - type: array - items: - type: object - properties: - vpc-name: - type: string - vpc-id: - type: string - private-endpoint-id: - type: string - private-endpoint-name: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/archival-storage-class: - get: - description:

Retrieves a list of AWS storage classes available for archival - support.

Token usage: NetApp Console user - token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - storage-class: - type: array - items: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/buckets: - get: - description:

Retrieves a list of AWS S3 buckets from a specified region that - belongs to a specified AWS account ID from the NetApp Console SaaS - application.

Token usage: NetApp Console user - token.

- tags: - - Cloud - parameters: - - type: string - description: Bucket fields - required: false - in: query - name: fields - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: AWS account ID - required: true - in: path - name: awsAccountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - buckets: - type: array - items: - type: object - properties: - name: - type: string - region: - type: string - is-encrypted: - type: string - is-public: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/buckets/{bucketName}: - get: - description:

Retrieves a specific AWS S3 bucket from a specified region that - belongs to a specified AWS account ID from the NetApp Console SaaS - application.

Token usage: NetApp Console user - token.

- tags: - - Cloud - parameters: - - type: string - description: Bucket fields - required: false - in: query - name: fields - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: AWS account ID - required: true - in: path - name: awsAccountId - - type: string - description: AWS bucket name - required: true - in: path - name: bucketName - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - buckets: - type: array - items: - type: object - properties: - name: - type: string - region: - type: string - is-encrypted: - type: string - is-public: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/region: - get: - description:

Retrieves a list of regions from a specific subscription ID in - Azure.

Token usage: NetApp Console user token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Subscription ID - required: true - in: path - name: subscriptionId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - region: - type: array - items: - type: object - properties: - name: - type: string - code: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resource-group: - post: - description:

Creates an Azure resource group in the specified subscription - ID.

Token usage: NetApp Console user token.

- tags: - - Cloud - parameters: - - name: body - in: body - schema: - type: object - properties: - name: - type: string - description: Name of the resource group to be created - region: - type: string - description: Region where the resource group needs to be created - required: - - name - - region - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Subscription ID - required: true - in: path - name: subscriptionId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - state: - type: string - get: - description:

Retrieves a list of Azure resource groups from a specific - subscription ID in Azure.

Token usage: - NetApp Console user token.

- tags: - - Cloud - parameters: - - type: string - description: Region - required: false - in: query - name: region - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Subscription ID - required: true - in: path - name: subscriptionId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - resource-group: - type: array - items: - type: object - properties: - name: - type: string - id: - type: string - region: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vnet: - get: - description:

Retrieves a list of Azure virtual networks from a specific - subscription ID in Azure cloud.

Token - usage: NetApp Console user token.

- tags: - - Cloud - parameters: - - type: string - description: Region - required: false - in: query - name: region - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Subscription ID - required: true - in: path - name: subscriptionId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - vnet: - type: array - items: - type: object - properties: - name: - type: string - id: - type: string - region: - type: string - subnet: - type: array - items: - type: object - properties: - name: - type: string - id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription: - get: - description:

Retrieves a list of Azure subscriptions for a particular - account.

Token usage: NetApp Console user - token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - subscription: - type: array - items: - type: object - properties: - name: - type: string - id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vault/{vaultName}/key: - get: - description:

Retrieves a list of Azure vault keys from a particular vault for - a specific subscription ID in Azure cloud.

Token - usage: NetApp Console user token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Subscription ID - required: true - in: path - name: subscriptionId - - type: string - description: Azure key vault name - required: true - in: path - name: vaultName - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - key: - type: array - items: - type: object - properties: - name: - type: string - id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vault: - get: - description:

Retrieves a list of Azure vaults for a specific subscription ID - in Azure cloud.

Token usage: NetApp Console user - token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Subscription ID - required: true - in: path - name: subscriptionId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - vault: - type: array - items: - type: object - properties: - name: - type: string - id: - type: string - region: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resourceGroup/{resourceGroup}/storageAccounts: - get: - description:

Retrieves a list of Azure storage accounts for a specific - subscription ID in a resource group in Azure cloud from the NetApp Console SaaS - application.

Token usage: NetApp Console user - token.

- tags: - - Cloud - parameters: - - type: string - description: Storage account fields - required: false - in: query - name: fields - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Subscription ID - required: true - in: path - name: subscriptionId - - type: string - description: Resource Group - required: true - in: path - name: resourceGroup - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - storageAccounts: - type: array - items: - type: object - properties: - name: - type: string - is-encrypted: - type: string - is-public: - type: string - region: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resourceGroup/{resourceGroup}/storageAccounts/{storageAccountName}: - get: - description:

Retrieves a specific Azure storage account for a specific - subscription ID in a resource group in Azure cloud from the NetApp Console SaaS - application.

Token usage: NetApp Console user - token.

- tags: - - Cloud - parameters: - - type: string - description: storage account fields - required: false - in: query - name: fields - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Subscription ID - required: true - in: path - name: subscriptionId - - type: string - description: Resource Group - required: true - in: path - name: resourceGroup - - type: string - description: Storage Account Name - required: true - in: path - name: storageAccountName - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - storageAccounts: - type: array - items: - type: object - properties: - name: - type: string - is-encrypted: - type: string - is-public: - type: string - region: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project: - get: - description:

Retrieves a list of Google Cloud projects.

Token - usage: NetApp Console user token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - project: - type: array - items: - type: object - properties: - name: - type: string - id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region: - get: - description:

Retrieves a list of regions from a specific Google Cloud - project.

Token usage: NetApp Console user - token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Project ID - required: true - in: path - name: projectId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - region: - type: array - items: - type: object - properties: - name: - type: string - code: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region/{locationId}/keyrings: - get: - description:

Retrieves a list of KeyRings for a region from a specific Google - Cloud project.

Token usage: NetApp Console user - token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Project ID - required: true - in: path - name: projectId - - type: string - description: Region or location (for example, "us-east1") - required: true - in: path - name: locationId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - keyRings: - type: array - items: - type: object - properties: - id: - type: string - name: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region/{locationId}/keyrings/{keyRingId}/cryptokey: - get: - description:

Retrieves a list of CryptoKeys for a KeyRing in a region from a - specific Google Cloud project.

Token - usage: NetApp Console user token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Project ID - required: true - in: path - name: projectId - - type: string - description: Region or Location (for example, "us-east1") - required: true - in: path - name: locationId - - type: string - description: Key Ring ID - required: true - in: path - name: keyRingId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - cryptoKeys: - type: array - items: - type: object - properties: - id: - type: string - name: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/buckets: - get: - description:

Retrieves a list of buckets in a region from a specific Google - Cloud project from the NetApp Console SaaS application.

Token - usage: NetApp Console user token.

- tags: - - Cloud - parameters: - - type: string - description: bucket fields - required: false - in: query - name: fields - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Project ID - required: true - in: path - name: projectId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - buckets: - type: array - items: - type: object - properties: - name: - type: string - is-encrypted: - type: string - is-public: - type: string - region: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/buckets/{bucketName}: - get: - description:

Retrieves a specific Google Cloud bucket in a region from a specific - Google Cloud project from the NetApp Console SaaS - application.

Token usage: NetApp Console user - token.

- tags: - - Cloud - parameters: - - type: string - description: Bucket fields - required: false - in: query - name: fields - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Project ID - required: true - in: path - name: projectId - - type: string - description: Bucket name - required: true - in: path - name: bucketName - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - buckets: - type: array - items: - type: object - properties: - name: - type: string - is-encrypted: - type: string - is-public: - type: string - region: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials: - get: - description:

Lists Google Cloud credentials in the NetApp Console SaaS - application.

Token usage: NetApp Console user - token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: List of Google Cloud credential IDs - schema: - type: object - description: List of Google Cloud credential IDs - properties: - ids: - type: array - items: - type: string - post: - description:

Registers Google Cloud credentials for a Google Cloud project in - the NetApp Console SaaS application.

Token usage: - NetApp Console user token.

- tags: - - Cloud - parameters: - - name: body - in: body - schema: - type: object - properties: - credentials-id: - type: string - description: Credentials ID. Must only contain lower case alphabetic characters, numbers and - hyphen(-). Must start and end with an alphabetic character or number. - access-key: - type: string - description: Google Cloud access-key. - secret-password: - type: string - description: Google Cloud secret-password. - required: - - credentials-id - - access-key - - secret-password - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - /account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials/{credentialsId}: - put: - description:

Updates Google Cloud credentials for a Google Cloud project in the - NetApp Console SaaS application.

Token usage: - NetApp Console user token.

- tags: - - Cloud - parameters: - - name: body - in: body - schema: - type: object - properties: - access-key: - type: string - description: Google Cloud access-key. - secret-password: - type: string - description: Google Cloud secret-password. - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Credential ID - required: true - in: path - name: credentialsId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - delete: - description:

Deletes the Google Cloud credentials for a Google Cloud project in the - NetApp Console SaaS application.

Token usage: - NetApp Console user token.

- tags: - - Cloud - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Credentials ID - required: true - in: path - name: credentialsId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "204": - description: Default response - schema: - type: object - description: Default response - /account/{accountId}/providers/cloudmanager_cbs/api/v1/job: - get: - description:

Retrieves a list of jobs from the NetApp Console SaaS application. You - can query based on the job type and job status from the NetApp Console SaaS - application.

Token usage: NetApp Console user - token.

- tags: - - Job - parameters: - - type: string - description: Job type - required: false - in: query - name: type - - type: string - description: Job Status - required: false - in: query - name: status - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - job: - type: array - items: - type: object - properties: - id: - type: string - working-environment-id: - type: string - type: - type: string - status: - type: string - enum: - - PENDING - - IN_PROGRESS - - FAILED - - COMPLETED - error: - type: string - time: - type: number - data: - type: object - description: Optional object present in case of batch or individual operations - running inside the main job only - properties: - multi-volume-backup: - type: object - description: Contains individual volume data for multi-volume-backup - properties: - volume: - type: array - description: Array of objects containing volume backup status or errors with the - volume ID - items: - type: object - properties: - id: - type: string - description: Volume ID - status: - type: string - description: SUCCESS / FAILED status - enum: - - SUCCESS - - FAILED - error: - type: string - description: Error message in case of failure - restore: - type: object - description: Contains information about restore job - file and volume restore - properties: - type: - type: string - description: Type of restore - file or volume - source: - type: object - description: Optional object, present only for restore operations - properties: - working-environment-id: - type: string - working-environment-name: - type: string - bucket: - type: string - volume-id: - type: string - volume-name: - type: string - snapshot: - type: string - target: - type: object - description: Optional object, present only for restore operations - properties: - working-environment-id: - type: string - working-environment-name: - type: string - svm: - type: string - volume-name: - type: string - volume-size: - type: number - path: - type: string - batch: - type: array - description: Optional array, present only for restore file operations - items: - type: object - properties: - id: - type: string - status: - type: string - enum: - - PENDING - - IN_PROGRESS - - SUCCESS - - FAILED - error: - type: string - time: - type: number - file: - type: array - items: - type: object - properties: - inode: - type: number - path: - type: string - type: - type: string - size: - type: number - mtime: - type: number - /account/{accountId}/providers/cloudmanager_cbs/api/v1/job/{jobId}: - get: - description:

Retrieves the details of particular jobs from the NetApp Console SaaS - application.

Token usage: NetApp Console user - token.

- tags: - - Job - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Job ID - required: true - in: path - name: jobId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - job: - type: array - items: - type: object - properties: - id: - type: string - working-environment-id: - type: string - type: - type: string - status: - type: string - enum: - - PENDING - - IN_PROGRESS - - FAILED - - COMPLETED - error: - type: string - time: - type: number - data: - type: object - description: Optional object, present for batch or individual operations - running inside the main job only - properties: - multi-volume-backup: - type: object - description: Contains individual volume data for multi-volume-backup - properties: - volume: - type: array - description: Array of objects containing volume backup status or errors with the - volume ID - items: - type: object - properties: - id: - type: string - description: Volume ID - status: - type: string - description: SUCCESS / FAILED status - enum: - - SUCCESS - - FAILED - error: - type: string - description: Error message in case of failure - restore: - type: object - description: Contains information about restore job - file and volume restore - properties: - type: - type: string - description: Type of restore - file / volume - source: - type: object - description: Optional object, present only in case of restore operation - properties: - working-environment-id: - type: string - working-environment-name: - type: string - bucket: - type: string - volume-id: - type: string - volume-name: - type: string - snapshot: - type: string - target: - type: object - description: Optional object, present only in case of restore operation - properties: - working-environment-id: - type: string - working-environment-name: - type: string - svm: - type: string - volume-name: - type: string - volume-size: - type: number - path: - type: string - batch: - type: array - description: Optional array present only in case of restore file operation - items: - type: object - properties: - id: - type: string - status: - type: string - enum: - - PENDING - - IN_PROGRESS - - SUCCESS - - FAILED - error: - type: string - time: - type: number - file: - type: array - items: - type: object - properties: - inode: - type: number - path: - type: string - type: - type: string - size: - type: number - mtime: - type: number - /account/{accountId}/providers/cloudmanager_cbs/api/v1/feature-flags: - get: - description: Retrieves a list of features which are enabled or disabled for the account. - tags: - - Features - parameters: - - type: string - required: true - in: path - name: accountId - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - flexgroup-volume-directory-restore: - type: boolean - volumes-dashboard-v2: - type: boolean - allow-s3-compatible: - type: boolean - smc-resync: - type: boolean - job-monitor: - type: boolean - storage-protection: - type: boolean - /account/{accountId}/providers/cloudmanager_cbs/api/v2/catalog/working-environments/{workingEnvironmentId}/setup: - post: - description:

Configures the service to include indexed cataloging services. - It enables the AWS Athena interactive S3 query service and AWS Glue - serverless data integration service for AWS setup, Azure Synapse - analytics service for Azure setup, Google BigQuery service for Google Cloud setup - and DuckDB installation for StorageGRID.

Token - usage: NetApp Console user token.

- tags: - - Catalog - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v2/catalog/re-index: - post: - description:

Re-indexes the catalog for all of the systems in an - account

Token usage: NetApp Console user - token.

- tags: - - Catalog - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/search: - post: - description:

Searches for a specific file from the backups taken by the - NetApp Backup and Recovery service across volumes and - systems. It can also search for a specified volume. It is - possible to narrow down your file search based on a particular system, file extensions, size ranges, creation date range, and also - location of a backup.

Token usage:NetApp Console - user token.

- tags: - - Catalog - parameters: - - type: string - description: Search string - required: true - in: query - name: query - - type: string - required: false - in: query - name: jobId - - name: body - in: body - schema: - type: object - properties: - type: - type: string - description: Type of resource file/volume - enum: - - FILE - - DIRECTORY - - VOLUME - workingEnvironmentId: - type: array - items: - type: string - fileExtension: - description: File extension - type: array - items: - type: string - size: - type: object - description: Resource size in bytes - properties: - from: - type: number - to: - type: number - creationDate: - type: object - description: Creation date in milliseconds - properties: - from: - type: number - to: - type: number - backupLocation: - type: string - description: Snapshot location local/cloud - enum: - - LOCAL - - CLOUD - volumeId: - type: string - description: Volume ID - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - results: - type: array - items: - type: object - properties: - resourceName: - type: string - resourceType: - type: string - workingEnvironmentId: - type: string - workingEnvironmentName: - type: string - svmName: - type: string - volumeId: - type: string - volumeName: - type: string - resourceSize: - type: number - inode: - type: number - mtime: - type: number - latestSnapshotCreationTime: - type: number - snapshotsCount: - type: number - endOfResults: - type: boolean - status: - type: string - message: - type: string - "202": - description: Default Response - schema: - type: object - properties: - job-id: - type: string - status: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/search/job: - get: - description:

Searches for a specific file from the backups taken by the - NetApp Backup and Recovery service across on-premises volumes and - systems. It can also search for a specified volume. It is - possible to narrow down your file search based on a particular system, file extensions, size ranges, creation date range, and also - location of a backup.

Token usage:NetApp Console - user token.

- tags: - - Catalog - parameters: - - type: string - description: Search string - required: true - in: query - name: query - - type: string - required: false - in: query - name: jobId - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - results: - type: array - items: - type: object - properties: - resourceName: - type: string - resourceType: - type: string - workingEnvironmentId: - type: string - workingEnvironmentName: - type: string - svmName: - type: string - volumeId: - type: string - volumeName: - type: string - resourceSize: - type: number - inode: - type: string - mtime: - type: number - latestSnapshotCreationTime: - type: number - snapshotsCount: - type: number - endOfResults: - type: boolean - status: - type: string - message: - type: string - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/snapshots: - post: - description:

Retrieves a list of local and cloud snapshots related - to a particular volume by using the catalog index query. -

Token usage: NetApp Console user token.

- tags: - - Catalog - parameters: - - name: body - in: body - schema: - type: object - properties: - resourceName: - type: string - workingEnvironmentId: - type: string - volumeId: - type: string - resourceType: - type: string - inode: - type: string - mtime: - type: number - required: - - resourceName - - workingEnvironmentId - - volumeId - - resourceType - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - results: - type: object - properties: - workingEnvironmentId: - type: string - workingEnvironmentName: - type: string - volumeName: - type: string - volumeId: - type: string - snapshots: - type: array - items: - type: object - properties: - snapshotId: - type: string - snapshotName: - type: string - snapshotSize: - type: number - snapshotCreationTime: - type: number - location: - type: string - last-ransomware-scan: - type: number - ransomware-scan-status-failure: - type: string - object-lock: - type: string - enum: - - GOVERNANCE - - COMPLIANCE - - NONE - - LOCKED - - UNLOCKED - ransomware-scan-status: - type: string - enum: - - RANSOMWARE_DETECTED - - IN_PROGRESS - - PROTECTED - - FAILED - archived: - type: boolean - endOfResults: - type: boolean - /account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/working-environments/{workingEnvironmentId}: - put: - description:

Enables or disables the indexed cataloging service for a - specified system on AWS, Azure, Google Cloud and on-premise or dark - site deployments.

Token usage: NetApp Console user - token.

- tags: - - Catalog - parameters: - - name: body - in: body - schema: - type: object - properties: - state: - type: string - description: Modifies all of the SnapMirror relationship states in the system to the state specified. - enum: - - ENABLE - - DISABLE - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - /account/{accountId}/providers/cloudmanager_cbs/api/v1/license/working-environment/{workingEnvironmentId}: - get: - description: "

Retrieves the license validity of the systems from - the NetApp Console SaaS application. The API retrieves the eligibility of the - current license used and it also returns the days remaining if you are - using a trial license.

Token usage: NetApp Console - user token.

" - tags: - - License - parameters: - - type: string - enum: - - AWS - - AZURE - - GCP - - SGWS - required: true - in: query - name: provider - - type: string - description: Cloud provider account ID. AWS account ID/Azure subscription ID/ - Google Cloud project ID. It is not mandatory to send this query - parameter for StorageGRID. - required: false - in: query - name: cloudProviderAccountId - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - free-trial-end: - type: number - eligible: - type: boolean - /account/{accountId}/providers/cloudmanager_cbs/api/v1/license/working-environment/{workingEnvironmentId}/validity: - get: - description:

Checks if there is a valid marketplace subscription, backup - license, and SnapMirror license in a system.

Token usage: NetApp Console user - token.

- tags: - - License - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - marketplace-subscription: - type: boolean - cloud-backup-license: - type: boolean - snapmirror-license: - type: boolean - /account/{accountId}/providers/cloudmanager_cbs/api/v1/ransomware/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}: - post: - description:

Initiates a ransomware scan on the specified cloud backup - related to a volume snapshot transferred by the SnapMirror - Cloud - engine to the cloud object storage system. It scans only cloud backups. - It does not support scanning local snapshots. Ransomware attacks - on local snapshots cannot be detected.

Token - usage: NetApp Console user token.

- tags: - - Ransomware Scan - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: Volume ID - required: true - in: path - name: volumeId - - type: string - description: Snapshot ID - required: true - in: path - name: snapshotId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/version: - post: - description: "

Retrieves the version of the StorageGRID - servers.

Token usage: NetApp Console user - token.

" - tags: - - StorageGRID - parameters: - - name: body - in: body - schema: - type: object - properties: - storage-server: - type: string - description: StorageGRID server URL. - required: - - storage-server - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - version: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/sg: - post: - description:

Discovers a new StorageGRID server in the NetApp Console SaaS - application.

Token usage: NetApp Console user - token.

- tags: - - StorageGRID - parameters: - - name: body - in: body - schema: - type: object - properties: - admin-host: - type: string - description: StorageGRID Admin host IP address. - admin-username: - type: string - description: StorageGRID Admin username. - admin-password: - type: string - description: StorageGRID Admin password. - required: - - admin-host - - admin-username - - admin-password - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - name: - type: string - id: - type: string - - /account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/credentials/working-environment/{workingEnvironmentId}: - post: - description: "

Saves the StorageGRID credentials.

Token - usage: NetApp Console user token.

" - tags: - - StorageGRID - parameters: - - name: body - in: body - schema: - type: object - properties: - storage-server: - type: string - description: StorageGRID server URL. Required input field for a StorageGRID - provider - access-key: - type: string - description: Required input field for an on-premises use case - secret-password: - type: string - description: Required input field for an on-premises use case - required: - - storage-server - - access-key - - secret-password - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: System ID - required: true - in: path - name: workingEnvironmentId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - /account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/buckets: - post: - description:

Retrieves a list of StorageGRID buckets from the StorageGRID - server.

Token usage: NetApp Console user - token.

- tags: - - StorageGRID - parameters: - - type: string - description: bucket fields - required: false - in: query - name: fields - - name: body - in: body - schema: - type: object - properties: - storage-server: - type: string - description: StorageGRID server URL. Required input field for a StorageGRID - provider - access-key: - type: string - description: Required input field for an on-premises use case - secret-password: - type: string - description: Required input field for an on-premises use case - required: - - storage-server - - access-key - - secret-password - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - buckets: - type: array - items: - type: object - properties: - name: - type: string - region: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/buckets/{bucketName}: - post: - description:

Retrieves details of a specific bucket from the StorageGRID - server.

Token usage: NetApp Console user - token.

- tags: - - StorageGRID - parameters: - - type: string - description: bucket fields - required: false - in: query - name: fields - - name: body - in: body - schema: - type: object - properties: - storage-server: - type: string - description: StorageGRID server URL. Required input field for a StorageGRID - provider - access-key: - type: string - description: Required input field for an on-premises use case - secret-password: - type: string - description: Required input field for an on-premises use case - required: - - storage-server - - access-key - - secret-password - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: SGWS Bucket Name - required: true - in: path - name: bucketName - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - buckets: - type: array - items: - type: object - properties: - name: - type: string - region: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v2/sg: - get: - description:

Lists the StorageGRID servers in the NetApp Console SaaS - application.

Token usage: NetApp Console user - token.

- tags: - - StorageGRID - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: List of StorageGRID server names - schema: - type: object - description: List of StorageGRID server names - properties: - ids: - type: array - items: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v2/sg/credentials: - post: - description:

Registers new StorageGRID credentials in the NetApp Console SaaS - application.

Token usage: NetApp Console user - token.

- tags: - - StorageGRID - parameters: - - name: body - in: body - schema: - type: object - properties: - storage-server-name: - type: string - description: StorageGRID server name. - port: - type: string - description: StorageGRID node port. - access-key: - type: string - description: StorageGRID tenant access-key. - secret-password: - type: string - description: StorageGRID tenant secret-password. - required: - - storage-server-name - - port - - access-key - - secret-password - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - /account/{accountId}/providers/cloudmanager_cbs/api/v2/sg/credentials/{storageServerName}: - put: - description:

Updates StorageGRID credentials in the NetApp Console SaaS - application.

Token usage: NetApp Console user - token.

- tags: - - StorageGRID - parameters: - - name: body - in: body - schema: - type: object - properties: - port: - type: string - description: StorageGRID node port. - access-key: - type: string - description: StorageGRID tenant access-key. - secret-password: - type: string - description: StorageGRID tenant secret-password. - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: StorageGRID server name - required: true - in: path - name: storageServerName - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - delete: - description:

Deletes StorageGRID credentials in the NetApp Console SaaS - application.

Token usage: NetApp Console user - token.

- tags: - - StorageGRID - parameters: - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: StorageGRID server name - required: true - in: path - name: storageServerName - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "204": - description: Default response - schema: - type: object - description: Default response - /account/{accountId}/providers/cloudmanager_cbs/api/v1/report: - post: - description:

Generates an inventory report. You can create the inventory report - for the whole account or a specific list of systems. It is - also possible to generate reports for storage VMs under a system. By setting the "inventory-type" as "BACKUP", you can create - a report for the backup actions. By setting it as "ALL", you can create - a report for all the actions.

- tags: - - Report - parameters: - - name: body - in: body - schema: - type: object - properties: - inventory-type: - type: string - enum: - - ALL - - BACKUP - protection-type: - type: string - enum: - - BACKUP - - LOCAL_SNAPSHOT - - REPLICATION - returnSnapshots: - type: boolean - filters: - type: array - items: - type: object - properties: - working-environment-id: - type: string - svm: - type: array - items: - type: string - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/report/job/{jobId}: - get: - description:

Retrieves the inventory report - data that was generated by the Inventory Report POST API. When called, - it downloads the inventory report data based on the scope (account, - system, storage VM) specified during the deployment of the - Inventory Report POST API.

Token usage: - NetApp Console user token.

- tags: - - Report - parameters: - - type: number - description: Page number to the fetch the paginated report. The last page of the - report must be accessed to clean up the report from the memory. - required: false - in: query - name: page - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Job ID - required: true - in: path - name: jobId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - report: - type: array - items: - type: object - properties: - working-environment-id: - type: string - working-environment-name: - type: string - working-environment-status: - type: string - backup-enablement-status: - type: string - working-environment-type: - type: string - total-volumes-count: - type: number - backed-up-volumes-count: - type: number - provider: - type: string - provider-account-id: - type: string - bucket: - type: string - archive-storage-class: - type: string - region: - type: string - cmek: - type: object - properties: - enabled: - type: boolean - keyDetails: - type: object - additionalProperties: true - description: JSON data containing data specific to Customer Managed Encryption Keys - volumes: - type: array - items: - type: object - properties: - uuid: - type: string - name: - type: string - svm: - type: string - status: - type: string - backup-status: - type: string - last-backup-creation-time: - type: number - snapshot-count: - type: string - backup-policy: - type: object - properties: - name: - type: string - rule: - type: array - items: - type: object - properties: - label: - type: string - retention: - type: string - archive-after-days: - type: string - snapshot: - type: array - items: - type: object - properties: - id: - type: string - name: - type: string - creation-time: - type: number - size: - type: number - object-lock: - type: string - archived: - type: boolean - object-lock: - type: string - enum: - - GOVERNANCE - - COMPLIANCE - - NONE - - LOCKED - - UNLOCKED - ransomware-scan-status: - type: string - enum: - - RANSOMWARE_DETECTED - - IN_PROGRESS - - PROTECTED - - FAILED - last-ransomware-scan: - type: number - page: - type: number - total-pages: - type: number - /account/{accountId}/providers/cloudmanager_cbs/api/v1/report/snapshot/job/{jobId}: - get: - description:

Retrieves the local snapshots - report data that was generated by the Local Snapshot Inventory Report - POST API. When called, it downloads the local snapshot report data - based on the scope (account, system) specified during the - deployment of the Replication Inventory Report POST - API.

Token usage: NetApp Console user token.

- tags: - - Report - parameters: - - type: number - description: Page number to the fetch the paginated report. The last page of the - report must be accessed to clean up the report from the memory - required: false - in: query - name: page - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Job ID - required: true - in: path - name: jobId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - report: - type: array - items: - type: object - properties: - working-environment-name: - type: string - working-environment-id: - type: string - volume-count: - type: number - volumes: - type: array - items: - type: object - properties: - name: - type: string - svm: - type: string - state: - type: string - snapshot-count: - type: number - snapshot-policy: - type: string - snapshots: - type: array - items: - type: object - properties: - name: - type: string - creation-time: - type: number - size: - type: number - state: - type: string - expiry-time: - type: number - snaplock-expiry-time: - type: number - page: - type: number - total-pages: - type: number - /account/{accountId}/providers/cloudmanager_cbs/api/v1/report/replication/job/{jobId}: - get: - description:

Retrieves the replication report - data that was generated by the Replication Inventory Report POST API. - When called, it downloads the replication report data based on the scope - (account, system) specified during the deployment of the - Replication Inventory Report POST API.

Token - usage: NetApp Console user token.

- tags: - - Report - parameters: - - type: number - description: Page number to the fetch the paginated report. The last page of the - report must be accessed to clean up the report from the memory. - required: false - in: query - name: page - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - description: Job ID - required: true - in: path - name: jobId - - type: string - description: User token - required: true - in: header - name: authorization - - type: string - description: Request identifier - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default response - schema: - type: object - description: Default response - properties: - report: - type: object - properties: - total-volumes-count: - type: number - total-svms-count: - type: number - relationships: - type: array - items: - properties: - source-working-environment: - type: string - target-working-environment: - type: string - snapshot-count: - type: number - snapshots: - type: array - items: - type: object - properties: - name: - type: string - creation-time: - type: number - size: - type: number - state: - type: string - policy: - type: string - source-volume: - type: string - source-volume-svm: - type: string - target-volume: - type: string - target-volume-svm: - type: string - source-volume-uuid: - type: string - healthy: - type: string - unhealthy-reason: - type: string - policy-type: - type: string - source-volume-state: - type: string - type: object - page: - type: number - total-pages: - type: number - /account/{accountId}/providers/cloudmanager_cbs/api/v1/migration/validate: - post: - summary: Validate Migration Operations - description: Validates the migration of backups from the source ONTAP cluster to the target ONTAP cluster. - tags: - - migration - parameters: - - name: body - in: body - schema: - type: object - properties: - sourceWorkingEnvironmentId: - type: string - migrationWorkingEnvironmentId: - type: string - migrationMappingDetails: - type: array - items: - type: object - properties: - sourceVolumeUuid: - type: string - migratedVolumeUuid: - type: string - policyName: - type: string - required: - - sourceWorkingEnvironmentId - - migrationWorkingEnvironmentId - - migrationMappingDetails - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - required: true - in: header - name: authorization - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/migration: - post: - summary: Migration Operations - description: Triggers the migration of backups from the source ONTAP cluster to the target ONTAP cluster. - tags: - - migration - parameters: - - name: body - in: body - schema: - type: object - properties: - sourceWorkingEnvironmentId: - type: string - migrationWorkingEnvironmentId: - type: string - migrationMappingDetails: - type: array - items: - type: object - properties: - sourceVolumeUuid: - type: string - migratedVolumeUuid: - type: string - policyName: - type: string - ip-space: - type: string - description: Required input field for on-premises use cases - aws: - type: object - properties: - private-endpoint: - type: object - description: Required input field for on-premises use case for private link - configuration - properties: - id: - type: string - description: Optional input field for a private endpoint - azure: - type: object - properties: - private-endpoint: - type: object - description: Required input field for private link configuration - properties: - subnet: - type: string - description: Required input field for on-premises private link configuration - skip-creation: - type: boolean - description: Optional input field to skip private endpoint creation - default: false - gcp: - type: object - properties: - access-key: - type: string - description: Required input field for on-premises use cases - secret-password: - type: string - description: Required input field for on-premises use cases - required: - - sourceWorkingEnvironmentId - - migrationWorkingEnvironmentId - - migrationMappingDetails - - type: string - description: Account ID - required: true - in: path - name: accountId - - type: string - required: true - in: header - name: authorization - responses: - "202": - description: Default response - schema: - type: object - description: Default response - properties: - job-id: - type: string - /account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage: - post: - description: Creates a bucket for the specified cloud provider. - tags: - - Object Storage - parameters: - - description: Account ID for the AWS provider - type: string - required: false - in: query - name: account-id - - description: Project ID for the Google Cloud provider - type: string - required: false - in: query - name: project-id - - description: Resource group for the Azure provider - type: string - required: false - in: query - name: resource-group - - description: Subscription for the Azure provider - type: string - required: false - in: query - name: subscription - - description: Credential ID for the SGWS or ONTAP S3 provider - type: string - required: false - in: query - name: credential-id - - name: body - in: body - schema: - type: object - properties: - provider: - description: Cloud provider - type: string - region: - description: Region - type: string - object-lock: - description: Object lock mode - enum: - - NONE - - COMPLIANCE - - GOVERNANCE - - LOCKED - - UNLOCKED - type: string - object-store-name: - description: Object store name - type: string - tags: - type: array - items: - type: object - properties: - key: - description: Tag key - type: string - value: - description: Tag value - type: string - required: - - key - - value - aws: - type: object - properties: - account-id: - description: AWS account ID - type: string - kms-key-id: - description: AWS KMS key ID - type: string - private-endpoint: - type: object - properties: - id: - description: AWS private endpoint ID - type: string - required: - - id - archive-storage-class: - description: AWS archive storage class - type: string - required: - - account-id - azure: - type: object - properties: - resource-group: - description: Azure resource group - type: string - storage-account: - description: Azure storage account - type: string - subscription: - description: Azure subscription - type: string - private-endpoint: - type: object - properties: - subnet: - description: Azure private endpoint subnet - type: string - required: - - subnet - key-vault: - type: object - properties: - key-vault-id: - description: Azure Key Vault ID - type: string - key-name: - description: Azure Key Vault key name - type: string - required: - - key-vault-id - - key-name - required: - - resource-group - - storage-account - - subscription - gcp: - type: object - properties: - project-id: - description: Google Cloud project ID - type: string - kms: - type: object - properties: - key-ring-id: - description: Google Cloud KMS key ring ID - type: string - crypto-key-id: - description: Google Cloud KMS crypto key ID - type: string - required: - - key-ring-id - - crypto-key-id - required: - - project-id - sgws: - type: object - properties: - credential-id: - type: string - required: - - credential-id - ontap-s3: - type: object - properties: - credential-id: - type: string - required: - - credential-id - required: - - provider - - region - - object-lock - - object-store-name - - description: Account ID - type: string - required: true - in: path - name: accountId - - description: Job ID for the create bucket operation - type: string - required: true - in: header - name: job-id - - description: Authorization token - type: string - required: true - in: header - name: authorization - - description: Agent ID - type: string - required: true - in: header - name: X-Agent-Id - responses: - "202": - description: Default Response - schema: {} - put: - description: Modifies the bucket properties for the specified provider. - tags: - - Object Storage - parameters: - - name: body - in: body - schema: - type: object - properties: - provider: - description: Cloud provider type - enum: - - AWS - - GCP - - AZURE - type: string - region: - description: Region for the bucket - type: string - object-store-name: - description: Object store name - type: string - aws: - type: object - properties: - account-id: - description: AWS account ID - type: string - kms-key-id: - description: AWS KMS key ID - type: string - required: - - account-id - - kms-key-id - azure: - type: object - properties: - subscription: - description: Azure subscription - type: string - resource-group: - description: Azure resource group - type: string - key-vault: - type: object - properties: - key-vault-id: - description: Azure Key Vault ID - type: string - key-name: - description: Azure Key Vault key name - type: string - required: - - key-vault-id - - key-name - required: - - subscription - - resource-group - - key-vault - gcp: - type: object - properties: - project-id: - description: Google Cloud project ID - type: string - kms: - type: object - properties: - key-ring-id: - description: Google Cloud KMS key ring ID - type: string - crypto-key-id: - description: Google Cloud KMS crypto key ID - type: string - required: - - key-ring-id - - crypto-key-id - required: - - project-id - - kms - required: - - provider - - region - - object-store-name - - description: Authorization token - type: string - required: true - in: header - name: authorization - - description: Agent ID - type: string - required: true - in: header - name: X-Agent-Id - - description: Job ID for the modify bucket operation - type: string - required: true - in: header - name: job-id - - type: string - required: true - in: path - name: accountId - responses: - "202": - description: Default Response - schema: {} - /account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage/{provider}: - get: - description: Retrieves buckets for the specified cloud provider. - tags: - - Object Storage - parameters: - - description: Account ID - type: string - required: true - in: path - name: accountId - - description: Cloud provider type - enum: - - AWS - - GCP - - AZURE - - SGWS - - ONTAP_S3 - type: string - required: true - in: path - name: provider - - description: Authorization token - type: string - required: true - in: header - name: authorization - - description: Agent ID - type: string - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default Response - schema: - type: array - items: - type: object - properties: - object-store-name: - description: Bucket name - type: string - region: - description: Bucket region - type: string - provider: - description: Cloud provider - type: string - creation-time: - description: Creation time of the bucket - type: string - account-id: - description: Account ID for the AWS provider - type: string - resource-group: - description: Resource group for the Azure provider - type: string - subscription: - description: Subscription for the Azure provider - type: string - project-id: - description: Project ID for the Google Cloud provider - type: string - storage-server: - description: Storage server for the SGWS/ONTAP S3 provider - type: string - required: - - object-store-name - - provider - - creation-time - /account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage/{provider}/{objectStoreName}: - get: - description: Retrieves a specific bucket for the specified cloud provider. - tags: - - Object Storage - parameters: - - description: Account ID - type: string - required: true - in: path - name: accountId - - description: Cloud provider type - enum: - - AWS - - GCP - - AZURE - - SGWS - - ONTAP_S3 - type: string - required: true - in: path - name: provider - - description: Bucket name - type: string - required: true - in: path - name: objectStoreName - - description: Authorization token - type: string - required: true - in: header - name: authorization - - description: Agent ID - type: string - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default Response - schema: - type: object - properties: - object-store-name: - description: Bucket name - type: string - region: - description: Bucket region - type: string - provider: - description: Cloud provider - type: string - account-id: - description: Account ID for the AWS provider - type: string - project-id: - description: Project ID for the Google Cloud provider - type: string - subscription: - description: Subscription for the Azure provider - type: string - encryption: - description: Encryption type used for the bucket - type: string - is-public: - description: Indicates whether the bucket is public - type: boolean - object-lock: - description: Object lock enabled for the bucket - type: string - resource-group: - description: Resource group for the Azure provider - type: string - tags: - type: array - items: - type: object - properties: - key: - description: Tag key - type: string - value: - description: Tag value - type: string - required: - - object-store-name - - provider - /account/{accountId}/providers/cloudmanager_cbs/api/v1/configurations: - put: - description: Modifies the configuration. - tags: - - Configuration - parameters: - - name: body - in: body - schema: - type: object - properties: - key: - description: Configuration key - type: string - value: - description: Configuration value - required: - - key - - value - - description: Authorization token - type: string - required: true - in: header - name: authorization - - description: Agent ID - type: string - required: true - in: header - name: X-Agent-Id - - type: string - required: true - in: path - name: accountId - responses: - "200": - description: Default Response - schema: - type: object - properties: {} - "500": - description: Default Response - schema: - type: object - properties: - statusCode: - type: number - error: - type: string - message: - type: string - example: - statusCode: 500 - error: Internal Server Error - message: Configuration property "feature-flags.update-db-backups" is not defined - /account/{accountId}/providers/cloudmanager_cbs/api/v1/configurations/{key}: - get: - description: Retrieves the configuration value for the specified key. - tags: - - Configuration - parameters: - - description: Configuration key - type: string - required: true - in: path - name: key - - description: Account ID - type: string - required: true - in: path - name: accountId - - description: Authorization token - type: string - required: true - in: header - name: authorization - - description: Agent ID - type: string - required: true - in: header - name: X-Agent-Id - responses: - "200": - description: Default Response - schema: - type: object - properties: - value: - type: string - "500": - description: Default Response - schema: - type: object - properties: - statusCode: - type: number - error: - type: string - message: - type: string - example: - statusCode: 500 - error: Internal Server Error - message: Configuration property "feature-flags.update-db-backups" is not defined -host: localhost:8061 -schemes: - - http -consumes: - - application/json -produces: - - application/json -tags: - - name: SFR - description:
Overview

The single file restore - (SFR) endpoints retrieve files from the volume snapshots.

You - can perform the following operations by using the SFR - endpoints:

  • Start a snapshot backup file explore - operation.
  • Retrieve the snapshot backup file explore - status.
  • List files during snapshot backup file explore - operations.

- - name: Backup - description:
Overview

The backup endpoints manage - backup operations of cloud and on-premises resources and retrieve details - of the backup data when required. You can perform the following operations - by using the Backup endpoints:

  • Retrieve details of the backup - data of a system, volumes, and snapshots.

  • Enable cloud backup on a system, back up - volumes, and create on-demand backups.

  • Modify the backup - configuration of systems and volumes.

  • Disable - backups for systems and volumes, and delete - backups.
- - name: Restore - description:
Overview

The restore endpoints enable - you to perform volume, folder and file-level restore operations. You can - perform the following operations by using the Restore - endpoints:

  • Restore volumes, folder, and files. -

  • Retrieve volume, folder, and file restore - status.

- - name: System - description:
Overview

The system - endpoints retrieves details of the systems, manage the backup - policies and configure an object store associated with a system.

You can perform the following operations by using the - system endpoints:

  • Retrieve the list and details of - systems, backup policies, IP spaces, storage VMs, - and volumes, snapshot-policies, peer-cluster relationships, and - SnapMirror relationships.

  • Create a backup policy and configure - an object store.

  • List system volume - directories.

  • Modify a backup policy.
- - name: Cloud - description:
Overview

The cloud endpoints enable - you to retrieve information about various resources of the AWS, Azure, - Google Cloud providers from the NetApp Console SaaS application.

You can - perform the following actions by using the - cloud endpoints:

  • Retrieve the accounts, AWS region keys, AWS - region private links, AWS archival storage class, Azure subscription, - Azure subscription regions, Azure subscription resource-group, Azure - subscription VNet, Azure subscription vault key, Google Cloud projects, - Google Cloud project region, Google KeyRings and more.

  • Create - a subscription resource-group.

- - name: Job - description:
Overview

The Job endpoints display - information about jobs executed on the NetApp Console SaaS application.

You - can perform the following operation by using the Job - endpoints:

  • Retrieve a list of jobs and job - details.
- - name: Catalog - description:
Overview

The catalog endpoints manage - the indexed catalog search for files based on a query. You can perform the - following operations by using the Catalog endpoints:

  • Initiate - an indexed catalog search based on a query

  • Retrieve a list - of snapshots related to a particular volume by using the Catalog - Index query

  • Configure an indexed catalog service on AWS, - Azure, Google Cloud and on-premises or dark sites.

  • Modify the state of - an indexed catalog service.
- - name: License - description:
Overview

The license endpoints enable - you to retrieve the license validity of the systems from the - NetApp Console SaaS application. A valid license is required to activate NetApp - Backup and Recovery on a system, create backups of your - production data, and restore backup data on a production system. This API - retrieves the eligibility of the current license used and returns the days - remaining if you are using a trial license.

- - name: Ransomware Scan - description:
Overview

The Ransomware scan API - endpoint enables you to initiate a ransomware scan on a specified snapshot - available in the cloud object-store bucket. It scans only cloud - backups. It does not support scanning local snapshots. Ransomware - attacks on local snapshots cannot be detected.

- - name: Panoramic Protection - description:
Overview

The Panoramic Protection API - enables you to automate the complete 3-2-1 backup spectrum using a single - control plane to simplify your implementation of the various components of - 3-2-1 model where they are needed, without using multiple resource - managers and assistance from specially trained personnel. You can - configure backups either in a cascading workflow or fan-out workflow. You - can perform the following operations by using the Panoramic Protection - endpoints:

  • Enable 3-2-1 backup on systems by - creating the required cluster-peering for replication and the required - object-store buckets for backup to cloud in cascading or fan-out - topologies.

  • Modify 3-2-1 backup on systems by - configuring the setup required for replication or backup to cloud, to - create cascading or fan-out topologies.

  • Create 3-2-1 - cascading or fan-out backup topologies by configuring volume replication - and backup to cloud relationship.

  • Modify or add 3-2-1 backup - on volumes by configuring replication or backup to cloud, to create - cascading or fan-out topologies.
- - name: Replication - description:
Overview

The Replication enpoint - enables you to perform an action on a volume on which SnapMirror - replication is enabled. Using this API, you will be able to perform a - SnapMirror relationship update, delete, pause, resync, reverse-resync, - abort, and resume functionality on a replicated volume.

- - name: Report - description:
Overview

The report endpoints enable - users to create and retrieve an inventory report for the whole account or - a specific list of systems. It is also possible to generate - reports for specific storage VMs under a system. You can - perform the following operations by using the report - endpoints:

  • Generate an inventory report

  • Retrieve - inventory reports
- - name: StorageGRID - description:
Overview

The StorageGRID API - endpoints retrieve version and other details for the StorageGRID server. You can - also discover StorageGRID WebScale server in the NetApp Console SaaS - application.

You can perform the following operations by using the - StorageGRID endpoints:

  • Retrieve StorageGRID server - version
  • Retrieve details of the StorageGRID - server.
  • Discover or add new StorageGRID server into the - NetApp Console.

\ No newline at end of file diff --git a/cbs/cloud_overview.adoc b/cbs/cloud_overview.adoc new file mode 100644 index 00000000..d4914a10 --- /dev/null +++ b/cbs/cloud_overview.adoc @@ -0,0 +1,22 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/cloud_overview.html' +summary: 'Cloud endpoints in the NetApp Backup and Recovery REST API' +--- + += Cloud endpoints in the NetApp Backup and Recovery REST API + + + +The cloud endpoints enable you to retrieve information about various resources of the AWS, Azure, Google Cloud providers from the NetApp Console SaaS application. + +You can perform the following actions by using the cloud endpoints: + +* Retrieve the accounts, AWS region keys, AWS region private links, AWS archival storage class, Azure subscription, Azure subscription regions, Azure subscription resource-group, Azure subscription VNet, Azure subscription vault key, Google Cloud projects, Google Cloud project region, Google KeyRings and more. + + +* Create a subscription resource-group. + + + + diff --git a/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.adoc b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.adoc new file mode 100644 index 00000000..7844c517 --- /dev/null +++ b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.adoc @@ -0,0 +1,86 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.html' +summary: 'Unregister a system' +--- + += Unregister a system + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}`# + + + +Unregisters a system. You can remove the NetApp Backup and Recovery service from a system. Before you unregister, make sure that you delete all backups and disable the Backup and Recovery service on a system. This action also deletes the backup folder. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + diff --git a/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.adoc b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.adoc new file mode 100644 index 00000000..ee2c2aff --- /dev/null +++ b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.adoc @@ -0,0 +1,92 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.html' +summary: 'Remove backup settings' +--- + += Remove backup settings + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}`# + + + +Removes the backup settings on a specified backed up volume. To disable backup on a volume, the volume snapshots must be deleted. + +**Token usage:**NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|volumeId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + diff --git a/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot-.adoc b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot-.adoc new file mode 100644 index 00000000..e03b5915 --- /dev/null +++ b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot-.adoc @@ -0,0 +1,98 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot-.html' +summary: 'Delete a snapshot' +--- + += Delete a snapshot + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}`# + + + +Deletes a specified snapshot of a specified volume backed up using the NetApp Backup and Recovery service for a system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|volumeId +|string +|path +|True +a| + +|snapshotId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|state +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "state": "string" +} +==== + diff --git a/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot.adoc b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot.adoc new file mode 100644 index 00000000..634d3547 --- /dev/null +++ b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot.adoc @@ -0,0 +1,115 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot.html' +summary: 'Delete all snapshots (volume)' +--- + += Delete all snapshots (volume) + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot`# + + + +Deletes all the snapshots for a specified volume backed up by using the NetApp Backup and Recovery service for a system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|force +|boolean +|query +|False +a|If set to true, all the metadata for the snapshots will be cleaned from the database. Please check if the snapshots are in the object store and then clean them. + +* Default value: + + +|remove-object-store-config +|boolean +|query +|False +a|If set to true, the object store configuration that is not being used by any volume will be cleaned up from the system. + +* Default value: + + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|volumeId +|string +|path +|True +a|File system ID/Volume ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + diff --git a/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy-.adoc b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy-.adoc new file mode 100644 index 00000000..ae8337fe --- /dev/null +++ b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy-.adoc @@ -0,0 +1,69 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy-.html' +summary: 'Delete a backup policy' +--- + += Delete a backup policy + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy/{policyId}`# + + + +Deletes the backup policies associated with a system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|policyId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + + diff --git a/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy-.adoc b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy-.adoc new file mode 100644 index 00000000..dd80a226 --- /dev/null +++ b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy-.adoc @@ -0,0 +1,69 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy-.html' +summary: 'Delete a replication policy' +--- + += Delete a replication policy + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy/{policyId}`# + + + +Deletes the SnapMirror policies created on the cluster level for the specified system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|policyId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + + diff --git a/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policies-.adoc b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policies-.adoc new file mode 100644 index 00000000..e1e2dd14 --- /dev/null +++ b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policies-.adoc @@ -0,0 +1,69 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policies-.html' +summary: 'Delete a snapshot policy using the UUID' +--- + += Delete a snapshot policy using the UUID + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policies/{policyId}`# + + + +Deletes the snapshot policy for the specified system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|policyId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + + diff --git a/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot-.adoc b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot-.adoc new file mode 100644 index 00000000..6f1b080d --- /dev/null +++ b/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot-.adoc @@ -0,0 +1,98 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot-.html' +summary: 'Delete a snapshot for a volume' +--- + += Delete a snapshot for a volume + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}`# + + + +Deletes a snapshot of a volume. The API deletes a specific snapshot of a particular volume belonging to a specific system. The system ID, volume ID, and snapshot ID are passed as parameters for the REST API call. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|volumeId +|string +|path +|True +a| + +|snapshotId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + diff --git a/cbs/delete-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-snapshot.adoc b/cbs/delete-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-snapshot.adoc new file mode 100644 index 00000000..54769974 --- /dev/null +++ b/cbs/delete-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-snapshot.adoc @@ -0,0 +1,108 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/delete-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-snapshot.html' +summary: 'Delete all snapshots (system)' +--- + += Delete all snapshots (system) + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment/{workingEnvironmentId}/snapshot`# + + + +Deletes all snapshots for a specified system that are backed up using the NetApp Backup and Recovery service (V2 version). + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|remove-object-store-config +|boolean +|query +|False +a|If set to true, the object store configuration which is not being used by any volume (other than the current volume being processed) will be cleaned up from the system. + +* Default value: + + +|force +|boolean +|query +|False +a|If set to true, all metadata for the snapshots will be removed from the database without waiting for the deletion of backups from the object store. Snapshot data in the object store might not be deleted automatically; you must manually verify and remove the data. + +* Default value: + + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + diff --git a/cbs/delete-account-providers-cloudmanager_cbs-api-v2-gcp-credentials-.adoc b/cbs/delete-account-providers-cloudmanager_cbs-api-v2-gcp-credentials-.adoc new file mode 100644 index 00000000..5a827d74 --- /dev/null +++ b/cbs/delete-account-providers-cloudmanager_cbs-api-v2-gcp-credentials-.adoc @@ -0,0 +1,63 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/delete-account-providers-cloudmanager_cbs-api-v2-gcp-credentials-.html' +summary: 'Delete Google Cloud credentials' +--- + += Delete Google Cloud credentials + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials/{credentialsId}`# + + + +Deletes the Google Cloud credentials for a Google Cloud project in the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|credentialsId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 204, Default response +``` + + + diff --git a/cbs/delete-account-providers-cloudmanager_cbs-api-v2-sg-credentials-.adoc b/cbs/delete-account-providers-cloudmanager_cbs-api-v2-sg-credentials-.adoc new file mode 100644 index 00000000..71d1bcba --- /dev/null +++ b/cbs/delete-account-providers-cloudmanager_cbs-api-v2-sg-credentials-.adoc @@ -0,0 +1,63 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/delete-account-providers-cloudmanager_cbs-api-v2-sg-credentials-.html' +summary: 'Delete StorageGRID credentials' +--- + += Delete StorageGRID credentials + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/sg/credentials/{storageServerName}`# + + + +Deletes StorageGRID credentials in the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|storageServerName +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 204, Default response +``` + + + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-account.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-account.adoc new file mode 100644 index 00000000..c98313bc --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-account.adoc @@ -0,0 +1,82 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-account.html' +summary: 'Retrieve AWS accounts' +--- + += Retrieve AWS accounts + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/account`# + + + +Retrieves a list of AWS accounts from the NetApp Console. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|account +|array[string] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "account": [ + "string" + ] +} +==== + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-archival-storage-class.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-archival-storage-class.adoc new file mode 100644 index 00000000..bd2651f1 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-archival-storage-class.adoc @@ -0,0 +1,82 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-archival-storage-class.html' +summary: 'Retrieve AWS storage classes' +--- + += Retrieve AWS storage classes + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/archival-storage-class`# + + + +Retrieves a list of AWS storage classes available for archival support. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-class +|array[string] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "storage-class": [ + "string" + ] +} +==== + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-buckets-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-buckets-.adoc new file mode 100644 index 00000000..a33f4ab7 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-buckets-.adoc @@ -0,0 +1,148 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-buckets-.html' +summary: 'Retrieve an AWS S3 bucket from a region' +--- + += Retrieve an AWS S3 bucket from a region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/buckets/{bucketName}`# + + + +Retrieves a specific AWS S3 bucket from a specified region that belongs to a specified AWS account ID from the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|fields +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|awsAccountId +|string +|path +|True +a| + +|bucketName +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|buckets +|array[link:#buckets[buckets]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "buckets": [ + { + "name": "string", + "region": "string", + "is-encrypted": "string", + "is-public": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#buckets] +[.api-collapsible-fifth-title] +buckets + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|region +|string +|False +a| + +|is-encrypted +|string +|False +a| + +|is-public +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-buckets.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-buckets.adoc new file mode 100644 index 00000000..7c403ab8 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-buckets.adoc @@ -0,0 +1,142 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-buckets.html' +summary: 'Retrieve a list of AWS S3 buckets from a region' +--- + += Retrieve a list of AWS S3 buckets from a region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/buckets`# + + + +Retrieves a list of AWS S3 buckets from a specified region that belongs to a specified AWS account ID from the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|fields +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|awsAccountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|buckets +|array[link:#buckets[buckets]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "buckets": [ + { + "name": "string", + "region": "string", + "is-encrypted": "string", + "is-public": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#buckets] +[.api-collapsible-fifth-title] +buckets + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|region +|string +|False +a| + +|is-encrypted +|string +|False +a| + +|is-public +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-region-key.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-region-key.adoc new file mode 100644 index 00000000..c2fab8af --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-region-key.adoc @@ -0,0 +1,136 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-region-key.html' +summary: 'Retrieve AWS keys' +--- + += Retrieve AWS keys + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/region/{regionCode}/key`# + + + +Retrieves a list of AWS keys from a specified region that belongs to a specified AWS account ID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|regionCode +|string +|path +|True +a| + +|awsAccountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|array[link:#key[key]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "key": [ + { + "name": "string", + "id": "string", + "origin": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#key] +[.api-collapsible-fifth-title] +key + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|origin +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-region-privatelink.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-region-privatelink.adoc new file mode 100644 index 00000000..7a2c4937 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-region-privatelink.adoc @@ -0,0 +1,142 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-region-privatelink.html' +summary: 'Retrieve AWS private links' +--- + += Retrieve AWS private links + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/region/{regionCode}/privateLink`# + + + +Retrieves a list of AWS private links from a specified region that belongs to a specified AWS account ID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|regionCode +|string +|path +|True +a| + +|awsAccountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|privateLink +|array[link:#privateLink[privateLink]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "privateLink": [ + { + "vpc-name": "string", + "vpc-id": "string", + "private-endpoint-id": "string", + "private-endpoint-name": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#privateLink] +[.api-collapsible-fifth-title] +privateLink + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpc-name +|string +|False +a| + +|vpc-id +|string +|False +a| + +|private-endpoint-id +|string +|False +a| + +|private-endpoint-name +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-region.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-region.adoc new file mode 100644 index 00000000..66a6ac67 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-region.adoc @@ -0,0 +1,118 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-region.html' +summary: 'Retrieve subscribed AWS regions' +--- + += Retrieve subscribed AWS regions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/region`# + + + +Retrieves a list of subscribed AWS regions. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|array[link:#region[region]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": [ + { + "name": "string", + "code": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#region] +[.api-collapsible-fifth-title] +region + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|code +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-region.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-region.adoc new file mode 100644 index 00000000..e30e4904 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-region.adoc @@ -0,0 +1,124 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-region.html' +summary: 'Retrieve regions' +--- + += Retrieve regions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/region`# + + + +Retrieves a list of regions from a specific subscription ID in Azure. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|subscriptionId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|array[link:#region[region]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": [ + { + "name": "string", + "code": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#region] +[.api-collapsible-fifth-title] +region + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|code +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resource-group.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resource-group.adoc new file mode 100644 index 00000000..923e3a2a --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resource-group.adoc @@ -0,0 +1,136 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resource-group.html' +summary: 'Retrieve Azure resource groups' +--- + += Retrieve Azure resource groups + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resource-group`# + + + +Retrieves a list of Azure resource groups from a specific subscription ID in Azure. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|subscriptionId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resource-group +|array[link:#resource-group[resource-group]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "resource-group": [ + { + "name": "string", + "id": "string", + "region": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#resource-group] +[.api-collapsible-fifth-title] +resource-group + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resourcegroup-storageaccounts-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resourcegroup-storageaccounts-.adoc new file mode 100644 index 00000000..833cef4f --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resourcegroup-storageaccounts-.adoc @@ -0,0 +1,154 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resourcegroup-storageaccounts-.html' +summary: 'Retrieve a specific Azure storage account for a subscription ID' +--- + += Retrieve a specific Azure storage account for a subscription ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resourceGroup/{resourceGroup}/storageAccounts/{storageAccountName}`# + + + +Retrieves a specific Azure storage account for a specific subscription ID in a resource group in Azure cloud from the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|fields +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|subscriptionId +|string +|path +|True +a| + +|resourceGroup +|string +|path +|True +a| + +|storageAccountName +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storageAccounts +|array[link:#storageAccounts[storageAccounts]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "storageAccounts": [ + { + "name": "string", + "is-encrypted": "string", + "is-public": "string", + "region": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#storageAccounts] +[.api-collapsible-fifth-title] +storageAccounts + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|is-encrypted +|string +|False +a| + +|is-public +|string +|False +a| + +|region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resourcegroup-storageaccounts.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resourcegroup-storageaccounts.adoc new file mode 100644 index 00000000..07733209 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resourcegroup-storageaccounts.adoc @@ -0,0 +1,148 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resourcegroup-storageaccounts.html' +summary: 'Retrieve a list of Azure storage accounts for a subscription ID' +--- + += Retrieve a list of Azure storage accounts for a subscription ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resourceGroup/{resourceGroup}/storageAccounts`# + + + +Retrieves a list of Azure storage accounts for a specific subscription ID in a resource group in Azure cloud from the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|fields +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|subscriptionId +|string +|path +|True +a| + +|resourceGroup +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storageAccounts +|array[link:#storageAccounts[storageAccounts]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "storageAccounts": [ + { + "name": "string", + "is-encrypted": "string", + "is-public": "string", + "region": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#storageAccounts] +[.api-collapsible-fifth-title] +storageAccounts + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|is-encrypted +|string +|False +a| + +|is-public +|string +|False +a| + +|region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vault-key.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vault-key.adoc new file mode 100644 index 00000000..a635b6de --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vault-key.adoc @@ -0,0 +1,130 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vault-key.html' +summary: 'Retrieve Azure vault keys' +--- + += Retrieve Azure vault keys + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vault/{vaultName}/key`# + + + +Retrieves a list of Azure vault keys from a particular vault for a specific subscription ID in Azure cloud. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|subscriptionId +|string +|path +|True +a| + +|vaultName +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|array[link:#key[key]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "key": [ + { + "name": "string", + "id": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#key] +[.api-collapsible-fifth-title] +key + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vault.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vault.adoc new file mode 100644 index 00000000..27a2e2a4 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vault.adoc @@ -0,0 +1,130 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vault.html' +summary: 'Retrieve Azure vaults' +--- + += Retrieve Azure vaults + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vault`# + + + +Retrieves a list of Azure vaults for a specific subscription ID in Azure cloud. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|subscriptionId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vault +|array[link:#vault[vault]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "vault": [ + { + "name": "string", + "id": "string", + "region": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#vault] +[.api-collapsible-fifth-title] +vault + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vnet.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vnet.adoc new file mode 100644 index 00000000..a996a4ee --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vnet.adoc @@ -0,0 +1,171 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vnet.html' +summary: 'Retrieve Azure virtual networks' +--- + += Retrieve Azure virtual networks + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vnet`# + + + +Retrieves a list of Azure virtual networks from a specific subscription ID in Azure cloud. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|subscriptionId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vnet +|array[link:#vnet[vnet]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "vnet": [ + { + "name": "string", + "id": "string", + "region": "string", + "subnet": [ + { + "name": "string", + "id": "string" + } + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#subnet] +[.api-collapsible-fifth-title] +subnet + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|=== + + +[#vnet] +[.api-collapsible-fifth-title] +vnet + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|region +|string +|False +a| + +|subnet +|array[link:#subnet[subnet]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription.adoc new file mode 100644 index 00000000..b89d3e10 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription.adoc @@ -0,0 +1,118 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription.html' +summary: 'Retrieve Azure subscriptions' +--- + += Retrieve Azure subscriptions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription`# + + + +Retrieves a list of Azure subscriptions for a particular account. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|array[link:#subscription[subscription]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "subscription": [ + { + "name": "string", + "id": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#subscription] +[.api-collapsible-fifth-title] +subscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-snapshot.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-snapshot.adoc new file mode 100644 index 00000000..c6df075a --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-snapshot.adoc @@ -0,0 +1,156 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-snapshot.html' +summary: 'Retrieve a list of snapshots using the account ID' +--- + += Retrieve a list of snapshots using the account ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/snapshot`# + + + +Retrieves snapshot information for a specified account by using the account ID. This API endpoint retrieves the details of the snapshots from the NetApp Console SaaS application. It retrieves the snapshot name, snapshot creation time, archive status, and size. It also retrieves the object-lock, ransomware-scan-status-failure, and ransomware-scan-status. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshot +|array[link:#snapshot[snapshot]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshot": [ + { + "id": "string", + "name": "string", + "object-lock": "string", + "ransomware-scan-status-failure": "string", + "ransomware-scan-status": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#snapshot] +[.api-collapsible-fifth-title] +snapshot + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|creation-time +|number +|False +a| + +|size +|number +|False +a| + +|last-ransomware-scan +|number +|False +a| + +|object-lock +|string +|False +a| + +|ransomware-scan-status-failure +|string +|False +a| + +|archived +|boolean +|False +a| + +|ransomware-scan-status +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.adoc new file mode 100644 index 00000000..73753c01 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.adoc @@ -0,0 +1,620 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.html' +summary: 'Retrieve specific system details' +--- + += Retrieve specific system details + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}`# + + + +Retrieves the details of a specific system backed up by using the NetApp Backup and Recovery service within an account. It retrieves backup enablement status, archive storage class, archive after days, catalog enablement status, auto enablement status, maximum transfer status, backup policy details, cloud storage pool, and remote MetroCluster ID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|partial +|boolean +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|region +|string +|False +a| + +|status +|string +|False +a| + +|ontap-version +|string +|False +a| + +|backup-enablement-status +|string +|False +a| + +|type +|string +|False +a| + +|provider +|string +|False +a| + +|provider-account-id +|string +|False +a| + +|provider-account-name +|string +|False +a| + +|bucket +|string +|False +a| + +|archive-storage-class +|string +|False +a| + +|resource-group +|string +|False +a| + +|storage-account +|string +|False +a| + +|storage-server +|string +|False +a| + +|used-capacity-gb +|string +|False +a| + +|charging-capacity +|string +|False +a| + +|logical-used-size +|string +|False +a| + +|backed-up-volume-count +|string +|False +a| + +|total-volumes-count +|string +|False +a| + +|backup-policy-count +|string +|False +a| + +|failed-backup-volume-count +|string +|False +a| + +|catalog-enabled +|boolean +|False +a| + +|object-lock +|string +|False +a| + +|auto-backup-enabled +|boolean +|False +a| + +|max-transfer-rate +|number +|False +a| + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|private-endpoint-required +|boolean +|False +a| + +|license +|link:#license[license] +|False +a| + +|ip-space +|string +|False +a| + +|provider-access-key +|string +|False +a| + +|delete-yearly-snapshots +|boolean +|False +a| + +|export-existing-snapshots +|boolean +|False +a| + +|storage-grid-id +|string +|False +a| + +|sgws-archival +|link:#sgws-archival[sgws-archival] +|False +a| + +|remote-mcc-id +|string +|False +a| + +|architecture +|string +|False +a| + +|snapshot-policy +|string +|False +a| + +|replication-target +|link:#replication-target[replication-target] +|False +a| + +|fix-mismatch-labels +|boolean +|False +a| + +|rsw-scheduled-scan +|boolean +|False +a| + +|object-store-size +|link:#object-store-size[object-store-size] +|False +a| + +|cmek +|link:#cmek[cmek] +|False +a| + +|rsw-scan-interval +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "id": "string", + "region": "string", + "status": "string", + "ontap-version": "string", + "backup-enablement-status": "string", + "type": "string", + "provider": "string", + "provider-account-id": "string", + "provider-account-name": "string", + "bucket": "string", + "archive-storage-class": "string", + "resource-group": "string", + "storage-account": "string", + "storage-server": "string", + "used-capacity-gb": "string", + "charging-capacity": "string", + "logical-used-size": "string", + "backed-up-volume-count": "string", + "total-volumes-count": "string", + "backup-policy-count": "string", + "failed-backup-volume-count": "string", + "object-lock": "string", + "backup-policy": { + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "archive-after-days": "string" + }, + "ip-space": "string", + "provider-access-key": "string", + "storage-grid-id": "string", + "sgws-archival": { + "cloud-storage-pool": { + "provider": "string", + "provider-account-id": "string", + "region": "string", + "access-key": "string", + "archive-storage-class": "string" + } + }, + "remote-mcc-id": "string", + "architecture": "string", + "snapshot-policy": "string", + "replication-target": { + "id": "string", + "name": "string", + "policy-name": "string", + "prefix": "string", + "suffix": "string", + "svm": "string", + "aggregates": [ + "string" + ] + }, + "rsw-scan-interval": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|rule +|array[link:#rule[rule]] +|False +a| + +|archive-after-days +|string +|False +a| + +|=== + + +[#license] +[.api-collapsible-fifth-title] +license + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|free-trial-end +|number +|False +a| + +|eligible +|boolean +|False +a| + +|=== + + +[#cloud-storage-pool] +[.api-collapsible-fifth-title] +cloud-storage-pool + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provider +|string +|True +a|Cloud provider where the cloud storage pool is hosted + + +|provider-account-id +|string +|True +a|Cloud provider account ID where the cloud storage pool is hosted + + +|region +|string +|True +a|Cloud provider region where the cloud storage pool is hosted + + +|access-key +|string +|False +a| + +|archive-storage-class +|string +|False +a|Storage class of a cloud storage pool to store archived objects + + +|=== + + +[#sgws-archival] +[.api-collapsible-fifth-title] +sgws-archival + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloud-storage-pool +|link:#cloud-storage-pool[cloud-storage-pool] +|False +a| + +|=== + + +[#replication-target] +[.api-collapsible-fifth-title] +replication-target + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|policy-name +|string +|False +a| + +|prefix +|string +|False +a| + +|suffix +|string +|False +a| + +|svm +|string +|False +a| + +|aggregates +|array[string] +|False +a| + +|=== + + +[#object-store-size] +[.api-collapsible-fifth-title] +object-store-size + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|standard +|number +|False +a| + +|archive +|number +|False +a| + +|=== + + +[#keyDetails] +[.api-collapsible-fifth-title] +keyDetails + +JSON data containing data specific to Customer Managed Encryption Keys + + + +[#cmek] +[.api-collapsible-fifth-title] +cmek + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|enabled +|boolean +|False +a| + +|keyDetails +|link:#keyDetails[keyDetails] +|False +a|JSON data containing data specific to Customer Managed Encryption Keys + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-snapshot.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-snapshot.adoc new file mode 100644 index 00000000..3bdf207e --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-snapshot.adoc @@ -0,0 +1,198 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-snapshot.html' +summary: 'Retrieve snapshot information for a volume' +--- + += Retrieve snapshot information for a volume + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/snapshot`# + + + +Retrieves snapshot information for a specified volume backed up using NetApp Backup and Recovery for a system. This API endpoint retrieves the details of the volume snapshots from the NetApp Console SaaS application. It retrieves the snapshot name, snapshot creation time, archive status, and size. It also retrieves the object-lock, ransomware-scan-status-failure, and ransomware-scan-status details. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|svm +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshot +|array[link:#snapshot[snapshot]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshot": [ + { + "id": "string", + "name": "string", + "object-lock": "string", + "ransomware-scan-status-failure": "string", + "ransomware-scan-status": "string", + "volume-id": "string", + "volume-name": "string", + "working-environment-id": "string", + "working-environment-name": "string", + "svm": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#snapshot] +[.api-collapsible-fifth-title] +snapshot + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|creation-time +|number +|False +a| + +|size +|number +|False +a| + +|last-ransomware-scan +|number +|False +a| + +|object-lock +|string +|False +a| + +|ransomware-scan-status-failure +|string +|False +a| + +|archived +|boolean +|False +a| + +|ransomware-scan-status +|string +|False +a| + +|volume-id +|string +|False +a| + +|volume-name +|string +|False +a| + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|svm +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-status.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-status.adoc new file mode 100644 index 00000000..6a5fbcc4 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-status.adoc @@ -0,0 +1,361 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-status.html' +summary: 'Retrieve the backup status' +--- + += Retrieve the backup status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/status`# + + + +Retrieves the backup status of a specified system backed up by using the NetApp Backup and Recovery service within an account. It retrieves backup enablement status, archive storage class, archive after days, catalog enablement status, auto enablement status, maximum transfer status, backup policy details, cloud storage pool, and remote MetroCluster ID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|partial +|boolean +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|region +|string +|False +a| + +|status +|string +|False +a| + +|ontap-version +|string +|False +a| + +|backup-enablement-status +|string +|False +a| + +|type +|string +|False +a| + +|provider +|string +|False +a| + +|provider-account-id +|string +|False +a| + +|provider-account-name +|string +|False +a| + +|bucket +|string +|False +a| + +|archive-storage-class +|string +|False +a| + +|resource-group +|string +|False +a| + +|storage-account +|string +|False +a| + +|storage-server +|string +|False +a| + +|used-capacity-gb +|string +|False +a| + +|charging-capacity +|string +|False +a| + +|logical-used-size +|string +|False +a| + +|backed-up-volume-count +|string +|False +a| + +|total-volumes-count +|string +|False +a| + +|backup-policy-count +|string +|False +a| + +|failed-backup-volume-count +|string +|False +a| + +|catalog-enabled +|boolean +|False +a| + +|auto-backup-enabled +|boolean +|False +a| + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|private-endpoint-required +|boolean +|False +a| + +|license +|link:#license[license] +|False +a| + +|ip-space +|string +|False +a| + +|provider-access-key +|string +|False +a| + +|delete-yearly-snapshots +|boolean +|False +a| + +|export-existing-snapshots +|boolean +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "id": "string", + "region": "string", + "status": "string", + "ontap-version": "string", + "backup-enablement-status": "string", + "type": "string", + "provider": "string", + "provider-account-id": "string", + "provider-account-name": "string", + "bucket": "string", + "archive-storage-class": "string", + "resource-group": "string", + "storage-account": "string", + "storage-server": "string", + "used-capacity-gb": "string", + "charging-capacity": "string", + "logical-used-size": "string", + "backed-up-volume-count": "string", + "total-volumes-count": "string", + "backup-policy-count": "string", + "failed-backup-volume-count": "string", + "backup-policy": { + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "archive-after-days": "string" + }, + "ip-space": "string", + "provider-access-key": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|rule +|array[link:#rule[rule]] +|False +a| + +|archive-after-days +|string +|False +a| + +|=== + + +[#license] +[.api-collapsible-fifth-title] +license + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|free-trial-end +|number +|False +a| + +|eligible +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.adoc new file mode 100644 index 00000000..b4297d78 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.adoc @@ -0,0 +1,351 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.html' +summary: 'Retrieve volume information' +--- + += Retrieve volume information + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}`# + + + +Retrieves information for a specified volume backed up by using the NetApp Backup and Recovery service. It retrieves the details of the volume from the NetApp Console SaaS application. It retrieves the archive after days, backup status, relationship policy name, and capacity details. It also retrieves details of the archive after days, object lock, ransomware scan status, last ransomware scan, and ransomware detected snapshots with last ransomware scan information. + +**Token usage:**NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|volumeId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|file-system-id +|string +|False +a| + +|name +|string +|False +a| + +|protocol +|string +|False +a| + +|svm +|string +|False +a| + +|status +|string +|False +a| + +|backup-status +|string +|False +a| + +|last-backup-creation-time +|number +|False +a| + +|snapshot-count +|string +|False +a| + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|lag +|string +|False +a| + +|capacity +|link:#capacity[capacity] +|False +a| + +|type +|string +|False +a| + +|snaplock-type +|string +|False +a| + +|style +|string +|False +a| + +|object-lock +|string +|False +a| + +|ransomware-scan-status +|string +|False +a| + +|last-ransomware-scan +|number +|False +a| + +|ransomware-detected-snapshots +|array[link:#ransomware-detected-snapshots[ransomware-detected-snapshots]] +|False +a| + +|geometry +|number +|False +a| + +|aggregate-count +|number +|False +a| + +|cbsChargingEnabled +|boolean +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "file-system-id": "string", + "name": "string", + "protocol": "string", + "svm": "string", + "status": "string", + "backup-status": "string", + "snapshot-count": "string", + "backup-policy": { + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "archive-after-days": "string" + }, + "lag": "string", + "capacity": { + "allocated": "string", + "used": "string", + "charging": "string", + "logicalUsedSize": "string" + }, + "type": "string", + "snaplock-type": "string", + "style": "string", + "object-lock": "string", + "ransomware-scan-status": "string", + "ransomware-detected-snapshots": [ + { + "snapshot-id": "string", + "snapshot-name": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|rule +|array[link:#rule[rule]] +|False +a| + +|archive-after-days +|string +|False +a| + +|=== + + +[#capacity] +[.api-collapsible-fifth-title] +capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|allocated +|string +|False +a| + +|used +|string +|False +a| + +|charging +|string +|False +a| + +|logicalUsedSize +|string +|False +a| + +|=== + + +[#ransomware-detected-snapshots] +[.api-collapsible-fifth-title] +ransomware-detected-snapshots + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshot-id +|string +|False +a| + +|snapshot-name +|string +|False +a| + +|last-ransomware-scan +|number +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot-.adoc new file mode 100644 index 00000000..726a94a0 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot-.adoc @@ -0,0 +1,172 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot-.html' +summary: 'Retrieve specific snapshot information for a volume' +--- + += Retrieve specific snapshot information for a volume + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}`# + + + +Retrieves information of a particular snapshot for a specified volume backed up by using the NetApp Backup and Recovery service for a system. This API endpoint retrieves the details of the volume snapshots from the NetApp Console SaaS application. It retrieves the snapshot name, snapshot creation time, archive status, and size. It also retrieves the object-lock, ransomware-scan-status-failure, and ransomware-scan-status. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|volumeId +|string +|path +|True +a| + +|snapshotId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|creation-time +|number +|False +a| + +|archived +|boolean +|False +a| + +|size +|number +|False +a| + +|last-ransomware-scan +|number +|False +a| + +|object-lock +|string +|False +a| + +|ransomware-scan-status-failure +|string +|False +a| + +|ransomware-scan-status +|string +|False +a| + +|volume-id +|string +|False +a| + +|volume-name +|string +|False +a| + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|svm +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "string", + "name": "string", + "object-lock": "string", + "ransomware-scan-status-failure": "string", + "ransomware-scan-status": "string", + "volume-id": "string", + "volume-name": "string", + "working-environment-id": "string", + "working-environment-name": "string", + "svm": "string" +} +==== + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot.adoc new file mode 100644 index 00000000..bca3696f --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot.adoc @@ -0,0 +1,198 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot.html' +summary: 'Retrieve snapshot information for a volume' +--- + += Retrieve snapshot information for a volume + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot`# + + + +Retrieves snapshot information for a specified volume backed up using the NetApp Backup and Recovery service for a system. This API endpoint retrieves the details of the volume snapshots from the NetApp Console SaaS application. It retrieves the snapshot name, snapshot creation time, archive status, and size. It also retrieves the object-lock, ransomware-scan-status-failure, and ransomware-scan-status details. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|volumeId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshot +|array[link:#snapshot[snapshot]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshot": [ + { + "id": "string", + "name": "string", + "object-lock": "string", + "ransomware-scan-status-failure": "string", + "ransomware-scan-status": "string", + "volume-id": "string", + "volume-name": "string", + "working-environment-id": "string", + "working-environment-name": "string", + "svm": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#snapshot] +[.api-collapsible-fifth-title] +snapshot + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|creation-time +|number +|False +a| + +|size +|number +|False +a| + +|last-ransomware-scan +|number +|False +a| + +|object-lock +|string +|False +a| + +|ransomware-scan-status-failure +|string +|False +a| + +|archived +|boolean +|False +a| + +|ransomware-scan-status +|string +|False +a| + +|volume-id +|string +|False +a| + +|volume-name +|string +|False +a| + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|svm +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume.adoc new file mode 100644 index 00000000..319d65ca --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume.adoc @@ -0,0 +1,374 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume.html' +summary: 'Retrieve volume details' +--- + += Retrieve volume details + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume`# + + + +Retrieves details of all the volumes for a specified system backed up by using the NetApp Backup and Recovery service. It retrieves the volume name, volume type, protocol, storage VM, backup status, last backup creation time, snapshot count, associated backup policy, and backup policy rules. It also retrieves details of the archive after days, object lock, ransomware scan status, last ransomware scan, and ransomware detected snapshots with last ransomware scan information. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|partial +|boolean +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volume +|array[link:#volume[volume]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "volume": [ + { + "file-system-id": "string", + "name": "string", + "type": "string", + "style": "string", + "protocol": "string", + "svm": "string", + "status": "string", + "backup-status": "string", + "snapshot-count": "string", + "backup-policy": { + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "archive-after-days": "string" + }, + "snaplock-type": "string", + "lag": "string", + "capacity": { + "allocated": "string", + "used": "string", + "charging": "string", + "logicalUsedSize": "string" + }, + "object-lock": "string", + "ransomware-scan-status": "string", + "ransomware-detected-snapshots": [ + { + "snapshot-id": "string", + "snapshot-name": "string" + } + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|rule +|array[link:#rule[rule]] +|False +a| + +|archive-after-days +|string +|False +a| + +|=== + + +[#capacity] +[.api-collapsible-fifth-title] +capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|allocated +|string +|False +a| + +|used +|string +|False +a| + +|charging +|string +|False +a| + +|logicalUsedSize +|string +|False +a| + +|=== + + +[#ransomware-detected-snapshots] +[.api-collapsible-fifth-title] +ransomware-detected-snapshots + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshot-id +|string +|False +a| + +|snapshot-name +|string +|False +a| + +|last-ransomware-scan +|number +|False +a| + +|=== + + +[#volume] +[.api-collapsible-fifth-title] +volume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|file-system-id +|string +|False +a| + +|name +|string +|False +a| + +|type +|string +|False +a| + +|style +|string +|False +a| + +|protocol +|string +|False +a| + +|svm +|string +|False +a| + +|status +|string +|False +a| + +|backup-status +|string +|False +a| + +|last-backup-creation-time +|number +|False +a| + +|snapshot-count +|string +|False +a| + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|snaplock-type +|string +|False +a| + +|lag +|string +|False +a| + +|capacity +|link:#capacity[capacity] +|False +a| + +|object-lock +|string +|False +a| + +|ransomware-scan-status +|string +|False +a| + +|last-ransomware-scan +|number +|False +a| + +|ransomware-detected-snapshots +|array[link:#ransomware-detected-snapshots[ransomware-detected-snapshots]] +|False +a| + +|geometry +|number +|False +a| + +|aggregate-count +|number +|False +a| + +|cbsChargingEnabled +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment.adoc new file mode 100644 index 00000000..fb732237 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment.adoc @@ -0,0 +1,660 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment.html' +summary: 'Retrieve system details' +--- + += Retrieve system details + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment`# + + + +Retrieves the details of all systems that are backed up using the NetApp Backup and Recovery service within an account. It retrieves the backup enablement status, archive storage class, archive after days, catalog enablement status, auto enablement status, maximum transfer status, backup policy details, cloud storage pool, and remote MetroCluster ID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|partial +|boolean +|query +|False +a|Returns only a partial response for the systems + + +|object-store-details +|boolean +|query +|False +a|A filter to include/exclude fields named provider-access-key and ip-space + +* Default value: 1 + + +|capacity-details +|boolean +|query +|False +a|A filter to include/exclude fields named used-capacity-gb, charging-capacity,logical-used-size,backed-up-volume-count + +* Default value: 1 + + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment +|array[link:#working-environment[working-environment]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "working-environment": [ + { + "name": "string", + "id": "string", + "clusterId": "string", + "region": "string", + "status": "string", + "ontap-version": "string", + "backup-enablement-status": "string", + "type": "string", + "provider": "string", + "provider-account-id": "string", + "provider-account-name": "string", + "bucket": "string", + "archive-storage-class": "string", + "resource-group": "string", + "storage-account": "string", + "storage-server": "string", + "used-capacity-gb": "string", + "charging-capacity": "string", + "logical-used-size": "string", + "backed-up-volume-count": "string", + "total-volumes-count": "string", + "backup-policy-count": "string", + "failed-backup-volume-count": "string", + "object-lock": "string", + "backup-policy": { + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "archive-after-days": "string" + }, + "ip-space": "string", + "provider-access-key": "string", + "storage-grid-id": "string", + "sgws-archival": { + "cloud-storage-pool": { + "provider": "string", + "provider-account-id": "string", + "region": "string", + "access-key": "string", + "archive-storage-class": "string" + } + }, + "remote-mcc-id": "string", + "architecture": "string", + "snapshot-policy": "string", + "replication-target": { + "id": "string", + "name": "string", + "policy-name": "string", + "prefix": "string", + "suffix": "string", + "svm": "string", + "aggregate": [ + "string" + ] + }, + "rsw-scan-interval": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|rule +|array[link:#rule[rule]] +|False +a| + +|archive-after-days +|string +|False +a| + +|=== + + +[#license] +[.api-collapsible-fifth-title] +license + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|free-trial-end +|number +|False +a| + +|eligible +|boolean +|False +a| + +|=== + + +[#cloud-storage-pool] +[.api-collapsible-fifth-title] +cloud-storage-pool + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provider +|string +|True +a|Cloud provider where the cloud storage pool is hosted + + +|provider-account-id +|string +|True +a|Cloud provider account ID where the cloud storage pool is hosted + + +|region +|string +|True +a|Cloud provider region where the cloud storage pool is hosted + + +|access-key +|string +|False +a| + +|archive-storage-class +|string +|False +a|Storage class of a cloud storage pool to store archived objects + + +|=== + + +[#sgws-archival] +[.api-collapsible-fifth-title] +sgws-archival + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloud-storage-pool +|link:#cloud-storage-pool[cloud-storage-pool] +|False +a| + +|=== + + +[#replication-target] +[.api-collapsible-fifth-title] +replication-target + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|policy-name +|string +|False +a| + +|prefix +|string +|False +a| + +|suffix +|string +|False +a| + +|svm +|string +|False +a| + +|aggregate +|array[string] +|False +a| + +|=== + + +[#object-store-size] +[.api-collapsible-fifth-title] +object-store-size + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|standard +|number +|False +a| + +|archive +|number +|False +a| + +|=== + + +[#keyDetails] +[.api-collapsible-fifth-title] +keyDetails + +JSON data containing data specific to Customer Managed Encryption Keys + + + +[#cmek] +[.api-collapsible-fifth-title] +cmek + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|enabled +|boolean +|False +a| + +|keyDetails +|link:#keyDetails[keyDetails] +|False +a|JSON data containing data specific to Customer Managed Encryption Keys + + +|=== + + +[#working-environment] +[.api-collapsible-fifth-title] +working-environment + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|clusterId +|string +|False +a| + +|region +|string +|False +a| + +|status +|string +|False +a| + +|ontap-version +|string +|False +a| + +|backup-enablement-status +|string +|False +a| + +|type +|string +|False +a| + +|provider +|string +|False +a| + +|provider-account-id +|string +|False +a| + +|provider-account-name +|string +|False +a| + +|bucket +|string +|False +a| + +|archive-storage-class +|string +|False +a| + +|resource-group +|string +|False +a| + +|storage-account +|string +|False +a| + +|storage-server +|string +|False +a| + +|used-capacity-gb +|string +|False +a| + +|charging-capacity +|string +|False +a| + +|logical-used-size +|string +|False +a| + +|backed-up-volume-count +|string +|False +a| + +|total-volumes-count +|string +|False +a| + +|backup-policy-count +|string +|False +a| + +|failed-backup-volume-count +|string +|False +a| + +|catalog-enabled +|boolean +|False +a| + +|object-lock +|string +|False +a| + +|max-transfer-rate +|number +|False +a| + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|private-endpoint-required +|boolean +|False +a| + +|license +|link:#license[license] +|False +a| + +|ip-space +|string +|False +a| + +|provider-access-key +|string +|False +a| + +|delete-yearly-snapshots +|boolean +|False +a| + +|export-existing-snapshots +|boolean +|False +a| + +|storage-grid-id +|string +|False +a| + +|sgws-archival +|link:#sgws-archival[sgws-archival] +|False +a| + +|remote-mcc-id +|string +|False +a| + +|architecture +|string +|False +a| + +|snapshot-policy +|string +|False +a| + +|replication-target +|link:#replication-target[replication-target] +|False +a| + +|fix-mismatch-labels +|boolean +|False +a| + +|rsw-scheduled-scan +|boolean +|False +a| + +|rsw-scan-interval +|string +|False +a| + +|object-store-size +|link:#object-store-size[object-store-size] +|False +a| + +|cmek +|link:#cmek[cmek] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-catalog-search-job.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-catalog-search-job.adoc new file mode 100644 index 00000000..e81ac36b --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-catalog-search-job.adoc @@ -0,0 +1,209 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-catalog-search-job.html' +summary: 'Search for a specific file (on premises)' +--- + += Search for a specific file (on premises) + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/search/job`# + + + +Searches for a specific file from the backups taken by the NetApp Backup and Recovery service across on-premises volumes and systems. It can also search for a specified volume. It is possible to narrow down your file search based on a particular system, file extensions, size ranges, creation date range, and also location of a backup. + +**Token usage:**NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|query +|string +|query +|True +a| + +|jobId +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|results +|array[link:#results[results]] +|False +a| + +|endOfResults +|boolean +|False +a| + +|status +|string +|False +a| + +|message +|string +|False +a| + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "results": [ + { + "resourceName": "string", + "resourceType": "string", + "workingEnvironmentId": "string", + "workingEnvironmentName": "string", + "svmName": "string", + "volumeId": "string", + "volumeName": "string", + "inode": "string" + } + ], + "status": "string", + "message": "string", + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#results] +[.api-collapsible-fifth-title] +results + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resourceName +|string +|False +a| + +|resourceType +|string +|False +a| + +|workingEnvironmentId +|string +|False +a| + +|workingEnvironmentName +|string +|False +a| + +|svmName +|string +|False +a| + +|volumeId +|string +|False +a| + +|volumeName +|string +|False +a| + +|resourceSize +|number +|False +a| + +|inode +|string +|False +a| + +|mtime +|number +|False +a| + +|latestSnapshotCreationTime +|number +|False +a| + +|snapshotsCount +|number +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-configurations-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-configurations-.adoc new file mode 100644 index 00000000..bfba6f1a --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-configurations-.adoc @@ -0,0 +1,126 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-configurations-.html' +summary: 'Retrieve the configuration value for the specified key' +--- + += Retrieve the configuration value for the specified key + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/configurations/{key}`# + + + +Retrieves the configuration value for the specified key. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|key +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "value": "string" +} +==== + +== Error + +``` +Status: 500, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|statusCode +|number +|False +a| + +|error +|string +|False +a| + +|message +|string +|False +a| + +|=== + + +.Example error +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-feature-flags.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-feature-flags.adoc new file mode 100644 index 00000000..a131dae8 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-feature-flags.adoc @@ -0,0 +1,82 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-feature-flags.html' +summary: 'Retrieve a list of features which are enabled or disabled for the account' +--- + += Retrieve a list of features which are enabled or disabled for the account + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/feature-flags`# + + + +Retrieves a list of features which are enabled or disabled for the account. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|flexgroup-volume-directory-restore +|boolean +|False +a| + +|volumes-dashboard-v2 +|boolean +|False +a| + +|allow-s3-compatible +|boolean +|False +a| + +|smc-resync +|boolean +|False +a| + +|job-monitor +|boolean +|False +a| + +|storage-protection +|boolean +|False +a| + +|=== + + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-buckets-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-buckets-.adoc new file mode 100644 index 00000000..3504ad00 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-buckets-.adoc @@ -0,0 +1,148 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-buckets-.html' +summary: 'Retrieve a Google Cloud bucket in a region' +--- + += Retrieve a Google Cloud bucket in a region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/buckets/{bucketName}`# + + + +Retrieves a specific Google Cloud bucket in a region from a specific Google Cloud project from the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|fields +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|projectId +|string +|path +|True +a| + +|bucketName +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|buckets +|array[link:#buckets[buckets]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "buckets": [ + { + "name": "string", + "is-encrypted": "string", + "is-public": "string", + "region": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#buckets] +[.api-collapsible-fifth-title] +buckets + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|is-encrypted +|string +|False +a| + +|is-public +|string +|False +a| + +|region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-buckets.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-buckets.adoc new file mode 100644 index 00000000..5a71bdc7 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-buckets.adoc @@ -0,0 +1,142 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-buckets.html' +summary: 'Retrieve a list of Google Cloud buckets in a region' +--- + += Retrieve a list of Google Cloud buckets in a region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/buckets`# + + + +Retrieves a list of buckets in a region from a specific Google Cloud project from the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|fields +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|projectId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|buckets +|array[link:#buckets[buckets]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "buckets": [ + { + "name": "string", + "is-encrypted": "string", + "is-public": "string", + "region": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#buckets] +[.api-collapsible-fifth-title] +buckets + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|is-encrypted +|string +|False +a| + +|is-public +|string +|False +a| + +|region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region-keyrings-cryptokey.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region-keyrings-cryptokey.adoc new file mode 100644 index 00000000..0721d84c --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region-keyrings-cryptokey.adoc @@ -0,0 +1,136 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region-keyrings-cryptokey.html' +summary: 'Retrieve a list of CryptoKeys' +--- + += Retrieve a list of CryptoKeys + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region/{locationId}/keyrings/{keyRingId}/cryptokey`# + + + +Retrieves a list of CryptoKeys for a KeyRing in a region from a specific Google Cloud project. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|projectId +|string +|path +|True +a| + +|locationId +|string +|path +|True +a| + +|keyRingId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cryptoKeys +|array[link:#cryptoKeys[cryptoKeys]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "cryptoKeys": [ + { + "id": "string", + "name": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#cryptoKeys] +[.api-collapsible-fifth-title] +cryptoKeys + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region-keyrings.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region-keyrings.adoc new file mode 100644 index 00000000..abb33d64 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region-keyrings.adoc @@ -0,0 +1,130 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region-keyrings.html' +summary: 'Retrieve a list of KeyRings for a region' +--- + += Retrieve a list of KeyRings for a region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region/{locationId}/keyrings`# + + + +Retrieves a list of KeyRings for a region from a specific Google Cloud project. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|projectId +|string +|path +|True +a| + +|locationId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|keyRings +|array[link:#keyRings[keyRings]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "keyRings": [ + { + "id": "string", + "name": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#keyRings] +[.api-collapsible-fifth-title] +keyRings + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region.adoc new file mode 100644 index 00000000..3f0cebee --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region.adoc @@ -0,0 +1,124 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region.html' +summary: 'Retrieve Google Cloud regions' +--- + += Retrieve Google Cloud regions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region`# + + + +Retrieves a list of regions from a specific Google Cloud project. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|projectId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|array[link:#region[region]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": [ + { + "name": "string", + "code": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#region] +[.api-collapsible-fifth-title] +region + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|code +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project.adoc new file mode 100644 index 00000000..67bc489e --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project.adoc @@ -0,0 +1,118 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project.html' +summary: 'Retrieve Google Cloud projects' +--- + += Retrieve Google Cloud projects + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project`# + + + +Retrieves a list of Google Cloud projects. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|project +|array[link:#project[project]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "project": [ + { + "name": "string", + "id": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#project] +[.api-collapsible-fifth-title] +project + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-job-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-job-.adoc new file mode 100644 index 00000000..fc35be92 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-job-.adoc @@ -0,0 +1,492 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-job-.html' +summary: 'Retrieve particular job details' +--- + += Retrieve particular job details + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/job/{jobId}`# + + + +Retrieves the details of particular jobs from the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|jobId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job +|array[link:#job[job]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job": [ + { + "id": "string", + "working-environment-id": "string", + "type": "string", + "status": "string", + "error": "string", + "data": { + "multi-volume-backup": { + "volume": [ + { + "id": "string", + "status": "string", + "error": "string" + } + ] + }, + "restore": { + "type": "string", + "source": { + "working-environment-id": "string", + "working-environment-name": "string", + "bucket": "string", + "volume-id": "string", + "volume-name": "string", + "snapshot": "string" + }, + "target": { + "working-environment-id": "string", + "working-environment-name": "string", + "svm": "string", + "volume-name": "string", + "path": "string" + }, + "batch": [ + { + "id": "string", + "status": "string", + "error": "string", + "file": [ + { + "path": "string", + "type": "string" + } + ] + } + ] + } + } + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#volume] +[.api-collapsible-fifth-title] +volume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a|Volume ID + + +|status +|string +|False +a|SUCCESS / FAILED status + + +|error +|string +|False +a|Error message in case of failure + + +|=== + + +[#multi-volume-backup] +[.api-collapsible-fifth-title] +multi-volume-backup + +Contains individual volume data for multi-volume-backup + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volume +|array[link:#volume[volume]] +|False +a|Array of objects containing volume backup status or errors with the volume ID + + +|=== + + +[#source] +[.api-collapsible-fifth-title] +source + +Optional object, present only in case of restore operation + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|bucket +|string +|False +a| + +|volume-id +|string +|False +a| + +|volume-name +|string +|False +a| + +|snapshot +|string +|False +a| + +|=== + + +[#target] +[.api-collapsible-fifth-title] +target + +Optional object, present only in case of restore operation + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|svm +|string +|False +a| + +|volume-name +|string +|False +a| + +|volume-size +|number +|False +a| + +|path +|string +|False +a| + +|=== + + +[#file] +[.api-collapsible-fifth-title] +file + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|inode +|number +|False +a| + +|path +|string +|False +a| + +|type +|string +|False +a| + +|size +|number +|False +a| + +|mtime +|number +|False +a| + +|=== + + +[#batch] +[.api-collapsible-fifth-title] +batch + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|time +|number +|False +a| + +|file +|array[link:#file[file]] +|False +a| + +|=== + + +[#restore] +[.api-collapsible-fifth-title] +restore + +Contains information about restore job - file and volume restore + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a|Type of restore - file / volume + + +|source +|link:#source[source] +|False +a|Optional object, present only in case of restore operation + + +|target +|link:#target[target] +|False +a|Optional object, present only in case of restore operation + + +|batch +|array[link:#batch[batch]] +|False +a|Optional array present only in case of restore file operation + + +|=== + + +[#data] +[.api-collapsible-fifth-title] +data + +Optional object, present for batch or individual operations running inside the main job only + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|multi-volume-backup +|link:#multi-volume-backup[multi-volume-backup] +|False +a|Contains individual volume data for multi-volume-backup + + +|restore +|link:#restore[restore] +|False +a|Contains information about restore job - file and volume restore + + +|=== + + +[#job] +[.api-collapsible-fifth-title] +job + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|working-environment-id +|string +|False +a| + +|type +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|time +|number +|False +a| + +|data +|link:#data[data] +|False +a|Optional object, present for batch or individual operations running inside the main job only + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-job.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-job.adoc new file mode 100644 index 00000000..ab87ddc0 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-job.adoc @@ -0,0 +1,498 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-job.html' +summary: 'Retrieve jobs' +--- + += Retrieve jobs + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/job`# + + + +Retrieves a list of jobs from the NetApp Console SaaS application. You can query based on the job type and job status from the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|type +|string +|query +|False +a| + +|status +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job +|array[link:#job[job]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job": [ + { + "id": "string", + "working-environment-id": "string", + "type": "string", + "status": "string", + "error": "string", + "data": { + "multi-volume-backup": { + "volume": [ + { + "id": "string", + "status": "string", + "error": "string" + } + ] + }, + "restore": { + "type": "string", + "source": { + "working-environment-id": "string", + "working-environment-name": "string", + "bucket": "string", + "volume-id": "string", + "volume-name": "string", + "snapshot": "string" + }, + "target": { + "working-environment-id": "string", + "working-environment-name": "string", + "svm": "string", + "volume-name": "string", + "path": "string" + }, + "batch": [ + { + "id": "string", + "status": "string", + "error": "string", + "file": [ + { + "path": "string", + "type": "string" + } + ] + } + ] + } + } + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#volume] +[.api-collapsible-fifth-title] +volume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a|Volume ID + + +|status +|string +|False +a|SUCCESS / FAILED status + + +|error +|string +|False +a|Error message in case of failure + + +|=== + + +[#multi-volume-backup] +[.api-collapsible-fifth-title] +multi-volume-backup + +Contains individual volume data for multi-volume-backup + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volume +|array[link:#volume[volume]] +|False +a|Array of objects containing volume backup status or errors with the volume ID + + +|=== + + +[#source] +[.api-collapsible-fifth-title] +source + +Optional object, present only for restore operations + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|bucket +|string +|False +a| + +|volume-id +|string +|False +a| + +|volume-name +|string +|False +a| + +|snapshot +|string +|False +a| + +|=== + + +[#target] +[.api-collapsible-fifth-title] +target + +Optional object, present only for restore operations + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|svm +|string +|False +a| + +|volume-name +|string +|False +a| + +|volume-size +|number +|False +a| + +|path +|string +|False +a| + +|=== + + +[#file] +[.api-collapsible-fifth-title] +file + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|inode +|number +|False +a| + +|path +|string +|False +a| + +|type +|string +|False +a| + +|size +|number +|False +a| + +|mtime +|number +|False +a| + +|=== + + +[#batch] +[.api-collapsible-fifth-title] +batch + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|time +|number +|False +a| + +|file +|array[link:#file[file]] +|False +a| + +|=== + + +[#restore] +[.api-collapsible-fifth-title] +restore + +Contains information about restore job - file and volume restore + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a|Type of restore - file or volume + + +|source +|link:#source[source] +|False +a|Optional object, present only for restore operations + + +|target +|link:#target[target] +|False +a|Optional object, present only for restore operations + + +|batch +|array[link:#batch[batch]] +|False +a|Optional array, present only for restore file operations + + +|=== + + +[#data] +[.api-collapsible-fifth-title] +data + +Optional object present in case of batch or individual operations running inside the main job only + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|multi-volume-backup +|link:#multi-volume-backup[multi-volume-backup] +|False +a|Contains individual volume data for multi-volume-backup + + +|restore +|link:#restore[restore] +|False +a|Contains information about restore job - file and volume restore + + +|=== + + +[#job] +[.api-collapsible-fifth-title] +job + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|working-environment-id +|string +|False +a| + +|type +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|time +|number +|False +a| + +|data +|link:#data[data] +|False +a|Optional object present in case of batch or individual operations running inside the main job only + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-license-working-environment-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-license-working-environment-.adoc new file mode 100644 index 00000000..c74d7df1 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-license-working-environment-.adoc @@ -0,0 +1,100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-license-working-environment-.html' +summary: 'Retrieve license validity' +--- + += Retrieve license validity + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/license/working-environment/{workingEnvironmentId}`# + + + +Retrieves the license validity of the systems from the NetApp Console SaaS application. The API retrieves the eligibility of the current license used and it also returns the days remaining if you are using a trial license. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|provider +|string +|query +|True +a|* enum: ["AWS", "AZURE", "GCP", "SGWS"] + + +|cloudProviderAccountId +|string +|query +|False +a|Cloud provider account ID. AWS account ID/Azure subscription ID/ Google Cloud project ID. It is not mandatory to send this query parameter for StorageGRID. + + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|free-trial-end +|number +|False +a| + +|eligible +|boolean +|False +a| + +|=== + + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-license-working-environment-validity.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-license-working-environment-validity.adoc new file mode 100644 index 00000000..146e3609 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-license-working-environment-validity.adoc @@ -0,0 +1,87 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-license-working-environment-validity.html' +summary: 'Verify the valid licenses in a system' +--- + += Verify the valid licenses in a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/license/working-environment/{workingEnvironmentId}/validity`# + + + +Checks if there is a valid marketplace subscription, backup license, and SnapMirror license in a system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|marketplace-subscription +|boolean +|False +a| + +|cloud-backup-license +|boolean +|False +a| + +|snapmirror-license +|boolean +|False +a| + +|=== + + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-object-storage-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-object-storage-.adoc new file mode 100644 index 00000000..bb714fb4 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-object-storage-.adoc @@ -0,0 +1,65 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-object-storage-.html' +summary: 'Retrieve buckets for a cloud provider' +--- + += Retrieve buckets for a cloud provider + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage/{provider}`# + + + +Retrieves buckets for the specified cloud provider. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|provider +|string +|path +|True +a|Cloud provider type + +* enum: ["AWS", "GCP", "AZURE", "SGWS", "ONTAP_S3"] + + +|authorization +|string +|header +|True +a|Authorization token + + +|X-Agent-Id +|string +|header +|True +a|Agent ID + +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-object-storage-provider.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-object-storage-provider.adoc new file mode 100644 index 00000000..289f39be --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-object-storage-provider.adoc @@ -0,0 +1,206 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-object-storage-provider.html' +summary: 'Retrieve a bucket for a cloud provider' +--- + += Retrieve a bucket for a cloud provider + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage/{provider}/{objectStoreName}`# + + + +Retrieves a specific bucket for the specified cloud provider. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|provider +|string +|path +|True +a|Cloud provider type + +* enum: ["AWS", "GCP", "AZURE", "SGWS", "ONTAP_S3"] + + +|objectStoreName +|string +|path +|True +a|Bucket name + + +|authorization +|string +|header +|True +a|Authorization token + + +|X-Agent-Id +|string +|header +|True +a|Agent ID + +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|object-store-name +|string +|True +a|Bucket name + + +|region +|string +|False +a|Bucket region + + +|provider +|string +|True +a|Cloud provider + + +|account-id +|string +|False +a|Account ID for the AWS provider + + +|project-id +|string +|False +a|Project ID for the Google Cloud provider + + +|subscription +|string +|False +a|Subscription for the Azure provider + + +|encryption +|string +|False +a|Encryption type used for the bucket + + +|is-public +|boolean +|False +a|Indicates whether the bucket is public + + +|object-lock +|string +|False +a|Object lock enabled for the bucket + + +|resource-group +|string +|False +a|Resource group for the Azure provider + + +|tags +|array[link:#tags[tags]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "object-store-name": "string", + "region": "string", + "provider": "string", + "account-id": "string", + "project-id": "string", + "subscription": "string", + "encryption": "string", + "object-lock": "string", + "resource-group": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#tags] +[.api-collapsible-fifth-title] +tags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|False +a|Tag key + + +|value +|string +|False +a|Tag value + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-report-job-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-report-job-.adoc new file mode 100644 index 00000000..926c245e --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-report-job-.adoc @@ -0,0 +1,441 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-report-job-.html' +summary: 'Retrieve inventory report data' +--- + += Retrieve inventory report data + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/report/job/{jobId}`# + + + +Retrieves the inventory report data that was generated by the Inventory Report POST API. When called, it downloads the inventory report data based on the scope (account, system, storage VM) specified during the deployment of the Inventory Report POST API. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|page +|number +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|jobId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|report +|array[link:#report[report]] +|False +a| + +|page +|number +|False +a| + +|total-pages +|number +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "report": [ + { + "working-environment-id": "string", + "working-environment-name": "string", + "working-environment-status": "string", + "backup-enablement-status": "string", + "working-environment-type": "string", + "provider": "string", + "provider-account-id": "string", + "bucket": "string", + "archive-storage-class": "string", + "region": "string", + "volumes": [ + { + "uuid": "string", + "name": "string", + "svm": "string", + "status": "string", + "backup-status": "string", + "snapshot-count": "string", + "backup-policy": { + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "archive-after-days": "string" + }, + "snapshot": [ + { + "id": "string", + "name": "string", + "object-lock": "string" + } + ], + "object-lock": "string", + "ransomware-scan-status": "string" + } + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#keyDetails] +[.api-collapsible-fifth-title] +keyDetails + +JSON data containing data specific to Customer Managed Encryption Keys + + + +[#cmek] +[.api-collapsible-fifth-title] +cmek + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|enabled +|boolean +|False +a| + +|keyDetails +|link:#keyDetails[keyDetails] +|False +a|JSON data containing data specific to Customer Managed Encryption Keys + + +|=== + + +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|rule +|array[link:#rule[rule]] +|False +a| + +|archive-after-days +|string +|False +a| + +|=== + + +[#snapshot] +[.api-collapsible-fifth-title] +snapshot + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|creation-time +|number +|False +a| + +|size +|number +|False +a| + +|object-lock +|string +|False +a| + +|archived +|boolean +|False +a| + +|=== + + +[#volumes] +[.api-collapsible-fifth-title] +volumes + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uuid +|string +|False +a| + +|name +|string +|False +a| + +|svm +|string +|False +a| + +|status +|string +|False +a| + +|backup-status +|string +|False +a| + +|last-backup-creation-time +|number +|False +a| + +|snapshot-count +|string +|False +a| + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|snapshot +|array[link:#snapshot[snapshot]] +|False +a| + +|object-lock +|string +|False +a| + +|ransomware-scan-status +|string +|False +a| + +|last-ransomware-scan +|number +|False +a| + +|=== + + +[#report] +[.api-collapsible-fifth-title] +report + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|working-environment-status +|string +|False +a| + +|backup-enablement-status +|string +|False +a| + +|working-environment-type +|string +|False +a| + +|total-volumes-count +|number +|False +a| + +|backed-up-volumes-count +|number +|False +a| + +|provider +|string +|False +a| + +|provider-account-id +|string +|False +a| + +|bucket +|string +|False +a| + +|archive-storage-class +|string +|False +a| + +|region +|string +|False +a| + +|cmek +|link:#cmek[cmek] +|False +a| + +|volumes +|array[link:#volumes[volumes]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-report-replication-job-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-report-replication-job-.adoc new file mode 100644 index 00000000..366b7170 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-report-replication-job-.adoc @@ -0,0 +1,281 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-report-replication-job-.html' +summary: 'Retrieve replication report data' +--- + += Retrieve replication report data + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/report/replication/job/{jobId}`# + + + +Retrieves the replication report data that was generated by the Replication Inventory Report POST API. When called, it downloads the replication report data based on the scope (account, system) specified during the deployment of the Replication Inventory Report POST API. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|page +|number +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|jobId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|report +|link:#report[report] +|False +a| + +|page +|number +|False +a| + +|total-pages +|number +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "report": { + "relationships": [ + { + "source-working-environment": "string", + "target-working-environment": "string", + "snapshots": [ + { + "name": "string" + } + ], + "state": "string", + "policy": "string", + "source-volume": "string", + "source-volume-svm": "string", + "target-volume": "string", + "target-volume-svm": "string", + "source-volume-uuid": "string", + "healthy": "string", + "unhealthy-reason": "string", + "policy-type": "string", + "source-volume-state": "string" + } + ] + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#snapshots] +[.api-collapsible-fifth-title] +snapshots + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|creation-time +|number +|False +a| + +|size +|number +|False +a| + +|=== + + +[#relationships] +[.api-collapsible-fifth-title] +relationships + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|source-working-environment +|string +|False +a| + +|target-working-environment +|string +|False +a| + +|snapshot-count +|number +|False +a| + +|snapshots +|array[link:#snapshots[snapshots]] +|False +a| + +|state +|string +|False +a| + +|policy +|string +|False +a| + +|source-volume +|string +|False +a| + +|source-volume-svm +|string +|False +a| + +|target-volume +|string +|False +a| + +|target-volume-svm +|string +|False +a| + +|source-volume-uuid +|string +|False +a| + +|healthy +|string +|False +a| + +|unhealthy-reason +|string +|False +a| + +|policy-type +|string +|False +a| + +|source-volume-state +|string +|False +a| + +|=== + + +[#report] +[.api-collapsible-fifth-title] +report + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|total-volumes-count +|number +|False +a| + +|total-svms-count +|number +|False +a| + +|relationships +|array[link:#relationships[relationships]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-report-snapshot-job-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-report-snapshot-job-.adoc new file mode 100644 index 00000000..490f261f --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-report-snapshot-job-.adoc @@ -0,0 +1,252 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-report-snapshot-job-.html' +summary: 'Retrieve the local snapshots report' +--- + += Retrieve the local snapshots report + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/report/snapshot/job/{jobId}`# + + + +Retrieves the local snapshots report data that was generated by the Local Snapshot Inventory Report POST API. When called, it downloads the local snapshot report data based on the scope (account, system) specified during the deployment of the Replication Inventory Report POST API. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|page +|number +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|jobId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|report +|array[link:#report[report]] +|False +a| + +|page +|number +|False +a| + +|total-pages +|number +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "report": [ + { + "working-environment-name": "string", + "working-environment-id": "string", + "volumes": [ + { + "name": "string", + "svm": "string", + "state": "string", + "snapshot-policy": "string", + "snapshots": [ + { + "name": "string", + "state": "string" + } + ] + } + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#snapshots] +[.api-collapsible-fifth-title] +snapshots + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|creation-time +|number +|False +a| + +|size +|number +|False +a| + +|state +|string +|False +a| + +|expiry-time +|number +|False +a| + +|snaplock-expiry-time +|number +|False +a| + +|=== + + +[#volumes] +[.api-collapsible-fifth-title] +volumes + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|svm +|string +|False +a| + +|state +|string +|False +a| + +|snapshot-count +|number +|False +a| + +|snapshot-policy +|string +|False +a| + +|snapshots +|array[link:#snapshots[snapshots]] +|False +a| + +|=== + + +[#report] +[.api-collapsible-fifth-title] +report + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-name +|string +|False +a| + +|working-environment-id +|string +|False +a| + +|volume-count +|number +|False +a| + +|volumes +|array[link:#volumes[volumes]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-snapshot-file-explore-list.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-snapshot-file-explore-list.adoc new file mode 100644 index 00000000..5ed4220f --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-snapshot-file-explore-list.adoc @@ -0,0 +1,321 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-snapshot-file-explore-list.html' +summary: 'Retrieve a list of files and folders' +--- + += Retrieve a list of files and folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}/file-explore/list`# + + + +Retrieves a list of files and folders within a specified volume snapshot in a paginated format during a file or folder restore operation (V2 version of the file-explore/list API). You can pass the number of pages and limit of the number of files that the API endpoint should retrieve while fetching the details in a paginated format. The volume snapshot is mounted on under the /tmp folder of the Console agent instance to create a file catalog for the "Browse and Restore" option. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|snapshotLocation +|string +|query +|False +a|Location of the snapshot + +* enum: ["LOCAL", "CLOUD"] + + +|fileType +|string +|query +|False +a|Type of the file + +* enum: ["FILE", "DIRECTORY", "ALL"] + + +|sortBy +|string +|query +|False +a|The column name to sort with + +* enum: ["name", "size", "mtime"] + + +|orderBy +|string +|query +|False +a|Order of the results, either ASCENDING or DESCENDING + +* enum: ["ASC", "DESC"] + + +|name +|string +|query +|False +a|Name of the file or directory + + +|path +|string +|query +|False +a|Path of files to browse + + +|page +|number +|query +|False +a|Number of the page + + +|limit +|number +|query +|False +a|Limit of files + + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|volumeId +|string +|path +|True +a|File system ID/Volume ID + + +|snapshotId +|string +|path +|True +a|Snapshot ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pageConfig +|link:#pageConfig[pageConfig] +|False +a| + +|context +|array[link:#context[context]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "context": [ + { + "inode": "string", + "name": "string", + "path": "string", + "type": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#next] +[.api-collapsible-fifth-title] +next + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|page +|number +|False +a|Next page number + + +|limit +|number +|False +a|Limit of files + + +|=== + + +[#previous] +[.api-collapsible-fifth-title] +previous + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|page +|number +|False +a|Previous page number + + +|limit +|number +|False +a|Limit of files + + +|=== + + +[#pageConfig] +[.api-collapsible-fifth-title] +pageConfig + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|next +|link:#next[next] +|False +a| + +|previous +|link:#previous[previous] +|False +a| + +|startIndex +|number +|False +a|Starting index of file list + + +|endIndex +|number +|False +a|Ending index of file list + + +|=== + + +[#context] +[.api-collapsible-fifth-title] +context + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|inode +|string +|False +a| + +|name +|string +|False +a| + +|path +|string +|False +a| + +|type +|string +|False +a| + +|size +|number +|False +a| + +|mtime +|number +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-snapshot-files-status.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-snapshot-files-status.adoc new file mode 100644 index 00000000..7881b604 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-snapshot-files-status.adoc @@ -0,0 +1,123 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-snapshot-files-status.html' +summary: 'Retrieve the file and folder status' +--- + += Retrieve the file and folder status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}/files/status`# + + + +Returns the file and folder status when you initiate a file or folder search during a restore operation. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|path +|string +|query +|False +a|The path of the directory + + +|snapshotLocation +|string +|query +|False +a|Location of the snapshot + +* enum: ["LOCAL", "CLOUD"] + + +|actualCount +|boolean +|query +|False +a|By default, the count is retrieved from the browsestatus table. When this flag is true, it retrieves the count of the actual records existing in the browsedb table. + + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|volumeId +|string +|path +|True +a|File system ID/Volume ID + + +|snapshotId +|string +|path +|True +a|Snapshot ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|counter +|integer +|False +a| + +|inProgress +|boolean +|False +a| + +|=== + + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-.adoc new file mode 100644 index 00000000..39919101 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-.adoc @@ -0,0 +1,147 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-.html' +summary: 'Retrieve system details' +--- + += Retrieve system details + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}`# + + + +Retrieves the details of a specific system. This API endpoint retrieves the name, region, status, type, cloud-provider, provider-accountId, ontap-version, and total-volumes-count of a specific system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|partial +|boolean +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|cluster-uuid +|string +|False +a| + +|name +|string +|False +a| + +|region +|string +|False +a| + +|status +|string +|False +a| + +|ontap-version +|string +|False +a| + +|type +|string +|False +a| + +|provider +|string +|False +a| + +|provider-account-id +|string +|False +a|AWS account ID/ Azure subscription ID / Google Cloud project ID + + +|total-volumes-count +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "string", + "cluster-uuid": "string", + "name": "string", + "region": "string", + "status": "string", + "ontap-version": "string", + "type": "string", + "provider": "string", + "provider-account-id": "string", + "total-volumes-count": "string" +} +==== + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy.adoc new file mode 100644 index 00000000..dba5fddc --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy.adoc @@ -0,0 +1,306 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy.html' +summary: 'Retrieve ONTAP backup policies' +--- + += Retrieve ONTAP backup policies + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy`# + + + +Retrieves a list of ONTAP backup policies associated with a system. You can filter the policies based on the archival enablement status. This API endpoint retrieves the backup-policy name, rule, attached volume count, archive-after-days, and object-lock mode information. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|archived +|boolean +|query +|False +a| + +|is-mcc-cluster +|boolean +|query +|False +a| + +|partial +|boolean +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|backup-policy +|array[link:#backup-policy[backup-policy]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "backup-policy": [ + { + "name": "string", + "id": "string", + "rule": [ + { + "label": "string", + "retention": "string", + "period": "string" + } + ], + "attached-volumes-count": "string", + "archive-after-days": "string", + "object-lock": "string", + "transfer-schedule": { + "uuid": "string", + "name": "string", + "cron": { + "minutes": [ + "integer" + ], + "hours": [ + "integer" + ], + "weekdays": [ + "integer" + ], + "days": [ + "integer" + ], + "months": [ + "integer" + ] + }, + "interval": "string" + } + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|period +|string +|False +a| + +|=== + + +[#cron] +[.api-collapsible-fifth-title] +cron + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|minutes +|array[integer] +|False +a| + +|hours +|array[integer] +|False +a| + +|weekdays +|array[integer] +|False +a| + +|days +|array[integer] +|False +a| + +|months +|array[integer] +|False +a| + +|=== + + +[#transfer-schedule] +[.api-collapsible-fifth-title] +transfer-schedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uuid +|string +|False +a| + +|name +|string +|False +a| + +|cron +|link:#cron[cron] +|False +a| + +|interval +|string +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|rule +|array[link:#rule[rule]] +|False +a| + +|attached-volumes-count +|string +|False +a| + +|archive-after-days +|string +|False +a| + +|object-lock +|string +|False +a| + +|transfer-schedule +|link:#transfer-schedule[transfer-schedule] +|False +a| + +|allow-policy-deletion +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-ip-space.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-ip-space.adoc new file mode 100644 index 00000000..abb940fc --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-ip-space.adoc @@ -0,0 +1,124 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-ip-space.html' +summary: 'Retrieve IP spaces' +--- + += Retrieve IP spaces + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/ip-space`# + + + +Retrieves a list of IP spaces within a specified system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip-space +|array[link:#ip-space[ip-space]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "ip-space": [ + { + "id": "string", + "name": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ip-space] +[.api-collapsible-fifth-title] +ip-space + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-object-store-config-status.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-object-store-config-status.adoc new file mode 100644 index 00000000..73b75a37 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-object-store-config-status.adoc @@ -0,0 +1,92 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-object-store-config-status.html' +summary: 'Retrieve an object store configuration status' +--- + += Retrieve an object store configuration status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/object-store-config/status`# + + + +Retrieves an object store configuration status. It uses the GET /api/cloud/targets ONTAP REST APIs to retrieve the details. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|object-store-name +|string +|query +|True +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string" +} +==== + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-peercluster.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-peercluster.adoc new file mode 100644 index 00000000..97228260 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-peercluster.adoc @@ -0,0 +1,88 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-peercluster.html' +summary: 'Retrieve a list of ONTAP clusters peered to a system' +--- + += Retrieve a list of ONTAP clusters peered to a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/peercluster`# + + + +Retrieves a list of ONTAP clusters peered to a specific system. The required system ID is passed as a parameter for the API call. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peer-working-environment +|array[string] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "peer-working-environment": [ + "string" + ] +} +==== + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-relationship-.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-relationship-.adoc new file mode 100644 index 00000000..8ef3829c --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-relationship-.adoc @@ -0,0 +1,269 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-relationship-.html' +summary: 'List the relationship details associated with a volume SnapMirror replication' +--- + += List the relationship details associated with a volume SnapMirror replication + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/relationship/{relationshipId}`# + + + +Lists the relationship details associated with a volume SnapMirror replication relationship. The API returns the source details, destination details, policy details, status, health, transfer type, and relationship status details. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|relationshipId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uuid +|string +|False +a| + +|source +|link:#source[source] +|False +a| + +|destination +|link:#destination[destination] +|False +a| + +|policy +|link:#policy[policy] +|False +a| + +|state +|string +|False +a| + +|healthy +|string +|False +a| + +|transfer +|link:#transfer[transfer] +|False +a| + +|protection-status +|string +|False +a| + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "uuid": "string", + "source": { + "path": "string" + }, + "destination": { + "path": "string" + }, + "policy": { + "name": "string" + }, + "state": "string", + "healthy": "string", + "transfer": { + "last-transfer-size": "string", + "last-transfer-duration": "string", + "lag": "string", + "end-time": "string", + "state": "string", + "throttle": "string" + }, + "protection-status": "string", + "working-environment-id": "string", + "working-environment-name": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#source] +[.api-collapsible-fifth-title] +source + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|path +|string +|False +a| + +|=== + + +[#destination] +[.api-collapsible-fifth-title] +destination + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|path +|string +|False +a| + +|=== + + +[#policy] +[.api-collapsible-fifth-title] +policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#transfer] +[.api-collapsible-fifth-title] +transfer + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|last-transfer-size +|string +|False +a| + +|last-transfer-duration +|string +|False +a| + +|lag +|string +|False +a| + +|end-time +|string +|False +a| + +|state +|string +|False +a| + +|throttle +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-relationship.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-relationship.adoc new file mode 100644 index 00000000..232f8892 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-relationship.adoc @@ -0,0 +1,327 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-relationship.html' +summary: 'Retrieve a list of ONTAP relationships associated with a system' +--- + += Retrieve a list of ONTAP relationships associated with a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/relationship`# + + + +Retrieves a list of ONTAP relationships associated with a system. The system ID is passed as a parameter for the REST API call. You can query by passing parameters to specify the maximum number of records that should be returned, the next subsequent volume UUID to get results from, and the type of relationship. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|max-records +|number +|query +|False +a| + +|cursor +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|relationship +|array[link:#relationship[relationship]] +|False +a| + +|cursor +|string +|False +a| + +|num-records +|number +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "relationship": [ + { + "uuid": "string", + "source": { + "path": "string", + "svm": "string" + }, + "destination": { + "path": "string" + }, + "policy": { + "name": "string" + }, + "state": "string", + "healthy": "string", + "relationship-type": "string", + "transfer": { + "last-transfer-size": "string", + "last-transfer-duration": "string", + "lag": "string", + "end-time": "string", + "state": "string", + "throttle": "string" + }, + "protection-status": "string", + "unhealthy-reason": "string", + "working-environment-id": "string", + "working-environment-name": "string" + } + ], + "cursor": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#source] +[.api-collapsible-fifth-title] +source + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|path +|string +|False +a| + +|svm +|string +|False +a| + +|=== + + +[#destination] +[.api-collapsible-fifth-title] +destination + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|path +|string +|False +a| + +|=== + + +[#policy] +[.api-collapsible-fifth-title] +policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#transfer] +[.api-collapsible-fifth-title] +transfer + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|last-transfer-size +|string +|False +a| + +|last-transfer-duration +|string +|False +a| + +|lag +|string +|False +a| + +|end-time +|string +|False +a| + +|state +|string +|False +a| + +|throttle +|string +|False +a| + +|=== + + +[#relationship] +[.api-collapsible-fifth-title] +relationship + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uuid +|string +|False +a| + +|source +|link:#source[source] +|False +a| + +|destination +|link:#destination[destination] +|False +a| + +|policy +|link:#policy[policy] +|False +a| + +|state +|string +|False +a| + +|healthy +|string +|False +a| + +|relationship-type +|string +|False +a| + +|transfer +|link:#transfer[transfer] +|False +a| + +|protection-status +|string +|False +a| + +|unhealthy-reason +|string +|False +a| + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy.adoc new file mode 100644 index 00000000..28eae2ee --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy.adoc @@ -0,0 +1,298 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy.html' +summary: 'Retrieve a list of ONTAP replication policies' +--- + += Retrieve a list of ONTAP replication policies + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy`# + + + +Retrieves a list of ONTAP replication policies associated with a system. The API will list the SnapMirror policies created on the cluster level for the specified system. The system ID is passed as a parameter for the REST API call. It returns the SnapMirror policies and the rules associated with the policies. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|partial +|boolean +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|replication-policy +|array[link:#replication-policy[replication-policy]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "replication-policy": [ + { + "name": "string", + "id": "string", + "svm": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "transfer-schedule": { + "uuid": "string", + "name": "string", + "cron": { + "minutes": [ + "integer" + ], + "hours": [ + "integer" + ], + "weekdays": [ + "integer" + ], + "days": [ + "integer" + ], + "months": [ + "integer" + ] + }, + "interval": "string" + }, + "policy-type": "string", + "attached-volumes-count": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#cron] +[.api-collapsible-fifth-title] +cron + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|minutes +|array[integer] +|False +a| + +|hours +|array[integer] +|False +a| + +|weekdays +|array[integer] +|False +a| + +|days +|array[integer] +|False +a| + +|months +|array[integer] +|False +a| + +|=== + + +[#transfer-schedule] +[.api-collapsible-fifth-title] +transfer-schedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uuid +|string +|False +a| + +|name +|string +|False +a| + +|cron +|link:#cron[cron] +|False +a| + +|interval +|string +|False +a| + +|=== + + +[#replication-policy] +[.api-collapsible-fifth-title] +replication-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|svm +|string +|False +a| + +|rule +|array[link:#rule[rule]] +|False +a| + +|transfer-schedule +|link:#transfer-schedule[transfer-schedule] +|False +a| + +|policy-type +|string +|False +a| + +|attached-volumes-count +|string +|False +a| + +|copy-latest-source-snapshot +|boolean +|False +a| + +|copy-all-source-snapshots +|boolean +|False +a| + +|allow-policy-deletion +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-schedules.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-schedules.adoc new file mode 100644 index 00000000..1651b4ec --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-schedules.adoc @@ -0,0 +1,191 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-schedules.html' +summary: 'Retrieve a list of schedules in a system' +--- + += Retrieve a list of schedules in a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/schedules`# + + + +Retrieves a list of schedules present in a system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|schedules +|array[link:#schedules[schedules]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "schedules": [ + { + "uuid": "string", + "name": "string", + "cron": { + "minutes": [ + "integer" + ], + "hours": [ + "integer" + ], + "weekdays": [ + "integer" + ], + "days": [ + "integer" + ], + "months": [ + "integer" + ] + }, + "interval": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#cron] +[.api-collapsible-fifth-title] +cron + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|minutes +|array[integer] +|False +a| + +|hours +|array[integer] +|False +a| + +|weekdays +|array[integer] +|False +a| + +|days +|array[integer] +|False +a| + +|months +|array[integer] +|False +a| + +|=== + + +[#schedules] +[.api-collapsible-fifth-title] +schedules + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uuid +|string +|False +a| + +|name +|string +|False +a| + +|cron +|link:#cron[cron] +|False +a| + +|interval +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policies.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policies.adoc new file mode 100644 index 00000000..ab9f89bb --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policies.adoc @@ -0,0 +1,238 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policies.html' +summary: 'List the snapshot policies associated with a system' +--- + += List the snapshot policies associated with a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policies`# + + + +Lists the snapshot policies associated with a system. The API will list the snapshot policies created on the cluster level for the specified system. The system ID is passed as a parameter for the API REST call. It returns the snapshot policies and the rules associated with the policies. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshot-policy +|array[link:#snapshot-policy[snapshot-policy]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshot-policy": [ + { + "id": "string", + "name": "string", + "rule": [ + { + "retention": "string", + "prefix": "string", + "label": "string", + "schedule-name": "string", + "cron": { + "minutes": [ + "integer" + ], + "hours": [ + "integer" + ], + "weekdays": [ + "integer" + ], + "days": [ + "integer" + ], + "months": [ + "integer" + ] + }, + "interval": "string" + } + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#cron] +[.api-collapsible-fifth-title] +cron + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|minutes +|array[integer] +|False +a| + +|hours +|array[integer] +|False +a| + +|weekdays +|array[integer] +|False +a| + +|days +|array[integer] +|False +a| + +|months +|array[integer] +|False +a| + +|=== + + +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|retention +|string +|False +a| + +|prefix +|string +|False +a| + +|label +|string +|False +a| + +|schedule-name +|string +|False +a| + +|cron +|link:#cron[cron] +|False +a| + +|interval +|string +|False +a| + +|=== + + +[#snapshot-policy] +[.api-collapsible-fifth-title] +snapshot-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|rule +|array[link:#rule[rule]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-list.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-list.adoc new file mode 100644 index 00000000..99cc5d00 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-list.adoc @@ -0,0 +1,157 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-list.html' +summary: 'Retrieve system volume directories' +--- + += Retrieve system volume directories + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/list`# + + + +Retrieves a list of system volume directories. You can run a query by using a target storage VM and the path of directories to browse within the volume. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|svm +|string +|query +|False +a| + +|path +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|volumeId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|context +|array[link:#context[context]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "context": [ + { + "name": "string", + "type": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#context] +[.api-collapsible-fifth-title] +context + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|inode +|number +|False +a| + +|name +|string +|False +a| + +|type +|string +|False +a| + +|size +|number +|False +a| + +|mtime +|number +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot.adoc new file mode 100644 index 00000000..4d56f7f3 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot.adoc @@ -0,0 +1,174 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot.html' +summary: 'Retrieve a list of snapshot details for a volume' +--- + += Retrieve a list of snapshot details for a volume + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot`# + + + +Retrieves a list of snapshot details pertaining to a specific volume in a particular system. The system ID, volume ID, and snapshot ID are passed as parameters for the REST API call. You can query by passing parameters to specify the maximum number of records that should be returned, the next subsequent snapshot UUID to get results from, and the next `CP-COUNT` from where the results should be fetched. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|max-records +|number +|query +|False +a| + +|cursor +|string +|query +|False +a| + +|cp-count +|number +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|volumeId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshot +|array[link:#snapshot[snapshot]] +|False +a| + +|num-records +|number +|False +a| + +|cursor +|string +|False +a| + +|cp-count +|number +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshot": [ + { + "id": "string", + "name": "string" + } + ], + "cursor": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#snapshot] +[.api-collapsible-fifth-title] +snapshot + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|size +|number +|False +a| + +|creation-time +|number +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume.adoc new file mode 100644 index 00000000..9419474c --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume.adoc @@ -0,0 +1,261 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume.html' +summary: 'Retrieve volumes' +--- + += Retrieve volumes + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume`# + + + +Retrieves a list of volumes and their details from a specific system. This API endpoint retrieves the name, file-system-id, status, storage VM, type, style, capacity allocated, capacity used, and SnapMirror label information. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|completeResponse +|boolean +|query +|False +a| + +|name +|string +|query +|False +a| + +|language +|string +|query +|False +a| + +|type +|string +|query +|False +a| + +|style +|string +|query +|False +a| + +|snaplockType +|string +|query +|False +a| + +|max-records +|number +|query +|False +a| + +|cursor +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volume +|array[link:#volume[volume]] +|False +a| + +|num-records +|number +|False +a| + +|cursor +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "volume": [ + { + "name": "string", + "file-system-id": "string", + "status": "string", + "svm": "string", + "type": "string", + "style": "string", + "snapmirror-label": [ + "string" + ], + "snaplock-type": "string", + "language": "string" + } + ], + "cursor": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#capacity] +[.api-collapsible-fifth-title] +capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|allocated +|number +|False +a| + +|used +|number +|False +a| + +|logicalUsedByAfs +|number +|False +a| + +|=== + + +[#volume] +[.api-collapsible-fifth-title] +volume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|file-system-id +|string +|False +a| + +|status +|string +|False +a| + +|svm +|string +|False +a| + +|type +|string +|False +a| + +|style +|string +|False +a| + +|capacity +|link:#capacity[capacity] +|False +a| + +|snapmirror-label +|array[string] +|False +a| + +|snaplock-type +|string +|False +a| + +|language +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment.adoc new file mode 100644 index 00000000..346e4cec --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment.adoc @@ -0,0 +1,185 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment.html' +summary: 'Retrieve systems' +--- + += Retrieve systems + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment`# + + + +Retrieves a list of systems and their details. This API endpoint retrieves the name, region, status, type, cloud-provider, provider-accountId, ontap-version, and total-volumes-count information. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|partial +|boolean +|query +|False +a| + +|cache +|boolean +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment +|array[link:#working-environment[working-environment]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "working-environment": [ + { + "id": "string", + "cluster-uuid": "string", + "name": "string", + "error": "string", + "region": "string", + "status": "string", + "ontap-version": "string", + "type": "string", + "provider": "string", + "provider-account-id": "string", + "total-volumes-count": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#working-environment] +[.api-collapsible-fifth-title] +working-environment + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|cluster-uuid +|string +|False +a| + +|name +|string +|False +a| + +|error +|string +|False +a| + +|region +|string +|False +a| + +|status +|string +|False +a| + +|ontap-version +|string +|False +a| + +|type +|string +|False +a| + +|provider +|string +|False +a| + +|provider-account-id +|string +|False +a|AWS account ID/ Azure subscription ID / Google Cloud project ID + + +|total-volumes-count +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v2-backup-working-environment.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v2-backup-working-environment.adoc new file mode 100644 index 00000000..f1ff1522 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v2-backup-working-environment.adoc @@ -0,0 +1,154 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v2-backup-working-environment.html' +summary: 'Retrieve the details of all the systems that are backed up' +--- + += Retrieve the details of all the systems that are backed up + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment`# + + + +Retrieves the details of all systems that are backed up using the NetApp Backup and Recovery service within an account. It retrieves backup enablement status, archive storage class, archive after days, catalog enablement status, auto enablement status, maximum transfer status, backup policy details, cloud storage pool, and remote MetroCluster ID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment +|array[link:#working-environment[working-environment]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "working-environment": [ + { + "id": "string", + "name": "string", + "publicId": "string", + "clusterId": "string", + "ontapVersion": "string", + "status": "string", + "type": "string", + "provider": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#working-environment] +[.api-collapsible-fifth-title] +working-environment + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|publicId +|string +|False +a| + +|clusterId +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|status +|string +|False +a| + +|type +|string +|False +a| + +|provider +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v2-gcp-credentials.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v2-gcp-credentials.adoc new file mode 100644 index 00000000..18d524bd --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v2-gcp-credentials.adoc @@ -0,0 +1,82 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v2-gcp-credentials.html' +summary: 'List Google Cloud credentials' +--- + += List Google Cloud credentials + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials`# + + + +Lists Google Cloud credentials in the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, List of google cloud credential ids +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ids +|array[string] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "ids": [ + "string" + ] +} +==== + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v2-sg.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v2-sg.adoc new file mode 100644 index 00000000..2ee7f9c0 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v2-sg.adoc @@ -0,0 +1,82 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v2-sg.html' +summary: 'List StorageGRID servers' +--- + += List StorageGRID servers + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/sg`# + + + +Lists the StorageGRID servers in the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, List of storagegrid server names +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ids +|array[string] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "ids": [ + "string" + ] +} +==== + diff --git a/cbs/get-account-providers-cloudmanager_cbs-api-v2-working-environment-svm.adoc b/cbs/get-account-providers-cloudmanager_cbs-api-v2-working-environment-svm.adoc new file mode 100644 index 00000000..2699d483 --- /dev/null +++ b/cbs/get-account-providers-cloudmanager_cbs-api-v2-working-environment-svm.adoc @@ -0,0 +1,191 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/get-account-providers-cloudmanager_cbs-api-v2-working-environment-svm.html' +summary: 'Retrieve a list of storage VMs' +--- + += Retrieve a list of storage VMs + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/svm`# + + + +Retrieves a list of storage VMs and their details from a specific system. This API retrieves the ID, name, and a list of aggregate objects that belongs to a storage VM. It also retrieves the aggregate disk type, aggregate tiering status, aggregate total size, and aggregate available size. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|svm +|array[link:#svm[svm]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "svm": [ + { + "id": "string", + "name": "string", + "aggregates": [ + { + "id": "string", + "name": "string", + "disktype": "string", + "snaplock-type": "string" + } + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#aggregates] +[.api-collapsible-fifth-title] +aggregates + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|disktype +|string +|False +a| + +|is-tiered +|boolean +|False +a| + +|totalsize +|number +|False +a| + +|available +|number +|False +a| + +|used +|number +|False +a| + +|snaplock-type +|string +|False +a| + +|=== + + +[#svm] +[.api-collapsible-fifth-title] +svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|aggregates +|array[link:#aggregates[aggregates]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/job_overview.adoc b/cbs/job_overview.adoc new file mode 100644 index 00000000..130edb62 --- /dev/null +++ b/cbs/job_overview.adoc @@ -0,0 +1,19 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/job_overview.html' +summary: 'Job endpoints in the NetApp Backup and Recovery REST API' +--- + += Job endpoints in the NetApp Backup and Recovery REST API + + + +The Job endpoints display information about jobs executed on the NetApp Console SaaS application. + +You can perform the following operation by using the Job endpoints: + +* Retrieve a list of jobs and job details. + + diff --git a/cbs/license_overview.adoc b/cbs/license_overview.adoc new file mode 100644 index 00000000..472645f7 --- /dev/null +++ b/cbs/license_overview.adoc @@ -0,0 +1,15 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/license_overview.html' +summary: 'License endpoints in the NetApp Backup and Recovery REST API' +--- + += License endpoints in the NetApp Backup and Recovery REST API + + + +The license endpoints enable you to retrieve the license validity of the systems from the NetApp Console SaaS application. A valid license is required to activate NetApp Backup and Recovery on a system, create backups of your production data, and restore backup data on a production system. This API retrieves the eligibility of the current license used and returns the days remaining if you are using a trial license. + + diff --git a/cbs/overview.adoc b/cbs/overview.adoc new file mode 100644 index 00000000..9a9cacfb --- /dev/null +++ b/cbs/overview.adoc @@ -0,0 +1,252 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/overview.html' +summary: 'NetApp Backup and Recovery REST API' +--- + += NetApp Backup and Recovery REST API + + + +NetApp Backup and Recovery is a service embedded within the NetApp Console platform that provides backup and restore capabilities for protection and long-term archiving of your data residing in Cloud Volumes ONTAP and on-premises ONTAP clusters (AFF/FAS/OTS). By using this service, you can automatically generate and store backups in an object store in the public or private cloud account of your choice, and you can easily restore data any time and to any location, as per your requirements. + +There are 17 categories of endpoints defined within the Backup and Recovery service: + +* backup +* catalog +* cloud +* configuration +* features +* job +* license +* migration +* object store +* restore +* single file-level restore (SFR) +* system +* StorageGRID (sg) +* ransomware scan +* panoramic protection +* replication +* reports + +NOTE: Before using the API reference documentation, review the https://docs.netapp.com/us-en/console-automation/platform/overview.html[Get started] section for the NetApp Console APIs. For more information about the security tokens and identifiers you'll need when using the API, review the Common workflows and tasks section https://docs.netapp.com/us-en/console-automation/platform/get_identifiers.html[Common workflows and tasks] section. + +{blank} + + +''' + +== ++++++REST implementation++++++ + +=== HTTP methods + +|=== +| Method | Description + +| `POST` +| Create an object instance + +| `GET` +| Retrieve an object instance or collection + +| `PATCH` +| Update an existing object + +| `DELETE` +| Remove an existing object +|=== + +=== Request headers + +|=== +| Request Header | Description + +| `Authorization` +| Required. Contains a JWT access token. + +| `X-Agent-Id` +| Required. Contains the Console agent ID. + +| `X-NetApp-Cache-Control` +| Using this header will bypass the local cache and retrieve actual data from upstream sources like a NetApp Console SaaS application and ONTAP clusters. +|=== + +=== Query parameters + +You can use query parameters with endpoints in the following components: + +|=== +| Component | Query Parameter + +| sfr +| accountId(required), + +volumeId, + +snapshotId. + + + +| backup +| accountId(required), + +workingEnvironmentId, + +volumeId, + +snapshotId. + + + +| restore +| accountId(required). + + + +| system +| accountId(required), + +workingEnvironmentId, + +volumeId, + +snapshotId. + +| cloud +| accountId(required), + +workingEnvironmentId, + +volumeId, + +snapshotId,awsAccountId, + +regionCode, + +subscriptionId, + +vaultName, + +projectId, + +jobId. + +| license +| accountId(required), + +workingEnvironmentId. + + + +| catalog +| accountId(required), + +workingEnvironmentId. + + + +| job +| accountId(required), + +jobId. +|=== + +=== Response headers + +This API uses the standard HTTP response headers common with all NetApp Console APIs. See https://docs.netapp.com/us-en/console-automation/platform/http_details.html#request-headers[REST implementation] for more information. + +=== HTTP status codes + +|=== +| HTTP Status Code | Description + +| `200` +| OK:Returned for successful operation completion + +| `400` +| Bad Request:Returned if the input is malformed and could not be parsed + +| `401` +| Unauthorized:Returned if user authentication failed or the token has expired + +| `403` +| Forbidden:Returned for authorization errors depending on the resource and token +|=== + +''' + +== *Error handling* + +There are two processes involved with error handling and processing. + +* The error is logged for supportability +* The error is also returned to the caller for any specific handling + +''' + +== *cURL examples* + +=== Retrieve specific volume details + +This example retrieves the details of a specific volume that has been backed up by using the Backup and Recovery service. + +.... + + curl -X GET "https://cloudmanager.cloud.netapp.com/account/(account_id)/providers/cloudmanager_cbs/api/v1/backup/working-environment/(working_environment_id)/volume/(volume_id)" -H "accept: application/json" -H "authorization: (user token)" +.... + +''' + +== *Frequently asked questions* + +**There are multiple versions of the same command. Which version should I use?** + +If there are multiple versions of the same API endpoint, make sure to use the latest version of the API. The version of each endpoint is mentioned in the path. + +**Whats the difference between a user token and service token and why do we need two types of token authorization ?** + +A user token is used for communication between a user (or the UI) and the NetApp Console REST APIs, whereas the service token is used for communication between two services (machine-to-machine interaction) in the NetApp Console platform. The type of token required to invoke an API is documented in the description of each endpoint. + +**What is the difference between SFR NetApp Backup and Recovery APIs and Catalog NetApp Backup and Recovery APIs?** + +The SFR NetApp Backup and Recovery APIs provide the option to use the "Browse and Restore" feature while performing a volume level or single/multiple file restore operation from backups stored on the cloud. The Catalog NetApp Backup and Recovery APIs have introduced a new "Search and Restore" feature, which enables you to search for a specific file from all backups stored on Amazon S3 cloud storage and then perform a restore operation. It enables you to perform a quick and focused search for files across all the backups in the cloud and gives you the option to narrow down the searches by using multiple search criteria. + +**Why has the export file system API endpoint under the SFR category been deprecated?** + +Previously, NetApp Backup and Recovery relied on an additional Cloud Restore VM instance for exporting the snapshots and creating a file list when you initiated a "File Restore" operation from the Restore dashboard. Instead of creating an additional cloud restore virtual machine (VM) instance during a file-level restore operation, the NetApp Backup and Recovery service deploys a restore container on the Agent VM instance. These containers contain the latest Active Data Agent image (version 1.4). This implementation does not require the file system to be exported, therefore the export file system API endpoint under the SFR category has been deprecated. + +**Why have the API endpoints under the jobs category changed?** + +The old job API endpoints have been replaced with a set of new job API endpoints. The functionality of the new endpoints differ from the old ones. Previously, the job endpoints were used to retrieve a list of jobs and the details of a particular job. The new job API endpoints allow services to create job entries, update the status of a job directly in the database, and retrieve the current status of a job from the database. + +''' + +== *How to use the Backup and Recovery REST APIs* + +**Getting started** + +To get started with the Backup and Recovery APIs, obtain a user token, a NetApp Console account ID, and the Console agent ID. When making API calls, add the user token in the Authorization header and the console agent ID in the X-Agent-Id header. Use the NetApp Console account ID in the APIs. + +**Obtain a user token from NetApp Console.** + +Make sure to generate the refresh token from the following link: https://services.cloud.netapp.com/refresh-token/. The refresh token is an alpha-numeric string that is used to generate a user token. + +.... + + curl -X GET "https://netapp-cloud-account.auth0.com/oauth/token?=" -H "Content-Type: application/json" -d "grant_type" "refresh_token", "refresh_token" "{REDACTED}", "client_id"{REDACTED}"} +.... + +**Obtain your NetApp Console account ID** + +.... + + curl -X GET "https://cloudmanager.cloud.netapp.com/tenancy/account" -H "accept: application/json" -H "authority: cloudmanager.cloud.netapp.com" -H "accept-language: en-GB,en;q=0.9" -H "authorization: Bearer {REDACTED}" +.... + +This API will return a response like the following. You can retrieve the account ID by parsing the output from [0].[ accountPublicId]. + +Response: + + "[{"accountPublicId":"{ACCOUNT_ID}","accountName":"{ACCOUNT_NAME}","isSaas":true,"isGov":false,"isPrivatePreviewEnabled":false,"is3rdPartyServicesEnabled":false,"accountSerial":"{REDACTED}","userRole":"Role-1"}………" + +**Obtain the X-Agent-Id that contains the Agent ID.** + +.... + + curl -X GET "https://api.services.cloud.netapp.com/occm/list-occms/{ACCOUNT_ID}?excludeStandalone=true&source=saas" -H "accept: application/json" -H "authority: api.services.cloud.netapp.com" -H "accept-language: en-GB,en;q=0.9" -H "authorization: Bearer {REDACTED}" +.... + +This API will return a response like the following. You can retrieve the agent ID by parsing the output from occm.[0].[agent].[agentId]. + +Response: + + "{"occms":[{"account":"{ACCOUNT_ID}","accountName":"{ACCOUNT_NAME}","occm":"{REDACTED}","agentId":"{REDACTED}","status":"ready","occmName":"{AGENT_NAME}","primaryCallbackUri":"","manualOverrideUris":[],"automaticCallbackUris":[],"createDate":"1652120369286","agent":{"useDockerInfra":true,"network":"default","name":"{AGENT_NAME}","agentId":"{REDACTED}","provider":"gcp","systemId":"{SYSTEM_ID}" + +**Example using the APIs** + +The following example shows an API call to activate a backup on a system with a new policy that has daily, hourly, and weekly labels set, and archive after days set as 180 days in East-US-2 region in Azure cloud. This enables backup only on a system but no volumes are backed up. If you choose "auto-backup-enabled": true, then any volumes already existing in the system are backed up and future volumes added. + +.... + + curl -X GET "https://cloudmanager.cloud.netapp.com/account/account-DpTFcxN3/providers/cloudmanager_cbs/api/v3/backup/working-environment/VsaWorkingEnvironment-99hPYEgk" -H "accept: application/json" -H "X-Agent-Id: {REDACTED}" -H "authorization: Bearer {REDACTED}" -d "{"provider":"AZURE","backup-policy": {"archive-after-days": 180,"rule": [{"label": "hourly","retention": "2"},{"label": "daily","retention": "30"},{"label": "weekly", "retention": "52"}]},"ip-space": "Default","region": "eastus2","azure": {"resource-group": "rn-test-backup-rg", "subscription": "3beb4dd0-25d4-464f-9bb0-303d7cf5c0c2"}}" +.... + + diff --git a/cbs/panoramic_protection_overview.adoc b/cbs/panoramic_protection_overview.adoc new file mode 100644 index 00000000..31a42053 --- /dev/null +++ b/cbs/panoramic_protection_overview.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/panoramic_protection_overview.html' +summary: 'Panoramic protection endpoints in the NetApp Backup and Recovery REST API' +--- + += Panoramic protection endpoints in the NetApp Backup and Recovery REST API + + + +The Panoramic Protection API enables you to automate the complete 3-2-1 backup spectrum using a single control plane to simplify your implementation of the various components of 3-2-1 model where they are needed, without using multiple resource managers and assistance from specially trained personnel. You can configure backups either in a cascading workflow or fan-out workflow. You can perform the following operations by using the Panoramic Protection endpoints: + +* Enable 3-2-1 backup on systems by creating the required cluster-peering for replication and the required object-store buckets for backup to cloud in cascading or fan-out topologies. + + +* Modify 3-2-1 backup on systems by configuring the setup required for replication or backup to cloud, to create cascading or fan-out topologies. + + +* Create 3-2-1 cascading or fan-out backup topologies by configuring volume replication and backup to cloud relationship. + + +* Modify or add 3-2-1 backup on volumes by configuring replication or backup to cloud, to create cascading or fan-out topologies. + + diff --git a/cbs/patch-account-providers-cloudmanager_cbs-api-v1-replication-working-environment-relationship.adoc b/cbs/patch-account-providers-cloudmanager_cbs-api-v1-replication-working-environment-relationship.adoc new file mode 100644 index 00000000..020099b4 --- /dev/null +++ b/cbs/patch-account-providers-cloudmanager_cbs-api-v1-replication-working-environment-relationship.adoc @@ -0,0 +1,212 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/patch-account-providers-cloudmanager_cbs-api-v1-replication-working-environment-relationship.html' +summary: 'Perform an action on a volume with SnapMirror replication' +--- + += Perform an action on a volume with SnapMirror replication + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/replication/working-environment/{workingEnvironmentId}/relationship`# + + + +Performs an action on a volume that has SnapMirror replication enabled. Using this API, you will be able to perform a SnapMirror relationship update, delete, pause, resync, reverse-resync, abort, and resume functionality on a replicated volume. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|update-backup-inventory +|boolean +|query +|False +a|Updates snapshot information in the database after a transfer to the object store. Default value is false. + +* Default value: + + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|relationships +|array[link:#relationships[relationships]] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "relationships": [ + { + "working-environment-id": "string", + "relationship-id": "string", + "mode": "string", + "source-volume-id": "string", + "source-snapshot": "string" + } + ] +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#relationships] +[.api-collapsible-fifth-title] +relationships + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-id +|string +|True +a|System ID (replication ONTAP cluster) where the relationship resides + + +|relationship-id +|string +|True +a| + +|mode +|string +|True +a|Action to perform on replicated volume + + +|create-snapshot +|boolean +|False +a|Boolean variable describing whether to create a snapshot on the source volume. + + +|source-volume-id +|string +|False +a|ID of the source volume + + +|source-snapshot +|string +|False +a|Snapshot name to be transferred when mode is UPDATE. This parameter is optional and is exclusive to create-snapshot being true. + + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|relationships +|array[link:#relationships[relationships]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/patch-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy-.adoc b/cbs/patch-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy-.adoc new file mode 100644 index 00000000..7dfc9741 --- /dev/null +++ b/cbs/patch-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy-.adoc @@ -0,0 +1,172 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/patch-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy-.html' +summary: 'Modify a replication policy in a system' +--- + += Modify a replication policy in a system + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy/{policyId}`# + + + +Modifies a replication policy in a system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|policyId +|string +|path +|True +a|Replication policy UUID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|rule +|array[link:#rule[rule]] +|False +a| + +|transfer-schedule +|string +|False +a|Cron-based schedule for transfers. To disable the schedule, pass the value as: none(case sensitive). By default, an hourly schedule is selected. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "transfer-schedule": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|rule +|array[link:#rule[rule]] +|False +a| + +|transfer-schedule +|string +|False +a|Cron-based schedule for transfers. To disable the schedule, pass the value as: none(case sensitive). By default, an hourly schedule is selected. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/patch-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policy-.adoc b/cbs/patch-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policy-.adoc new file mode 100644 index 00000000..fabafe3e --- /dev/null +++ b/cbs/patch-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policy-.adoc @@ -0,0 +1,186 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/patch-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policy-.html' +summary: 'Modify the snapshot policy in a system' +--- + += Modify the snapshot policy in a system + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policy/{policyId}`# + + + +Modifies the snapshot policy in a system. For existing schedules attached to a snapshot policy, the SnapMirror label and count can be modified, it also supports the addition and removal of schedules. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|policyId +|string +|path +|True +a|Snapshot Policy ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|rules +|array[link:#rules[rules]] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "rules": [ + {} + ] +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rules] +[.api-collapsible-fifth-title] +rules + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|label +|string +|True +a|Label for SnapMirror operations + + +|count +|number +|True +a|Number of snapshots to maintain for this rule + + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|rules +|array[link:#rules[rules]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resource-group.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resource-group.adoc new file mode 100644 index 00000000..055c0c4d --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resource-group.adoc @@ -0,0 +1,161 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resource-group.html' +summary: 'Create an Azure resource group' +--- + += Create an Azure resource group + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resource-group`# + + + +Creates an Azure resource group in the specified subscription ID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|subscriptionId +|string +|path +|True +a|Subscription ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the resource group to be created + + +|region +|string +|True +a|Region where the resource group needs to be created + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "region": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|state +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "state": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the resource group to be created + + +|region +|string +|True +a|Region where the resource group needs to be created + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-catalog-search.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-catalog-search.adoc new file mode 100644 index 00000000..7501b13f --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-catalog-search.adoc @@ -0,0 +1,393 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-catalog-search.html' +summary: 'Search a specific file' +--- + += Search a specific file + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/search`# + + + +Searches for a specific file from the backups taken by the NetApp Backup and Recovery service across volumes and systems. It can also search for a specified volume. It is possible to narrow down your file search based on a particular system, file extensions, size ranges, creation date range, and also location of a backup. + +**Token usage:**NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|query +|string +|query +|True +a|Search string + + +|jobId +|string +|query +|False +a| + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a|Type of resource file/volume + + +|workingEnvironmentId +|array[string] +|False +a| + +|fileExtension +|array[string] +|False +a|File extension + + +|size +|link:#size[size] +|False +a|Resource size in bytes + + +|creationDate +|link:#creationDate[creationDate] +|False +a|Creation date in milliseconds + + +|backupLocation +|string +|False +a|Snapshot location local/cloud + + +|volumeId +|string +|False +a|Volume ID + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "type": "string", + "workingEnvironmentId": [ + "string" + ], + "fileExtension": [ + "string" + ], + "backupLocation": "string", + "volumeId": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|results +|array[link:#results[results]] +|False +a| + +|endOfResults +|boolean +|False +a| + +|status +|string +|False +a| + +|message +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "results": [ + { + "resourceName": "string", + "resourceType": "string", + "workingEnvironmentId": "string", + "workingEnvironmentName": "string", + "svmName": "string", + "volumeId": "string", + "volumeName": "string" + } + ], + "status": "string", + "message": "string" +} +==== + +== Response + +``` +Status: 202, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#size] +[.api-collapsible-fifth-title] +size + +Resource size in bytes + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|from +|number +|False +a| + +|to +|number +|False +a| + +|=== + + +[#creationDate] +[.api-collapsible-fifth-title] +creationDate + +Creation date in milliseconds + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|from +|number +|False +a| + +|to +|number +|False +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a|Type of resource file/volume + + +|workingEnvironmentId +|array[string] +|False +a| + +|fileExtension +|array[string] +|False +a|File extension + + +|size +|link:#size[size] +|False +a|Resource size in bytes + + +|creationDate +|link:#creationDate[creationDate] +|False +a|Creation date in milliseconds + + +|backupLocation +|string +|False +a|Snapshot location local/cloud + + +|volumeId +|string +|False +a|Volume ID + + +|=== + + +[#results] +[.api-collapsible-fifth-title] +results + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resourceName +|string +|False +a| + +|resourceType +|string +|False +a| + +|workingEnvironmentId +|string +|False +a| + +|workingEnvironmentName +|string +|False +a| + +|svmName +|string +|False +a| + +|volumeId +|string +|False +a| + +|volumeName +|string +|False +a| + +|resourceSize +|number +|False +a| + +|inode +|number +|False +a| + +|mtime +|number +|False +a| + +|latestSnapshotCreationTime +|number +|False +a| + +|snapshotsCount +|number +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-catalog-snapshots.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-catalog-snapshots.adoc new file mode 100644 index 00000000..587bffb0 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-catalog-snapshots.adoc @@ -0,0 +1,316 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-catalog-snapshots.html' +summary: 'Retrieve snapshots' +--- + += Retrieve snapshots + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/snapshots`# + + + +Retrieves a list of local and cloud snapshots related to a particular volume by using the catalog index query. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resourceName +|string +|True +a| + +|workingEnvironmentId +|string +|True +a| + +|volumeId +|string +|True +a| + +|resourceType +|string +|True +a| + +|inode +|string +|False +a| + +|mtime +|number +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "resourceName": "string", + "workingEnvironmentId": "string", + "volumeId": "string", + "resourceType": "string", + "inode": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|results +|link:#results[results] +|False +a| + +|endOfResults +|boolean +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "results": { + "workingEnvironmentId": "string", + "workingEnvironmentName": "string", + "volumeName": "string", + "volumeId": "string", + "snapshots": [ + { + "snapshotId": "string", + "snapshotName": "string", + "location": "string", + "ransomware-scan-status-failure": "string", + "object-lock": "string", + "ransomware-scan-status": "string" + } + ] + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resourceName +|string +|True +a| + +|workingEnvironmentId +|string +|True +a| + +|volumeId +|string +|True +a| + +|resourceType +|string +|True +a| + +|inode +|string +|False +a| + +|mtime +|number +|False +a| + +|=== + + +[#snapshots] +[.api-collapsible-fifth-title] +snapshots + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotId +|string +|False +a| + +|snapshotName +|string +|False +a| + +|snapshotSize +|number +|False +a| + +|snapshotCreationTime +|number +|False +a| + +|location +|string +|False +a| + +|last-ransomware-scan +|number +|False +a| + +|ransomware-scan-status-failure +|string +|False +a| + +|object-lock +|string +|False +a| + +|ransomware-scan-status +|string +|False +a| + +|archived +|boolean +|False +a| + +|=== + + +[#results] +[.api-collapsible-fifth-title] +results + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|False +a| + +|workingEnvironmentName +|string +|False +a| + +|volumeName +|string +|False +a| + +|volumeId +|string +|False +a| + +|snapshots +|array[link:#snapshots[snapshots]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-migration-validate.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-migration-validate.adoc new file mode 100644 index 00000000..07da0a28 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-migration-validate.adoc @@ -0,0 +1,186 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-migration-validate.html' +summary: 'Validate migration operations' +--- + += Validate migration operations + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/migration/validate`# + + + +Validates the migration of backups from the source ONTAP cluster to the target ONTAP cluster. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a| +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sourceWorkingEnvironmentId +|string +|True +a| + +|migrationWorkingEnvironmentId +|string +|True +a| + +|migrationMappingDetails +|array[link:#migrationMappingDetails[migrationMappingDetails]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "sourceWorkingEnvironmentId": "string", + "migrationWorkingEnvironmentId": "string", + "migrationMappingDetails": [ + { + "sourceVolumeUuid": "string", + "migratedVolumeUuid": "string", + "policyName": "string" + } + ] +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#migrationMappingDetails] +[.api-collapsible-fifth-title] +migrationMappingDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sourceVolumeUuid +|string +|False +a| + +|migratedVolumeUuid +|string +|False +a| + +|policyName +|string +|False +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sourceWorkingEnvironmentId +|string +|True +a| + +|migrationWorkingEnvironmentId +|string +|True +a| + +|migrationMappingDetails +|array[link:#migrationMappingDetails[migrationMappingDetails]] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-migration.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-migration.adoc new file mode 100644 index 00000000..3466e04a --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-migration.adoc @@ -0,0 +1,361 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-migration.html' +summary: 'Trigger backup migration' +--- + += Trigger backup migration + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/migration`# + + + +Triggers the migration of backups from the source ONTAP cluster to the target ONTAP cluster. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a| +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sourceWorkingEnvironmentId +|string +|True +a| + +|migrationWorkingEnvironmentId +|string +|True +a| + +|migrationMappingDetails +|array[link:#migrationMappingDetails[migrationMappingDetails]] +|True +a| + +|ip-space +|string +|False +a|Required input field for on-premises use cases + + +|aws +|link:#aws[aws] +|False +a| + +|azure +|link:#azure[azure] +|False +a| + +|gcp +|link:#gcp[gcp] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "sourceWorkingEnvironmentId": "string", + "migrationWorkingEnvironmentId": "string", + "migrationMappingDetails": [ + { + "sourceVolumeUuid": "string", + "migratedVolumeUuid": "string", + "policyName": "string" + } + ], + "ip-space": "string", + "aws": { + "private-endpoint": { + "id": "string" + } + }, + "azure": { + "private-endpoint": { + "subnet": "string" + } + }, + "gcp": { + "access-key": "string", + "secret-password": "string" + } +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#migrationMappingDetails] +[.api-collapsible-fifth-title] +migrationMappingDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sourceVolumeUuid +|string +|False +a| + +|migratedVolumeUuid +|string +|False +a| + +|policyName +|string +|False +a| + +|=== + + +[#private-endpoint] +[.api-collapsible-fifth-title] +private-endpoint + +Required input field for on-premises use case for private link configuration + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a|Optional input field for a private endpoint + + +|=== + + +[#aws] +[.api-collapsible-fifth-title] +aws + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|private-endpoint +|link:#private-endpoint[private-endpoint] +|False +a|Required input field for on-premises use case for private link configuration + + +|=== + + +[#private-endpoint] +[.api-collapsible-fifth-title] +private-endpoint + +Required input field for private link configuration + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subnet +|string +|False +a|Required input field for on-premises private link configuration + + +|skip-creation +|boolean +|False +a|Optional input field to skip private endpoint creation + + +|=== + + +[#azure] +[.api-collapsible-fifth-title] +azure + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|private-endpoint +|link:#private-endpoint[private-endpoint] +|False +a|Required input field for private link configuration + + +|=== + + +[#gcp] +[.api-collapsible-fifth-title] +gcp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|access-key +|string +|False +a|Required input field for on-premises use cases + + +|secret-password +|string +|False +a|Required input field for on-premises use cases + + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sourceWorkingEnvironmentId +|string +|True +a| + +|migrationWorkingEnvironmentId +|string +|True +a| + +|migrationMappingDetails +|array[link:#migrationMappingDetails[migrationMappingDetails]] +|True +a| + +|ip-space +|string +|False +a|Required input field for on-premises use cases + + +|aws +|link:#aws[aws] +|False +a| + +|azure +|link:#azure[azure] +|False +a| + +|gcp +|link:#gcp[gcp] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-object-storage.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-object-storage.adoc new file mode 100644 index 00000000..00bbfcda --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-object-storage.adoc @@ -0,0 +1,556 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-object-storage.html' +summary: 'Create a bucket for a cloud provider' +--- + += Create a bucket for a cloud provider + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage`# + + + +Creates a bucket for the specified cloud provider. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|account-id +|string +|query +|False +a|Account ID for the AWS provider + + +|project-id +|string +|query +|False +a|Project ID for the Google Cloud provider + + +|resource-group +|string +|query +|False +a|Resource group for the Azure provider + + +|subscription +|string +|query +|False +a|Subscription for the Azure provider + + +|credential-id +|string +|query +|False +a|Credential ID for the SGWS or ONTAP S3 provider + + +|accountId +|string +|path +|True +a|Account ID + + +|job-id +|string +|header +|True +a|Job ID for the create bucket operation + + +|authorization +|string +|header +|True +a|Authorization token + + +|X-Agent-Id +|string +|header +|True +a|Agent ID + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provider +|string +|True +a|Cloud provider + + +|region +|string +|True +a|Region + + +|object-lock +|string +|True +a|Object lock mode + + +|object-store-name +|string +|True +a|Object store name + + +|tags +|array[link:#tags[tags]] +|False +a| + +|aws +|link:#aws[aws] +|False +a| + +|azure +|link:#azure[azure] +|False +a| + +|gcp +|link:#gcp[gcp] +|False +a| + +|sgws +|link:#sgws[sgws] +|False +a| + +|ontap-s3 +|link:#ontap-s3[ontap-s3] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "provider": "string", + "region": "string", + "object-lock": "string", + "object-store-name": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ], + "aws": { + "account-id": "string", + "kms-key-id": "string", + "private-endpoint": { + "id": "string" + }, + "archive-storage-class": "string" + }, + "azure": { + "resource-group": "string", + "storage-account": "string", + "subscription": "string", + "private-endpoint": { + "subnet": "string" + }, + "key-vault": { + "key-vault-id": "string", + "key-name": "string" + } + }, + "gcp": { + "project-id": "string", + "kms": { + "key-ring-id": "string", + "crypto-key-id": "string" + } + }, + "sgws": { + "credential-id": "string" + }, + "ontap-s3": { + "credential-id": "string" + } +} +==== + +== Response + +``` +Status: 202, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#tags] +[.api-collapsible-fifth-title] +tags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|Tag key + + +|value +|string +|True +a|Tag value + + +|=== + + +[#private-endpoint] +[.api-collapsible-fifth-title] +private-endpoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|AWS private endpoint ID + + +|=== + + +[#aws] +[.api-collapsible-fifth-title] +aws + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|account-id +|string +|True +a|AWS account ID + + +|kms-key-id +|string +|False +a|AWS KMS key ID + + +|private-endpoint +|link:#private-endpoint[private-endpoint] +|False +a| + +|archive-storage-class +|string +|False +a|AWS archive storage class + + +|=== + + +[#private-endpoint] +[.api-collapsible-fifth-title] +private-endpoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subnet +|string +|True +a|Azure private endpoint subnet + + +|=== + + +[#key-vault] +[.api-collapsible-fifth-title] +key-vault + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key-vault-id +|string +|True +a|Azure Key Vault ID + + +|key-name +|string +|True +a|Azure Key Vault key name + + +|=== + + +[#azure] +[.api-collapsible-fifth-title] +azure + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resource-group +|string +|True +a|Azure resource group + + +|storage-account +|string +|True +a|Azure storage account + + +|subscription +|string +|True +a|Azure subscription + + +|private-endpoint +|link:#private-endpoint[private-endpoint] +|False +a| + +|key-vault +|link:#key-vault[key-vault] +|False +a| + +|=== + + +[#kms] +[.api-collapsible-fifth-title] +kms + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key-ring-id +|string +|True +a|Google Cloud KMS key ring ID + + +|crypto-key-id +|string +|True +a|Google Cloud KMS crypto key ID + + +|=== + + +[#gcp] +[.api-collapsible-fifth-title] +gcp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|project-id +|string +|True +a|Google Cloud project ID + + +|kms +|link:#kms[kms] +|False +a| + +|=== + + +[#sgws] +[.api-collapsible-fifth-title] +sgws + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credential-id +|string +|True +a| + +|=== + + +[#ontap-s3] +[.api-collapsible-fifth-title] +ontap-s3 + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credential-id +|string +|True +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provider +|string +|True +a|Cloud provider + + +|region +|string +|True +a|Region + + +|object-lock +|string +|True +a|Object lock mode + + +|object-store-name +|string +|True +a|Object store name + + +|tags +|array[link:#tags[tags]] +|False +a| + +|aws +|link:#aws[aws] +|False +a| + +|azure +|link:#azure[azure] +|False +a| + +|gcp +|link:#gcp[gcp] +|False +a| + +|sgws +|link:#sgws[sgws] +|False +a| + +|ontap-s3 +|link:#ontap-s3[ontap-s3] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-.adoc new file mode 100644 index 00000000..d5589768 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-.adoc @@ -0,0 +1,937 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-.html' +summary: 'Activate comprehensive protection in a system (v1)' +--- + += Activate comprehensive protection in a system (v1) + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}`# + + + +Activates comprehensive protection in a system. Based on the cascading or fan-out backup workflow selected on the system, the API verifies whether a cluster peering relationship exists between primary and secondary clusters to set up replication. It creates a cluster peering relationship between the two clusters if one does not exist. To create a backup to cloud relationship, the API enables backup on the system and creates a bucket to which the backup will be transferred. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provider +|string +|False +a|Required input field for on-premises use cases + +* enum: ["AWS", "AZURE", "GCP", "SGWS", "ONTAP_S3", "S3_COMPATIBLE"] + + +|region +|string +|False +a|Required input field for on-premises use cases + + +|aws +|link:#aws[aws] +|False +a| + +|azure +|link:#azure[azure] +|False +a| + +|gcp +|link:#gcp[gcp] +|False +a| + +|sgws +|link:#sgws[sgws] +|False +a| + +|ontap-s3 +|link:#ontap-s3[ontap-s3] +|False +a| + +|s3-compatible +|link:#s3-compatible[s3-compatible] +|False +a| + +|bucket +|string +|False +a|Optional input + + +|ip-space +|string +|False +a|Required input field for on-premises use cases + + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|auto-backup-enabled +|boolean +|False +a|Automatically backs up all volumes in the system + + +|max-transfer-rate +|number +|False +a|Modifies node-level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies unlimited throttling + + +|export-existing-snapshots +|boolean +|False +a|Exports pre-existing snapshots to object storage + + +|architecture +|string +|False +a|Type of storage architecture. Fan-out or Cascading + + +|snapshot-policy +|string +|False +a|Snapshot policy name + + +|replication-target +|link:#replication-target[replication-target] +|False +a| + +|fix-mismatch-labels +|boolean +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "provider": "string", + "region": "string", + "aws": { + "account-id": "string", + "access-key": "string", + "secret-password": "string", + "kms-key-id": "string", + "private-endpoint": { + "id": "string" + }, + "archive-storage-class": "string" + }, + "azure": { + "resource-group": "string", + "storage-account": "string", + "subscription": "string", + "private-endpoint": { + "subnet": "string" + }, + "key-vault": { + "key-vault-id": "string", + "key-name": "string" + } + }, + "gcp": { + "project-id": "string", + "access-key": "string", + "secret-password": "string", + "kms": { + "key-ring-id": "string", + "crypto-key-id": "string" + } + }, + "sgws": { + "storage-grid-id": "string", + "storage-server": "string", + "access-key": "string", + "secret-password": "string" + }, + "ontap-s3": { + "storage-server": "string", + "access-key": "string", + "secret-password": "string" + }, + "s3-compatible": { + "storage-server": "string", + "access-key": "string", + "secret-password": "string" + }, + "bucket": "string", + "ip-space": "string", + "backup-policy": { + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "archive-after-days": "string", + "object-lock": "string", + "sgws-archival": { + "cloud-storage-pool": { + "provider": "string", + "provider-account-id": "string", + "region": "string", + "access-key": "string", + "secret-password": "string", + "archive-storage-class": "string", + "resource-group": "string" + } + } + }, + "architecture": "string", + "snapshot-policy": "string", + "replication-target": { + "policy-name": "string", + "working-environment-id": "string", + "working-environment-name": "string", + "svm": "string", + "prefix": "string", + "suffix": "string", + "aggregates": [ + "string" + ] + } +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#private-endpoint] +[.api-collapsible-fifth-title] +private-endpoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a|Optional input field for a private endpoint + + +|=== + + +[#aws] +[.api-collapsible-fifth-title] +aws + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|account-id +|string +|False +a|Required when the provider is AWS + + +|access-key +|string +|False +a|Required input field for on-premises use cases + + +|secret-password +|string +|False +a|Required input field for on-premises use cases + + +|kms-key-id +|string +|False +a|Optional input field for customer managed key use case + + +|private-endpoint +|link:#private-endpoint[private-endpoint] +|False +a| + +|archive-storage-class +|string +|False +a|Required for AWS to specify which storage class to use for archiving + + +|=== + + +[#private-endpoint] +[.api-collapsible-fifth-title] +private-endpoint + +Required input field for private link configuration + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subnet +|string +|False +a|Required input field for on-premises private link configuration + + +|skip-creation +|boolean +|False +a|Optional input field to skip private endpoint creation + + +|=== + + +[#key-vault] +[.api-collapsible-fifth-title] +key-vault + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key-vault-id +|string +|False +a| + +|key-name +|string +|False +a| + +|=== + + +[#azure] +[.api-collapsible-fifth-title] +azure + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resource-group +|string +|False +a|Required when the provider is Azure + + +|storage-account +|string +|False +a|Required when the provider is Azure + + +|subscription +|string +|False +a|Required when the provider is Azure + + +|private-endpoint +|link:#private-endpoint[private-endpoint] +|False +a|Required input field for private link configuration + + +|key-vault +|link:#key-vault[key-vault] +|False +a| + +|=== + + +[#kms] +[.api-collapsible-fifth-title] +kms + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key-ring-id +|string +|False +a| + +|crypto-key-id +|string +|False +a| + +|=== + + +[#gcp] +[.api-collapsible-fifth-title] +gcp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|project-id +|string +|False +a|Required when the provider is Google Cloud + + +|access-key +|string +|False +a|Required input field for on-premises use cases + + +|secret-password +|string +|False +a|Required input field for on-premises use cases + + +|kms +|link:#kms[kms] +|False +a| + +|=== + + +[#sgws] +[.api-collapsible-fifth-title] +sgws + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-grid-id +|string +|False +a|StorageGRID ID. Required input field for StorageGRID provider + + +|storage-server +|string +|False +a|StorageGRID server URL. Required input field for a StorageGRID provider + + +|access-key +|string +|False +a|Required input field for on-premises use cases + + +|secret-password +|string +|False +a|Required input field for on-premises use cases + + +|=== + + +[#ontap-s3] +[.api-collapsible-fifth-title] +ontap-s3 + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server +|string +|False +a|ONTAP S3 server URL. Required input field for ONTAP_S3 provider + + +|access-key +|string +|False +a|Required input field for on-premises use cases + + +|secret-password +|string +|False +a|Required input field for on-premises use cases + + +|=== + + +[#s3-compatible] +[.api-collapsible-fifth-title] +s3-compatible + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server +|string +|False +a|s3 storage server + + +|access-key +|string +|False +a|Required input field for on-premises use cases + + +|secret-password +|string +|False +a|Required input field for on-premises use cases + + +|=== + + +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#cloud-storage-pool] +[.api-collapsible-fifth-title] +cloud-storage-pool + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provider +|string +|True +a|Cloud provider where the cloud storage pool will be hosted + + +|provider-account-id +|string +|True +a|Cloud provider account ID where the cloud storage pool will be hosted + + +|region +|string +|True +a|Cloud provider region where the cloud storage pool will be hosted + + +|access-key +|string +|False +a|Required input field if the provider is AWS + + +|secret-password +|string +|False +a|Required input field if the provider is AWS + + +|archive-storage-class +|string +|False +a|Required for AWS to specify which storage class to use for archiving + + +|resource-group +|string +|False +a|Required when the provider is Azure + + +|=== + + +[#sgws-archival] +[.api-collapsible-fifth-title] +sgws-archival + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloud-storage-pool +|link:#cloud-storage-pool[cloud-storage-pool] +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Required input + + +|rule +|array[link:#rule[rule]] +|False +a| + +|archive-after-days +|string +|False +a| + +|object-lock +|string +|False +a| + +|sgws-archival +|link:#sgws-archival[sgws-archival] +|False +a| + +|=== + + +[#replication-target] +[.api-collapsible-fifth-title] +replication-target + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policy-name +|string +|False +a| + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|svm +|string +|False +a| + +|prefix +|string +|False +a| + +|suffix +|string +|False +a| + +|aggregates +|array[string] +|False +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provider +|string +|False +a|Required input field for on-premises use cases + +* enum: ["AWS", "AZURE", "GCP", "SGWS", "ONTAP_S3", "S3_COMPATIBLE"] + + +|region +|string +|False +a|Required input field for on-premises use cases + + +|aws +|link:#aws[aws] +|False +a| + +|azure +|link:#azure[azure] +|False +a| + +|gcp +|link:#gcp[gcp] +|False +a| + +|sgws +|link:#sgws[sgws] +|False +a| + +|ontap-s3 +|link:#ontap-s3[ontap-s3] +|False +a| + +|s3-compatible +|link:#s3-compatible[s3-compatible] +|False +a| + +|bucket +|string +|False +a|Optional input + + +|ip-space +|string +|False +a|Required input field for on-premises use cases + + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|auto-backup-enabled +|boolean +|False +a|Automatically backs up all volumes in the system + + +|max-transfer-rate +|number +|False +a|Modifies node-level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies unlimited throttling + + +|export-existing-snapshots +|boolean +|False +a|Exports pre-existing snapshots to object storage + + +|architecture +|string +|False +a|Type of storage architecture. Fan-out or Cascading + + +|snapshot-policy +|string +|False +a|Snapshot policy name + + +|replication-target +|link:#replication-target[replication-target] +|False +a| + +|fix-mismatch-labels +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-volume.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-volume.adoc new file mode 100644 index 00000000..b8f2f2bb --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-volume.adoc @@ -0,0 +1,352 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-volume.html' +summary: 'Enable comprehensive panoramic protection for multiple volumes (v1)' +--- + += Enable comprehensive panoramic protection for multiple volumes (v1) + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}/volume`# + + + +Enables comprehensive panoramic protection for multiple volumes. Based on the backup workflow chosen, Cascading or Fan-Out, the API creates a replication relationship with a volume in the secondary cluster and then creates a backup to cloud relationship with a cloud or StorageGRID object store. While setting up the replication relationship, the API verifies whether a cluster peering relationship is set up between primary and secondary clusters. If there is no relationship, it creates a cluster peering relationship, storage VM peering, and a DP volume on the secondary cluster. Once the replication setup is complete, the API performs a SnapMirror Create and Initialize operation. For creating a backup to cloud, it first creates a bucket to which the backup is transferred, and then a SnapMirror cloud relationship is created and initialized. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volume +|array[link:#volume[volume]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "volume": [ + {} + ] +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Required input + + +|rule +|array[link:#rule[rule]] +|False +a| + +|archive-after-days +|string +|False +a| + +|object-lock +|string +|False +a| + +|=== + + +[#replication] +[.api-collapsible-fifth-title] +replication + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|svm +|string +|False +a| + +|policy-name +|string +|False +a| + +|prefix +|string +|False +a| + +|suffix +|string +|False +a| + +|destination-aggregates +|array[string] +|False +a| + +|=== + + +[#is-enabled] +[.api-collapsible-fifth-title] +is-enabled + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|local-snapshot +|boolean +|False +a| + +|replication +|boolean +|False +a| + +|cloud-backup +|boolean +|False +a| + +|=== + + +[#volume] +[.api-collapsible-fifth-title] +volume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volume-id +|string +|True +a| + +|volume-name +|string +|False +a| + +|workload +|string +|False +a|Workload type of the volume. Currently only SQL, VOLUMES, VMWARE, ORACLE, HYPERV, K8S, KVM workloads are supported + + +|architecture +|string +|False +a|Type of storage architecture. Fan-out or Cascading + + +|mode +|string +|False +a| + +|type +|string +|False +a| + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|snapshot-policy +|string +|False +a|Snapshot policy name + + +|replication +|link:#replication[replication] +|False +a| + +|is-enabled +|link:#is-enabled[is-enabled] +|True +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volume +|array[link:#volume[volume]] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-ransomware-working-environment-volume-snapshot-.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-ransomware-working-environment-volume-snapshot-.adoc new file mode 100644 index 00000000..a07dbfe7 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-ransomware-working-environment-volume-snapshot-.adoc @@ -0,0 +1,98 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-ransomware-working-environment-volume-snapshot-.html' +summary: 'Initiate a ransomware scan' +--- + += Initiate a ransomware scan + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/ransomware/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}`# + + + +Initiates a ransomware scan on the specified cloud backup related to a volume snapshot transferred by the SnapMirror - Cloud engine to the cloud object storage system. It scans only cloud backups. It does not support scanning local snapshots. Ransomware attacks on local snapshots cannot be detected. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|volumeId +|string +|path +|True +a| + +|snapshotId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-report.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-report.adoc new file mode 100644 index 00000000..df3dbf53 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-report.adoc @@ -0,0 +1,200 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-report.html' +summary: 'Generate an inventory report' +--- + += Generate an inventory report + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/report`# + + + +Generates an inventory report. You can create the inventory report for the whole account or a specific list of systems. It is also possible to generate reports for storage VMs under a system. By setting the "inventory-type" as "BACKUP", you can create a report for the backup actions. By setting it as "ALL", you can create a report for all the actions. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|inventory-type +|string +|False +a| + +|protection-type +|string +|False +a| + +|returnSnapshots +|boolean +|False +a| + +|filters +|array[link:#filters[filters]] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "inventory-type": "string", + "protection-type": "string", + "filters": [ + { + "working-environment-id": "string", + "svm": [ + "string" + ] + } + ] +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#filters] +[.api-collapsible-fifth-title] +filters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-id +|string +|False +a| + +|svm +|array[string] +|False +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|inventory-type +|string +|False +a| + +|protection-type +|string +|False +a| + +|returnSnapshots +|boolean +|False +a| + +|filters +|array[link:#filters[filters]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-revert-working-environment-volume-.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-revert-working-environment-volume-.adoc new file mode 100644 index 00000000..de7d3ec0 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-revert-working-environment-volume-.adoc @@ -0,0 +1,153 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-revert-working-environment-volume-.html' +summary: 'Revert a snapshot for a volume' +--- + += Revert a snapshot for a volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/revert/working-environment/{workingEnvironmentId}/volume/{volumeId}`# + + + +Reverts a snapshot for a volume. It restores a snapshot to be the read-write parent volume for the volume family. This replaces the current working copy of the volume with the snapshot that results in a loss of all changes made since the snapshot was created. The system ID and volume ID are passed as parameters in the API REST call and the required snapshot to which the volume needs to restored to should be sent in the input body of the REST API. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|volumeId +|string +|path +|True +a|Volume ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshot-name +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshot-name": "string" +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshot-name +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-file-explore-start.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-file-explore-start.adoc new file mode 100644 index 00000000..f0b7614a --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-file-explore-start.adoc @@ -0,0 +1,113 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-file-explore-start.html' +summary: 'Start a file and folder explore operation (v1)' +--- + += Start a file and folder explore operation (v1) + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/file-explore/start`# + + + +Starts a file and folder explore operation while initiating a single file restore (SFR) operation. This API endpoint initiates the deployment of an Active Data Connector container on the Console agent and mounts the snapshot under the /tmp folder to browse the files and folders. This API endpoint is currently supported on Cloud Volumes ONTAP on AWS, Azure, Google Cloud, and on-premises ONTAP systems. It supports retrieving files and folders from backups stored on AWS, Azure, Google Cloud, and StorageGRID cloud storage providers. + +**Token usage:**NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|snapshotLocation +|string +|query +|False +a|Location of the snapshot + +* enum: ["LOCAL", "CLOUD"] + + +|snapshotId +|string +|query +|False +a|Snapshot ID of the source snapshot + + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|volumeId +|string +|path +|True +a|File system ID/Volume ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-buckets-.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-buckets-.adoc new file mode 100644 index 00000000..34bba8b4 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-buckets-.adoc @@ -0,0 +1,210 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-buckets-.html' +summary: 'Retrieve details of a bucket from the StorageGRID server' +--- + += Retrieve details of a bucket from the StorageGRID server + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/buckets/{bucketName}`# + + + +Retrieves details of a specific bucket from the StorageGRID server. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|fields +|string +|query +|False +a|bucket fields + + +|accountId +|string +|path +|True +a|Account ID + + +|bucketName +|string +|path +|True +a|SGWS Bucket Name + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server +|string +|True +a|StorageGRID server URL. Required input field for a StorageGRID provider + + +|access-key +|string +|True +a|Required input field for an on-premises use case + + +|secret-password +|string +|True +a|Required input field for an on-premises use case + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "storage-server": "string", + "access-key": "string", + "secret-password": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|buckets +|array[link:#buckets[buckets]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "buckets": [ + { + "name": "string", + "region": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server +|string +|True +a|StorageGRID server URL. Required input field for a StorageGRID provider + + +|access-key +|string +|True +a|Required input field for an on-premises use case + + +|secret-password +|string +|True +a|Required input field for an on-premises use case + + +|=== + + +[#buckets] +[.api-collapsible-fifth-title] +buckets + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-buckets.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-buckets.adoc new file mode 100644 index 00000000..03be0469 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-buckets.adoc @@ -0,0 +1,203 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-buckets.html' +summary: 'Retrieve a list of StorageGRID buckets' +--- + += Retrieve a list of StorageGRID buckets + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/buckets`# + + + +Retrieves a list of StorageGRID buckets from the StorageGRID server. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|fields +|string +|query +|False +a|bucket fields + + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server +|string +|True +a|StorageGRID server URL. Required input field for a StorageGRID provider + + +|access-key +|string +|True +a|Required input field for an on-premises use case + + +|secret-password +|string +|True +a|Required input field for an on-premises use case + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "storage-server": "string", + "access-key": "string", + "secret-password": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|buckets +|array[link:#buckets[buckets]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "buckets": [ + { + "name": "string", + "region": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server +|string +|True +a|StorageGRID server URL. Required input field for a StorageGRID provider + + +|access-key +|string +|True +a|Required input field for an on-premises use case + + +|secret-password +|string +|True +a|Required input field for an on-premises use case + + +|=== + + +[#buckets] +[.api-collapsible-fifth-title] +buckets + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-credentials-working-environment-.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-credentials-working-environment-.adoc new file mode 100644 index 00000000..c4e36280 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-credentials-working-environment-.adoc @@ -0,0 +1,153 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-credentials-working-environment-.html' +summary: 'Save StorageGRID credentials' +--- + += Save StorageGRID credentials + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/credentials/working-environment/{workingEnvironmentId}`# + + + +Saves the StorageGRID credentials. + +{blank} + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server +|string +|True +a|StorageGRID server URL. Required input field for a StorageGRID provider + + +|access-key +|string +|True +a|Required input field for an on-premises use case + + +|secret-password +|string +|True +a|Required input field for an on-premises use case + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "storage-server": "string", + "access-key": "string", + "secret-password": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server +|string +|True +a|StorageGRID server URL. Required input field for a StorageGRID provider + + +|access-key +|string +|True +a|Required input field for an on-premises use case + + +|secret-password +|string +|True +a|Required input field for an on-premises use case + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-version.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-version.adoc new file mode 100644 index 00000000..520d1add --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-version.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-version.html' +summary: 'Retrieve StorageGRID server version' +--- + += Retrieve StorageGRID server version + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/version`# + + + +Retrieves the version of the StorageGRID servers. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server +|string +|True +a|StorageGRID server URL. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "storage-server": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|version +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "version": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server +|string +|True +a|StorageGRID server URL. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg.adoc new file mode 100644 index 00000000..42c0780a --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg.adoc @@ -0,0 +1,173 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-sg.html' +summary: 'Discover a new StorageGRID WebScale server' +--- + += Discover a new StorageGRID WebScale server + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg`# + + + +Discovers a new StorageGRID server in the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|admin-host +|string +|True +a|StorageGRID Admin host IP address. + + +|admin-username +|string +|True +a|StorageGRID Admin username. + + +|admin-password +|string +|True +a|StorageGRID Admin password. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "admin-host": "string", + "admin-username": "string", + "admin-password": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|admin-host +|string +|True +a|StorageGRID Admin host IP address. + + +|admin-username +|string +|True +a|StorageGRID Admin username. + + +|admin-password +|string +|True +a|StorageGRID Admin password. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy.adoc new file mode 100644 index 00000000..5ed33b71 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy.adoc @@ -0,0 +1,329 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy.html' +summary: 'Create a backup policy' +--- + += Create a backup policy + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy`# + + + +Creates a backup policy in a system. The number of retained backups can be up to a maximum of 1018 when no backup policies are assigned to a volume. You can edit a policy to create up to 4000 backups after you assign volumes to a policy through ONTAP CLI. This API endpoint validates whether the ONTAP version used by a system supports archiving. You can archive the backups to a cloud archive tier by setting the archive-after-days in the policy. You can archive to AWS Glacier, Deep Glacier, Azure Archive, and Google Archive. + +You can enable DataLock and Ransomware protection beginning with ONTAP 9.11.1 and later (supported for AWS, Azure, and StorageGRID). This is applicable only for new backup activation. Interoperability with archival policy is not supported. For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|rule +|array[link:#rule[rule]] +|True +a| + +|transfer-schedule +|string +|False +a| + +|sgws-archival +|link:#sgws-archival[sgws-archival] +|False +a| + +|archive-after-days +|string +|False +a| + +|provider +|string +|False +a|* enum: ["AWS", "AZURE", "GCP", "SGWS", "ONTAP_S3"] + + +|object-lock +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string", + "period": "string" + } + ], + "transfer-schedule": "string", + "sgws-archival": { + "cloud-storage-pool": { + "provider": "string", + "provider-account-id": "string", + "region": "string", + "access-key": "string", + "secret-password": "string", + "archive-storage-class": "string" + } + }, + "archive-after-days": "string", + "provider": "string", + "object-lock": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|period +|string +|False +a| + +|=== + + +[#cloud-storage-pool] +[.api-collapsible-fifth-title] +cloud-storage-pool + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provider +|string +|True +a|Cloud provider where the cloud storage pool is hosted + + +|provider-account-id +|string +|True +a|Cloud provider account ID where the cloud storage pool is hosted + + +|region +|string +|True +a|Cloud provider region where the cloud storage pool is hosted + + +|access-key +|string +|False +a|Required input field if the provider is AWS + + +|secret-password +|string +|False +a|Required input field if the provider is AWS + + +|archive-storage-class +|string +|False +a|Required for AWS to specify which storage class to use for archiving + + +|=== + + +[#sgws-archival] +[.api-collapsible-fifth-title] +sgws-archival + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloud-storage-pool +|link:#cloud-storage-pool[cloud-storage-pool] +|False +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|rule +|array[link:#rule[rule]] +|True +a| + +|transfer-schedule +|string +|False +a| + +|sgws-archival +|link:#sgws-archival[sgws-archival] +|False +a| + +|archive-after-days +|string +|False +a| + +|provider +|string +|False +a|* enum: ["AWS", "AZURE", "GCP", "SGWS", "ONTAP_S3"] + + +|object-lock +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy.adoc new file mode 100644 index 00000000..17e376ff --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy.adoc @@ -0,0 +1,213 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy.html' +summary: 'Create a replication policy in a system' +--- + += Create a replication policy in a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy`# + + + +Creates a replication policy in a system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|rule +|array[link:#rule[rule]] +|False +a| + +|transfer-schedule +|string +|False +a|Cron-based schedule for transfers. To disable the schedule, pass the value as: none(case sensitive). By default, an hourly schedule is selected. + + +|copy-all-source-snapshots +|boolean +|False +a|Copies all source snapshots to the replication detstination + + +|copy-latest-source-snapshot +|boolean +|False +a|Copies only the latest source snapshot to the replication detstination + + +|svm-name +|string +|False +a|Name of the SVM where the replication policy should be created + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "transfer-schedule": "string", + "svm-name": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|rule +|array[link:#rule[rule]] +|False +a| + +|transfer-schedule +|string +|False +a|Cron-based schedule for transfers. To disable the schedule, pass the value as: none(case sensitive). By default, an hourly schedule is selected. + + +|copy-all-source-snapshots +|boolean +|False +a|Copies all source snapshots to the replication detstination + + +|copy-latest-source-snapshot +|boolean +|False +a|Copies only the latest source snapshot to the replication detstination + + +|svm-name +|string +|False +a|Name of the SVM where the replication policy should be created + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-schedules.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-schedules.adoc new file mode 100644 index 00000000..24a68657 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-schedules.adoc @@ -0,0 +1,208 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-schedules.html' +summary: 'Create a new cron schedule in a system' +--- + += Create a new cron schedule in a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/schedules`# + + + +Creates a new cron schedule in a system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|schedules +|array[link:#schedules[schedules]] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "schedules": [ + { + "schedule-name": "string", + "cron": { + "minutes": [ + "integer" + ], + "hours": [ + "integer" + ], + "weekdays": [ + "string" + ], + "days": [ + "integer" + ], + "months": [ + "string" + ] + } + } + ] +} +==== + +== Response + +``` +Status: 200, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#cron] +[.api-collapsible-fifth-title] +cron + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|minutes +|array[integer] +|True +a|The minutes the schedule runs, required on POST for a cron schedule. + + +|hours +|array[integer] +|False +a| + +|weekdays +|array[string] +|False +a| + +|days +|array[integer] +|False +a| + +|months +|array[string] +|False +a| + +|=== + + +[#schedules] +[.api-collapsible-fifth-title] +schedules + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|schedule-name +|string +|True +a| + +|cron +|link:#cron[cron] +|True +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|schedules +|array[link:#schedules[schedules]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policy.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policy.adoc new file mode 100644 index 00000000..da4b2b76 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policy.adoc @@ -0,0 +1,169 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policy.html' +summary: 'Create a snapshot policy' +--- + += Create a snapshot policy + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policy`# + + + +Creates a snapshot policy with the user specified schedule, count and SnapMirror labels in a system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Snapshot policy name + + +|copies +|array[link:#copies[copies]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "copies": [ + {} + ] +} +==== + +== Response + +``` +Status: 200, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#copies] +[.api-collapsible-fifth-title] +copies + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|schedule-name +|string +|True +a| + +|label +|string +|False +a|Label for SnapMirror operations + + +|count +|number +|True +a|Number of snapshots to maintain for this schedule + + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Snapshot policy name + + +|copies +|array[link:#copies[copies]] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot.adoc new file mode 100644 index 00000000..6489d8f9 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot.adoc @@ -0,0 +1,164 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot.html' +summary: 'Create a snapshot for a volume' +--- + += Create a snapshot for a volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot`# + + + +Creates a snapshot for a particular volume. The API initiates the creation of a snapshot of the volume-based on the snapshot policy assigned. The system ID, volume ID, and snapshot ID are passed as parameters for the REST API call. The snapshot name and label are used as headers. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|volumeId +|string +|path +|True +a|Volume ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|label +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "label": "string" +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|label +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v2-catalog-re-index.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v2-catalog-re-index.adoc new file mode 100644 index 00000000..67cdb820 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v2-catalog-re-index.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v2-catalog-re-index.html' +summary: 'Re-index the catalog for all of the systems in an account' +--- + += Re-index the catalog for all of the systems in an account + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/catalog/re-index`# + + + +Re-indexes the catalog for all of the systems in an account + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v2-catalog-working-environments-setup.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v2-catalog-working-environments-setup.adoc new file mode 100644 index 00000000..64db1fd2 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v2-catalog-working-environments-setup.adoc @@ -0,0 +1,86 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v2-catalog-working-environments-setup.html' +summary: 'Configure a service' +--- + += Configure a service + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/catalog/working-environments/{workingEnvironmentId}/setup`# + + + +Configures the service to include indexed cataloging services. It enables the AWS Athena interactive S3 query service and AWS Glue serverless data integration service for AWS setup, Azure Synapse analytics service for Azure setup, Google BigQuery service for Google Cloud setup and DuckDB installation for StorageGRID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v2-gcp-credentials.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v2-gcp-credentials.adoc new file mode 100644 index 00000000..d8a21215 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v2-gcp-credentials.adoc @@ -0,0 +1,144 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v2-gcp-credentials.html' +summary: 'Register Google Cloud credentials' +--- + += Register Google Cloud credentials + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials`# + + + +Registers Google Cloud credentials for a Google Cloud project in the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentials-id +|string +|True +a|Credentials ID. Must only contain lower case alphabetic characters, numbers and hyphen(-). Must start and end with an alphabetic character or number. + + +|access-key +|string +|True +a|Google Cloud access-key. + + +|secret-password +|string +|True +a|Google Cloud secret-password. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "credentials-id": "string", + "access-key": "string", + "secret-password": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentials-id +|string +|True +a|Credentials ID. Must only contain lower case alphabetic characters, numbers and hyphen(-). Must start and end with an alphabetic character or number. + + +|access-key +|string +|True +a|Google Cloud access-key. + + +|secret-password +|string +|True +a|Google Cloud secret-password. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v2-restore.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v2-restore.adoc new file mode 100644 index 00000000..172379bb --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v2-restore.adoc @@ -0,0 +1,366 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v2-restore.html' +summary: 'Perform a volume and file-level restore (v2)' +--- + += Perform a volume and file-level restore (v2) + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/restore`# + + + +Performs a volume and file level restore (V2 version) operation. This API validates whether a backup of a volume exists. The restore operation is not supported on data protection volumes, on a target volume with a different language code than the source volume, and for volumes with size less than 1GB. The restore operation is not allowed on a volume enabled with a SnapLock license (WORM license). It checks whether the source and target cloud provider matches. It also verifies whether the backup and restore operation is supported in the system. + +If DataLock and ransomware protection is enabled on a system, ransomware scan is performed on the specified cloud backup that relates to a particular volume when it is chosen to be restored. To skip the scan, set the "skip-ransomware-check" parameter to "true". + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|restore +|link:#restore[restore] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "restore": { + "type": "string", + "restore-source": "string", + "archive-restore-priority": "string", + "source": { + "working-environment-id": "string", + "working-environment-name": "string", + "bucket": "string", + "volume-name": "string", + "volume-id": "string", + "snapshot": "string" + }, + "target": { + "working-environment-id": "string", + "working-environment-name": "string", + "svm": "string", + "aggregate": "string", + "volume-name": "string", + "path": "string" + }, + "file": [ + {} + ] + } +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#source] +[.api-collapsible-fifth-title] +source + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-id +|string +|True +a| + +|working-environment-name +|string +|True +a| + +|bucket +|string +|True +a| + +|volume-name +|string +|True +a| + +|volume-id +|string +|True +a| + +|snapshot +|string +|True +a| + +|=== + + +[#target] +[.api-collapsible-fifth-title] +target + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-id +|string +|True +a| + +|working-environment-name +|string +|True +a| + +|svm +|string +|True +a| + +|aggregate +|string +|False +a| + +|volume-name +|string +|True +a| + +|path +|string +|False +a| + +|retain-source-path +|boolean +|False +a| + +|=== + + +[#file] +[.api-collapsible-fifth-title] +file + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|inode +|number +|True +a| + +|path +|string +|True +a| + +|type +|string +|True +a| + +|size +|number +|True +a| + +|mtime +|number +|True +a| + +|=== + + +[#restore] +[.api-collapsible-fifth-title] +restore + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|restore-source +|string +|False +a|Specifies the source of the restore + + +|archive-restore-priority +|string +|False +a|Required to specify the archival retrieval priority to determine the restoration time + + +|source +|link:#source[source] +|True +a| + +|target +|link:#target[target] +|True +a| + +|file +|array[link:#file[file]] +|False +a| + +|skip-ransomware-check +|boolean +|False +a|Skips a ransomware scan + + +|skip-file-rename +|boolean +|False +a|Skips file rename while restore + + +|is-on-demand-restore +|boolean +|False +a|Triggers an on-demand restore + + +|skip-azure-private-endpoint-creation +|boolean +|False +a|Optional input field to skip private endpoint creation for Azure + + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|restore +|link:#restore[restore] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v2-sg-credentials.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v2-sg-credentials.adoc new file mode 100644 index 00000000..3455e26a --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v2-sg-credentials.adoc @@ -0,0 +1,157 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v2-sg-credentials.html' +summary: 'Register new StorageGRID credentials' +--- + += Register new StorageGRID credentials + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/sg/credentials`# + + + +Registers new StorageGRID credentials in the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server-name +|string +|True +a|StorageGRID server name. + + +|port +|string +|True +a|StorageGRID node port. + + +|access-key +|string +|True +a|StorageGRID tenant access-key. + + +|secret-password +|string +|True +a|StorageGRID tenant secret-password. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "storage-server-name": "string", + "port": "string", + "access-key": "string", + "secret-password": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server-name +|string +|True +a|StorageGRID server name. + + +|port +|string +|True +a|StorageGRID node port. + + +|access-key +|string +|True +a|StorageGRID tenant access-key. + + +|secret-password +|string +|True +a|StorageGRID tenant secret-password. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v2-working-environment-configure-object-store.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v2-working-environment-configure-object-store.adoc new file mode 100644 index 00000000..ed02ebc4 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v2-working-environment-configure-object-store.adoc @@ -0,0 +1,338 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v2-working-environment-configure-object-store.html' +summary: 'Configure object storage (v2)' +--- + += Configure object storage (v2) + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/configure-object-store`# + + + +Configures an object storage. This is a V2 version of the object store configure API. It verifies whether a private endpoint is enabled and a certificate is installed. You can verify whether previously created private endpoints are enabled for AWS and Azure. This API endpoint is called if no object stores are found when the NetApp Backup and Recovery service is enabled. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloud-provider +|string +|True +a| + +|object-store-name +|string +|True +a| + +|ip-space +|string +|False +a| + +|access-key +|string +|False +a| + +|secret-password +|string +|False +a| + +|storage-server +|string +|False +a| + +|region +|string +|False +a| + +|aws +|link:#aws[aws] +|False +a| + +|azure +|link:#azure[azure] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "cloud-provider": "string", + "object-store-name": "string", + "ip-space": "string", + "access-key": "string", + "secret-password": "string", + "storage-server": "string", + "region": "string", + "aws": { + "account-id": "string", + "private-endpoint": { + "id": "string" + } + }, + "azure": { + "subscription": "string", + "private-endpoint": { + "subnet": "string" + } + } +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#private-endpoint] +[.api-collapsible-fifth-title] +private-endpoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a|Optional input field for private endpoints. + + +|=== + + +[#aws] +[.api-collapsible-fifth-title] +aws + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|account-id +|string +|False +a|Required when the provider is AWS + + +|private-endpoint +|link:#private-endpoint[private-endpoint] +|False +a| + +|=== + + +[#private-endpoint] +[.api-collapsible-fifth-title] +private-endpoint + +Required input field for an on-premises private link configuration + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subnet +|string +|False +a|Required input field for an on-premises private link configuration + + +|=== + + +[#azure] +[.api-collapsible-fifth-title] +azure + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|string +|False +a|Required when the provider is Azure + + +|private-endpoint +|link:#private-endpoint[private-endpoint] +|False +a|Required input field for an on-premises private link configuration + + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloud-provider +|string +|True +a| + +|object-store-name +|string +|True +a| + +|ip-space +|string +|False +a| + +|access-key +|string +|False +a| + +|secret-password +|string +|False +a| + +|storage-server +|string +|False +a| + +|region +|string +|False +a| + +|aws +|link:#aws[aws] +|False +a| + +|azure +|link:#azure[azure] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v2-working-environment-discover-volumes.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v2-working-environment-discover-volumes.adoc new file mode 100644 index 00000000..8fd0fd93 --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v2-working-environment-discover-volumes.adoc @@ -0,0 +1,151 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v2-working-environment-discover-volumes.html' +summary: 'Discover all volumes with relationships for a list of systems' +--- + += Discover all volumes with relationships for a list of systems + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/discover/volumes`# + + + +Discovers all volumes with relationships for a list of systems. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentIds +|array[string] +|False +a| + +|discoverRelationships +|boolean +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "workingEnvironmentIds": [ + "string" + ] +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentIds +|array[string] +|False +a| + +|discoverRelationships +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v3-backup-working-environment-volume-.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v3-backup-working-environment-volume-.adoc new file mode 100644 index 00000000..9ce742ec --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v3-backup-working-environment-volume-.adoc @@ -0,0 +1,277 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v3-backup-working-environment-volume-.html' +summary: 'Enable backup for a volume (v3)' +--- + += Enable backup for a volume (v3) + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v3/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}`# + + + +Enables backup for a specified volume (version V3). This version of the endpoint runs the job asynchronously. Backup is not allowed for a volume enabled with a SnapLock license (WORM license). You can configure the different backup modes. The AD_HOC mode creates an on-demand snapshot and stores a backup on the respective cloud. SCHEDULED mode (default mode) creates snapshots as per the ONTAP snapshot policy and stores a backup on the cloud as per the backup policy. Based on the defined backup policy, this API endpoint creates a SnapMirror to cloud relationship with a specific cloud object storage system. Using this endpoint, you can set the archive after days parameter to move the volume data to the archive tier and also enable object lock and ransomware detection feature on the volume. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|volumeId +|string +|path +|True +a|Volume ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mode +|string +|False +a|AD_HOC mode creates an on-demand snapshot and backs it up on the respective cloud. SCHEDULED mode creates snapshots as per the ONTAP snapshot policy and backs it up to the cloud as per the backup policy. [Deprecated] IMMEDIATE mode is designed for internal use cases and cannot be used for newer integrations + +* enum: ["AD_HOC", "SCHEDULED", "IMMEDIATE"] + + +|adhoc-backup-details +|link:#adhoc-backup-details[adhoc-backup-details] +|False +a| + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "mode": "string", + "adhoc-backup-details": { + "name": "string", + "snapmirrorLabel": "string" + }, + "backup-policy": { + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "archive-after-days": "string", + "object-lock": "string" + } +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#adhoc-backup-details] +[.api-collapsible-fifth-title] +adhoc-backup-details + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|snapmirrorLabel +|string +|False +a| + +|=== + + +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Required input + + +|rule +|array[link:#rule[rule]] +|False +a| + +|archive-after-days +|string +|False +a| + +|object-lock +|string +|False +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mode +|string +|False +a|AD_HOC mode creates an on-demand snapshot and backs it up on the respective cloud. SCHEDULED mode creates snapshots as per the ONTAP snapshot policy and backs it up to the cloud as per the backup policy. [Deprecated] IMMEDIATE mode is designed for internal use cases and cannot be used for newer integrations + +* enum: ["AD_HOC", "SCHEDULED", "IMMEDIATE"] + + +|adhoc-backup-details +|link:#adhoc-backup-details[adhoc-backup-details] +|False +a| + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/post-account-providers-cloudmanager_cbs-api-v3-restore.adoc b/cbs/post-account-providers-cloudmanager_cbs-api-v3-restore.adoc new file mode 100644 index 00000000..87e42b9d --- /dev/null +++ b/cbs/post-account-providers-cloudmanager_cbs-api-v3-restore.adoc @@ -0,0 +1,388 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/post-account-providers-cloudmanager_cbs-api-v3-restore.html' +summary: 'Perform a volume, file, and folder-level restore operation (v3)' +--- + += Perform a volume, file, and folder-level restore operation (v3) + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v3/restore`# + + + +Performs a volume, file, and folder-level restore (version 3) operation. It is also possible to do a multi-level or nested-level folder restore operation. This API validates whether a backup of a volume exists. The restore operation is not supported on data protection volumes, a target volume with a different language code than the source volume, volumes with a size of less than 1GB, and volumes enabled with a SnapLock license (WORM license). In addition, restoring both files and folders is not supported. Restoring multiple folders is also not supported. The API checks whether the source and target cloud providers match and also verifies whether the backup and restore operation is supported in the system. + +If DataLock and ransomware protection is enabled on a system, a ransomware scan is performed on the specified cloud backup related to the volume that is to be restored. To skip the scan, set the "skip-ransomware-check" parameter to "true". + +To indicate that the volume restore is part of an application restore workflow, set the "is-app-volume-restore" parameter to "true". This disables certain steps such as mounting the volume after the storage volume restore. + +This version adds support for accepting a list of target aggregates. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|restore +|link:#restore[restore] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "restore": { + "type": "string", + "restore-source": "string", + "archive-restore-priority": "string", + "source": { + "working-environment-id": "string", + "working-environment-name": "string", + "bucket": "string", + "volume-name": "string", + "volume-id": "string", + "snapshot": "string" + }, + "target": { + "working-environment-id": "string", + "working-environment-name": "string", + "svm": "string", + "volume-name": "string", + "path": "string", + "aggregates": [ + "string" + ] + }, + "file": [ + {} + ] + } +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#source] +[.api-collapsible-fifth-title] +source + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-id +|string +|True +a| + +|working-environment-name +|string +|True +a| + +|bucket +|string +|True +a| + +|volume-name +|string +|True +a| + +|volume-id +|string +|True +a| + +|snapshot +|string +|True +a| + +|=== + + +[#target] +[.api-collapsible-fifth-title] +target + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-id +|string +|True +a| + +|working-environment-name +|string +|True +a| + +|svm +|string +|True +a| + +|volume-name +|string +|True +a| + +|path +|string +|False +a| + +|retain-source-path +|boolean +|False +a| + +|aggregates +|array[string] +|False +a| + +|=== + + +[#file] +[.api-collapsible-fifth-title] +file + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|inode +|string +|True +a| + +|path +|string +|True +a| + +|type +|string +|True +a| + +|size +|number +|True +a| + +|mtime +|number +|True +a| + +|source-file-path +|string +|False +a| + +|=== + + +[#restore] +[.api-collapsible-fifth-title] +restore + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|restore-source +|string +|False +a|Specifies the source of the restore + + +|restore-to-replication-source +|boolean +|False +a| + +|archive-restore-priority +|string +|False +a|Required to specify the archival retrieval priority to determine the restoration time + + +|source +|link:#source[source] +|True +a| + +|target +|link:#target[target] +|True +a| + +|file +|array[link:#file[file]] +|False +a| + +|skip-ransomware-check +|boolean +|False +a|Skips a ransomware scan + + +|skip-file-rename +|boolean +|False +a|Skips file rename during the restore + + +|is-on-demand-restore +|boolean +|False +a|Triggers an on-demand restore + + +|is-app-volume-restore +|boolean +|False +a|Indicates that the volume restore is part of an application restore workflow + + +|skip-azure-private-endpoint-creation +|boolean +|False +a|Optional input field to skip private endpoint creation for Azure + + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|restore +|link:#restore[restore] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/put-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.adoc b/cbs/put-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.adoc new file mode 100644 index 00000000..1e5bbff6 --- /dev/null +++ b/cbs/put-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.adoc @@ -0,0 +1,232 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/put-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.html' +summary: 'Modify a backed up volume' +--- + += Modify a backed up volume + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}`# + + + +Modifies a specified backed up volume. You can use this API endpoint to modify the volume state, backup policy, backup policy rule-retention, and archive-after-days parameters. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|volumeId +|string +|path +|True +a|Volume ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|state +|string +|False +a| + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "state": "string", + "backup-policy": { + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "archive-after-days": "string", + "object-lock": "string" + } +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|state +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "state": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|rule +|array[link:#rule[rule]] +|False +a| + +|archive-after-days +|string +|False +a| + +|object-lock +|string +|False +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|state +|string +|False +a| + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/put-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume.adoc b/cbs/put-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume.adoc new file mode 100644 index 00000000..9b102bad --- /dev/null +++ b/cbs/put-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume.adoc @@ -0,0 +1,249 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/put-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume.html' +summary: 'Modify multiple backed up volumes' +--- + += Modify multiple backed up volumes + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume`# + + + +Modifies multiple backed-up volumes in a specific system. This API endpoint modifies the volume state, backup-policy, backup policy rule and retention, and archive-after-days parameters. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volume +|array[link:#volume[volume]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "volume": [ + { + "state": "string", + "file-system-id": "string", + "backup-policy": { + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "archive-after-days": "string", + "object-lock": "string" + } + } + ] +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|rule +|array[link:#rule[rule]] +|False +a| + +|archive-after-days +|string +|False +a| + +|object-lock +|string +|False +a| + +|=== + + +[#volume] +[.api-collapsible-fifth-title] +volume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|state +|string +|False +a| + +|file-system-id +|string +|True +a| + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volume +|array[link:#volume[volume]] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/put-account-providers-cloudmanager_cbs-api-v1-catalog-working-environments-.adoc b/cbs/put-account-providers-cloudmanager_cbs-api-v1-catalog-working-environments-.adoc new file mode 100644 index 00000000..84444673 --- /dev/null +++ b/cbs/put-account-providers-cloudmanager_cbs-api-v1-catalog-working-environments-.adoc @@ -0,0 +1,125 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/put-account-providers-cloudmanager_cbs-api-v1-catalog-working-environments-.html' +summary: 'Enable or disable the service' +--- + += Enable or disable the service + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/working-environments/{workingEnvironmentId}`# + + + +Enables or disables the indexed cataloging service for a specified system on AWS, Azure, Google Cloud and on-premise or dark site deployments. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|state +|string +|False +a|Modifies all of the SnapMirror relationship states in the system to the state specified. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "state": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|state +|string +|False +a|Modifies all of the SnapMirror relationship states in the system to the state specified. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/put-account-providers-cloudmanager_cbs-api-v1-configurations.adoc b/cbs/put-account-providers-cloudmanager_cbs-api-v1-configurations.adoc new file mode 100644 index 00000000..a8688175 --- /dev/null +++ b/cbs/put-account-providers-cloudmanager_cbs-api-v1-configurations.adoc @@ -0,0 +1,158 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/put-account-providers-cloudmanager_cbs-api-v1-configurations.html' +summary: 'Modify the configuration' +--- + += Modify the configuration + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/configurations`# + + + +Modifies the configuration. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|authorization +|string +|header +|True +a|Authorization token + + +|X-Agent-Id +|string +|header +|True +a|Agent ID + + +|accountId +|string +|path +|True +a| +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|Configuration key + + +|value +| +|True +a|Configuration value + + +|=== + + +== Response + +``` +Status: 200, Default response +``` + +== Error + +``` +Status: 500, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|statusCode +|number +|False +a| + +|error +|string +|False +a| + +|message +|string +|False +a| + +|=== + + +.Example error +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|Configuration key + + +|value +| +|True +a|Configuration value + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/put-account-providers-cloudmanager_cbs-api-v1-object-storage.adoc b/cbs/put-account-providers-cloudmanager_cbs-api-v1-object-storage.adoc new file mode 100644 index 00000000..4fae8af6 --- /dev/null +++ b/cbs/put-account-providers-cloudmanager_cbs-api-v1-object-storage.adoc @@ -0,0 +1,331 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/put-account-providers-cloudmanager_cbs-api-v1-object-storage.html' +summary: 'Modify bucket properties for a cloud provider' +--- + += Modify bucket properties for a cloud provider + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage`# + + + +Modifies the bucket properties for the specified provider. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|authorization +|string +|header +|True +a|Authorization token + + +|X-Agent-Id +|string +|header +|True +a|Agent ID + + +|job-id +|string +|header +|True +a|Job ID for the modify bucket operation + + +|accountId +|string +|path +|True +a| +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provider +|string +|True +a|Cloud provider type + + +|region +|string +|True +a|Region for the bucket + + +|object-store-name +|string +|True +a|Object store name + + +|aws +|link:#aws[aws] +|False +a| + +|azure +|link:#azure[azure] +|False +a| + +|gcp +|link:#gcp[gcp] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "provider": "string", + "region": "string", + "object-store-name": "string", + "aws": { + "account-id": "string", + "kms-key-id": "string" + }, + "azure": { + "subscription": "string", + "resource-group": "string", + "key-vault": { + "key-vault-id": "string", + "key-name": "string" + } + }, + "gcp": { + "project-id": "string", + "kms": { + "key-ring-id": "string", + "crypto-key-id": "string" + } + } +} +==== + +== Response + +``` +Status: 202, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#aws] +[.api-collapsible-fifth-title] +aws + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|account-id +|string +|True +a|AWS account ID + + +|kms-key-id +|string +|True +a|AWS KMS key ID + + +|=== + + +[#key-vault] +[.api-collapsible-fifth-title] +key-vault + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key-vault-id +|string +|True +a|Azure Key Vault ID + + +|key-name +|string +|True +a|Azure Key Vault key name + + +|=== + + +[#azure] +[.api-collapsible-fifth-title] +azure + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|string +|True +a|Azure subscription + + +|resource-group +|string +|True +a|Azure resource group + + +|key-vault +|link:#key-vault[key-vault] +|True +a| + +|=== + + +[#kms] +[.api-collapsible-fifth-title] +kms + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key-ring-id +|string +|True +a|Google Cloud KMS key ring ID + + +|crypto-key-id +|string +|True +a|Google Cloud KMS crypto key ID + + +|=== + + +[#gcp] +[.api-collapsible-fifth-title] +gcp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|project-id +|string +|True +a|Google Cloud project ID + + +|kms +|link:#kms[kms] +|True +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provider +|string +|True +a|Cloud provider type + + +|region +|string +|True +a|Region for the bucket + + +|object-store-name +|string +|True +a|Object store name + + +|aws +|link:#aws[aws] +|False +a| + +|azure +|link:#azure[azure] +|False +a| + +|gcp +|link:#gcp[gcp] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/put-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-volume.adoc b/cbs/put-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-volume.adoc new file mode 100644 index 00000000..c07f17c9 --- /dev/null +++ b/cbs/put-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-volume.adoc @@ -0,0 +1,352 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/put-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-volume.html' +summary: 'Modify comprehensive protection for multiple volumes (v1)' +--- + += Modify comprehensive protection for multiple volumes (v1) + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}/volume`# + + + +Modifies comprehensive protection for multiple volumes. If the selected volume already has an existing replication relationship, you can use the API to modify the replication policy. Otherwise, the API can be used to create a replication relationship. It creates a cluster-peer relationship, establishes a storage VM-peer relationship, creates a DP volume, and then performs the SnapMirror update/initialize process. Similarly, if the selected volume already has an existing "backup to the cloud" relationship, the API enables you to modify the backup policy. Alternatively, if there is no existing relationship, the API can be used to create SnapMirror cloud relationship. It creates a bucket in the specified cloud provider and then performs a SnapMirror cloud update/initialize operation. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volume +|array[link:#volume[volume]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "volume": [ + {} + ] +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Required input + + +|rule +|array[link:#rule[rule]] +|False +a| + +|archive-after-days +|string +|False +a| + +|object-lock +|string +|False +a| + +|=== + + +[#replication] +[.api-collapsible-fifth-title] +replication + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|svm +|string +|False +a| + +|policy-name +|string +|False +a| + +|prefix +|string +|False +a| + +|suffix +|string +|False +a| + +|destination-aggregates +|array[string] +|False +a| + +|=== + + +[#is-enabled] +[.api-collapsible-fifth-title] +is-enabled + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|local-snapshot +|boolean +|False +a| + +|replication +|boolean +|False +a| + +|cloud-backup +|boolean +|False +a| + +|=== + + +[#volume] +[.api-collapsible-fifth-title] +volume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volume-id +|string +|True +a| + +|volume-name +|string +|False +a| + +|workload +|string +|False +a|Workload type of the volume. Currently only SQL, VOLUMES, VMWARE, ORACLE, HYPERV, K8S, KVM workloads are supported + + +|type +|string +|False +a| + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|state +|string +|False +a| + +|snapshot-policy +|string +|False +a|Snapshot policy name + + +|architecture +|string +|False +a|Type of storage architecture. Fan-out or Cascading + + +|replication +|link:#replication[replication] +|False +a| + +|is-enabled +|link:#is-enabled[is-enabled] +|True +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volume +|array[link:#volume[volume]] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/put-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot-policy.adoc b/cbs/put-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot-policy.adoc new file mode 100644 index 00000000..509c0dcd --- /dev/null +++ b/cbs/put-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot-policy.adoc @@ -0,0 +1,92 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/put-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot-policy.html' +summary: 'Modify a snapshot policy' +--- + += Modify a snapshot policy + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot-policy`# + + + +Modifies the snapshot policy to match the volume snapshot policy based on the SnapMirror relationship associated with the volume in a system. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|volumeId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Agent-Id +|string +|header +|True +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string" +} +==== + diff --git a/cbs/put-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-.adoc b/cbs/put-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-.adoc new file mode 100644 index 00000000..9aac3feb --- /dev/null +++ b/cbs/put-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-.adoc @@ -0,0 +1,560 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/put-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-.html' +summary: 'Modify the Backup and Recovery service backup configuration' +--- + += Modify the Backup and Recovery service backup configuration + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment/{workingEnvironmentId}`# + + + +Modifies the NetApp Backup and Recovery service backup configuration for a particular system synchronously (V2 version). You can modify the state, backup policy, archive storage class, cloud storage pool, AWS/Azure/Google Cloud/StorageGRID access and secret key, IPspace, maximum transfer rate, and enable automatic backup. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID of the source Cloud Volumes ONTAP instance + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|state +|string +|False +a|Updates the SnapMirror relationship state in the system to the specified state + + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a|Uses an existing policy or creates a new policy if not found in the list of ONTAP policies and modifies the backed up system relationships to use the existing one. + + +|archive-storage-class +|string +|False +a|Required for AWS if modifying the storage class or enabling archive for the first time. + + +|auto-backup-enabled +|boolean +|False +a|Automatically backs up all volumes in the systems + + +|max-transfer-rate +|number +|False +a|Modifies node-level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies unlimited throttling + + +|delete-yearly-snapshots +|boolean +|False +a|Disables the deletion of local yearly snapshots after being transferred to object store + + +|export-existing-snapshots +|boolean +|False +a|Exports pre-existing snapshots to object storage + + +|ip-space +|string +|False +a|IP space for the backed up system + + +|toggle-rsw-scan +|boolean +|False +a|Toggles RSW scheduled scan on or off + + +|rsw-scan-interval +|string +|False +a|RSW scheduled scans interval + + +|aws +|link:#aws[aws] +|False +a|Accesses key and secret password for the system + + +|gcp +|link:#gcp[gcp] +|False +a|Accesses key and secret password for the system + + +|sgws +|link:#sgws[sgws] +|False +a|Accesses key and secret password for the system + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "state": "string", + "backup-policy": { + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "archive-after-days": "string", + "object-lock": "string", + "sgws-archival": { + "cloud-storage-pool": { + "provider": "string", + "provider-account-id": "string", + "region": "string", + "access-key": "string", + "secret-password": "string", + "archive-storage-class": "string", + "resource-group": "string" + } + } + }, + "archive-storage-class": "string", + "ip-space": "string", + "rsw-scan-interval": "string", + "aws": { + "access-key": "string", + "secret-password": "string" + }, + "gcp": { + "access-key": "string", + "secret-password": "string" + }, + "sgws": { + "access-key": "string", + "secret-password": "string", + "storage-grid-id": "string" + } +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#cloud-storage-pool] +[.api-collapsible-fifth-title] +cloud-storage-pool + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provider +|string +|True +a|Cloud provider where the cloud storage pool is hosted + + +|provider-account-id +|string +|True +a|Cloud provider account ID where the cloud storage pool is hosted + + +|region +|string +|True +a|Cloud provider region where the cloud storage pool is hosted + + +|access-key +|string +|False +a|Required input field if the provider is AWS + + +|secret-password +|string +|False +a|Required input field if the provider is AWS + + +|archive-storage-class +|string +|False +a|Required for AWS to specify which storage class to use for archiving + + +|resource-group +|string +|False +a|Required when the provider is Azure + + +|=== + + +[#sgws-archival] +[.api-collapsible-fifth-title] +sgws-archival + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloud-storage-pool +|link:#cloud-storage-pool[cloud-storage-pool] +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +Uses an existing policy or creates a new policy if not found in the list of ONTAP policies and modifies the backed up system relationships to use the existing one. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Policy name of the existing policy or any custom name with which a new policy needs to be created. If not specified, a policy with the NetApp Backup and Recovery service default naming convention is created. + + +|rule +|array[link:#rule[rule]] +|False +a|Specifies the rules for a new policy + + +|archive-after-days +|string +|False +a| + +|object-lock +|string +|False +a| + +|sgws-archival +|link:#sgws-archival[sgws-archival] +|False +a| + +|=== + + +[#aws] +[.api-collapsible-fifth-title] +aws + +Accesses key and secret password for the system + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|access-key +|string +|False +a| + +|secret-password +|string +|False +a| + +|=== + + +[#gcp] +[.api-collapsible-fifth-title] +gcp + +Accesses key and secret password for the system + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|access-key +|string +|False +a| + +|secret-password +|string +|False +a| + +|=== + + +[#sgws] +[.api-collapsible-fifth-title] +sgws + +Accesses key and secret password for the system + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|access-key +|string +|False +a| + +|secret-password +|string +|False +a| + +|storage-grid-id +|string +|False +a|StorageGRID ID. Required input field for StorageGRID provider + + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|state +|string +|False +a|Updates the SnapMirror relationship state in the system to the specified state + + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a|Uses an existing policy or creates a new policy if not found in the list of ONTAP policies and modifies the backed up system relationships to use the existing one. + + +|archive-storage-class +|string +|False +a|Required for AWS if modifying the storage class or enabling archive for the first time. + + +|auto-backup-enabled +|boolean +|False +a|Automatically backs up all volumes in the systems + + +|max-transfer-rate +|number +|False +a|Modifies node-level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies unlimited throttling + + +|delete-yearly-snapshots +|boolean +|False +a|Disables the deletion of local yearly snapshots after being transferred to object store + + +|export-existing-snapshots +|boolean +|False +a|Exports pre-existing snapshots to object storage + + +|ip-space +|string +|False +a|IP space for the backed up system + + +|toggle-rsw-scan +|boolean +|False +a|Toggles RSW scheduled scan on or off + + +|rsw-scan-interval +|string +|False +a|RSW scheduled scans interval + + +|aws +|link:#aws[aws] +|False +a|Accesses key and secret password for the system + + +|gcp +|link:#gcp[gcp] +|False +a|Accesses key and secret password for the system + + +|sgws +|link:#sgws[sgws] +|False +a|Accesses key and secret password for the system + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/put-account-providers-cloudmanager_cbs-api-v2-gcp-credentials-.adoc b/cbs/put-account-providers-cloudmanager_cbs-api-v2-gcp-credentials-.adoc new file mode 100644 index 00000000..b544fc7c --- /dev/null +++ b/cbs/put-account-providers-cloudmanager_cbs-api-v2-gcp-credentials-.adoc @@ -0,0 +1,138 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/put-account-providers-cloudmanager_cbs-api-v2-gcp-credentials-.html' +summary: 'Update Google Cloud credentials' +--- + += Update Google Cloud credentials + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials/{credentialsId}`# + + + +Updates Google Cloud credentials for a Google Cloud project in the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|credentialsId +|string +|path +|True +a|Credential ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|access-key +|string +|False +a|Google Cloud access-key. + + +|secret-password +|string +|False +a|Google Cloud secret-password. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "access-key": "string", + "secret-password": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|access-key +|string +|False +a|Google Cloud access-key. + + +|secret-password +|string +|False +a|Google Cloud secret-password. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/put-account-providers-cloudmanager_cbs-api-v2-panoramic-protection-working-environment-.adoc b/cbs/put-account-providers-cloudmanager_cbs-api-v2-panoramic-protection-working-environment-.adoc new file mode 100644 index 00000000..921b9b0a --- /dev/null +++ b/cbs/put-account-providers-cloudmanager_cbs-api-v2-panoramic-protection-working-environment-.adoc @@ -0,0 +1,901 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/put-account-providers-cloudmanager_cbs-api-v2-panoramic-protection-working-environment-.html' +summary: 'Modify the comprehensive protection configuration in a system (v2)' +--- + += Modify the comprehensive protection configuration in a system (v2) + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/panoramic-protection/working-environment/{workingEnvironmentId}`# + + + +Modifies comprehensive protection configuration in a system. This API enables you to enhance the protection capabilities within a system by adding replication and backup functionalities. This enables the creation of fan-out or cascading backup topologies in the cloud. When replication is selected, the API first checks for the presence of an existing cluster-peering relationship. If a relationship is not found, the API creates the necessary cluster-peering relationship. Alternatively, if backup to the cloud is selected, the API creates a bucket in the specified cloud provider or appliance (AWS, AZURE, GCP, SGWS, ONTAP_S3) specifically for the system. This designated bucket is used for storing backups taken from the system. Archival tiers or DataLock/Ransomware capability can be set while enabling backup to cloud. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|state +|string +|False +a|Updates the SnapMirror relationship state in the system to the state specified + + +|provider +|string +|False +a|Required input field for on-premises use cases + +* enum: ["AWS", "AZURE", "GCP", "SGWS", "ONTAP_S3", "S3_COMPATIBLE"] + + +|region +|string +|False +a|Required input field for on-premises + + +|aws +|link:#aws[aws] +|False +a| + +|azure +|link:#azure[azure] +|False +a| + +|gcp +|link:#gcp[gcp] +|False +a| + +|sgws +|link:#sgws[sgws] +|False +a| + +|ontap-s3 +|link:#ontap-s3[ontap-s3] +|False +a| + +|s3-compatible +|link:#s3-compatible[s3-compatible] +|False +a| + +|bucket +|string +|False +a|Optional input + + +|ip-space +|string +|False +a|Required input field for on-premises use cases + + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|max-transfer-rate +|number +|False +a|Modifies node-level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies unlimited throttling + + +|export-existing-snapshots +|boolean +|False +a|Exports pre-existing snapshots to object storage + + +|architecture +|string +|False +a|Type of storage architecture. Fan-out or Cascading + + +|snapshot-policy +|string +|False +a|Snapshot policy name. To disable local snapshot, pass the value as: none(case sensitive). + + +|replication-target +|link:#replication-target[replication-target] +|False +a| + +|fix-mismatch-labels +|boolean +|False +a| + +|toggle-rsw-scan +|boolean +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "state": "string", + "provider": "string", + "region": "string", + "aws": { + "account-id": "string", + "kms-key-id": "string", + "private-endpoint": { + "id": "string" + }, + "archive-storage-class": "string" + }, + "azure": { + "resource-group": "string", + "storage-account": "string", + "subscription": "string", + "private-endpoint": { + "subnet": "string" + }, + "key-vault": { + "key-vault-id": "string", + "key-name": "string" + } + }, + "gcp": { + "project-id": "string", + "credentials-id": "string", + "kms": { + "key-ring-id": "string", + "crypto-key-id": "string" + } + }, + "sgws": { + "storage-grid-id": "string", + "storage-server-name": "string" + }, + "ontap-s3": { + "storage-server": "string", + "access-key": "string", + "secret-password": "string" + }, + "s3-compatible": { + "storage-server": "string", + "access-key": "string", + "secret-password": "string" + }, + "bucket": "string", + "ip-space": "string", + "backup-policy": { + "name": "string", + "rule": [ + { + "label": "string", + "retention": "string" + } + ], + "archive-after-days": "string", + "object-lock": "string", + "sgws-archival": { + "cloud-storage-pool": { + "provider": "string", + "provider-account-id": "string", + "region": "string", + "archive-storage-class": "string", + "resource-group": "string" + } + } + }, + "architecture": "string", + "snapshot-policy": "string", + "replication-target": { + "policy-name": "string", + "working-environment-id": "string", + "working-environment-name": "string", + "svm": "string", + "prefix": "string", + "suffix": "string", + "aggregates": [ + "string" + ] + } +} +==== + +== Response + +``` +Status: 202, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|job-id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "job-id": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#private-endpoint] +[.api-collapsible-fifth-title] +private-endpoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a|Optional input field for a private endpoint + + +|=== + + +[#aws] +[.api-collapsible-fifth-title] +aws + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|account-id +|string +|False +a|Required when the provider is AWS + + +|kms-key-id +|string +|False +a|Optional input field for customer managed key use case + + +|private-endpoint +|link:#private-endpoint[private-endpoint] +|False +a| + +|archive-storage-class +|string +|False +a|Required for AWS to specify which storage class to use for archiving + + +|=== + + +[#private-endpoint] +[.api-collapsible-fifth-title] +private-endpoint + +Required input field for private link configuration + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subnet +|string +|False +a|Required input field for on-premises private link configuration + + +|skip-creation +|boolean +|False +a|Optional input field to skip private endpoint creation + + +|=== + + +[#key-vault] +[.api-collapsible-fifth-title] +key-vault + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key-vault-id +|string +|False +a| + +|key-name +|string +|False +a| + +|=== + + +[#azure] +[.api-collapsible-fifth-title] +azure + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resource-group +|string +|False +a|Required when the provider is Azure + + +|storage-account +|string +|False +a|Required when the provider is Azure + + +|subscription +|string +|False +a|Required when the provider is Azure + + +|private-endpoint +|link:#private-endpoint[private-endpoint] +|False +a|Required input field for private link configuration + + +|key-vault +|link:#key-vault[key-vault] +|False +a| + +|=== + + +[#kms] +[.api-collapsible-fifth-title] +kms + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key-ring-id +|string +|False +a| + +|crypto-key-id +|string +|False +a| + +|=== + + +[#gcp] +[.api-collapsible-fifth-title] +gcp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|project-id +|string +|False +a|Required when the provider is Google Cloud + + +|credentials-id +|string +|False +a|Google Cloud credentials ID. Required when the provider is Google Cloud + + +|kms +|link:#kms[kms] +|False +a| + +|=== + + +[#sgws] +[.api-collapsible-fifth-title] +sgws + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-grid-id +|string +|False +a|StorageGRID ID. Required input field for StorageGRID provider + + +|storage-server-name +|string +|False +a|StorageGRID server name. Required input field for a StorageGRID provider + + +|=== + + +[#ontap-s3] +[.api-collapsible-fifth-title] +ontap-s3 + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server +|string +|False +a|ONTAP S3 server URL. Required input field for ONTAP_S3 provider + + +|access-key +|string +|False +a|Access-key:Required input field for on-premises use cases + + +|secret-password +|string +|False +a|Secret-password:Required input field for on-premises use cases + + +|=== + + +[#s3-compatible] +[.api-collapsible-fifth-title] +s3-compatible + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storage-server +|string +|False +a|s3 storage server + + +|access-key +|string +|False +a|Required input field for on-premises use cases + + +|secret-password +|string +|False +a|Required input field for on-premises use cases + + +|=== + + +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|=== + + +[#cloud-storage-pool] +[.api-collapsible-fifth-title] +cloud-storage-pool + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provider +|string +|True +a|Cloud provider where the cloud storage pool will be hosted + + +|provider-account-id +|string +|True +a|Cloud provider account ID where the cloud storage pool will be hosted + + +|region +|string +|True +a|Cloud provider region where the cloud storage pool will be hosted + + +|archive-storage-class +|string +|False +a|Required for AWS to specify which storage class to use for archiving + + +|resource-group +|string +|False +a|Required when the provider is Azure + + +|=== + + +[#sgws-archival] +[.api-collapsible-fifth-title] +sgws-archival + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloud-storage-pool +|link:#cloud-storage-pool[cloud-storage-pool] +|False +a| + +|=== + + +[#backup-policy] +[.api-collapsible-fifth-title] +backup-policy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Required input + + +|rule +|array[link:#rule[rule]] +|False +a| + +|archive-after-days +|string +|False +a| + +|object-lock +|string +|False +a| + +|sgws-archival +|link:#sgws-archival[sgws-archival] +|False +a| + +|=== + + +[#replication-target] +[.api-collapsible-fifth-title] +replication-target + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policy-name +|string +|False +a| + +|working-environment-id +|string +|False +a| + +|working-environment-name +|string +|False +a| + +|svm +|string +|False +a| + +|prefix +|string +|False +a| + +|suffix +|string +|False +a| + +|aggregates +|array[string] +|False +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|state +|string +|False +a|Updates the SnapMirror relationship state in the system to the state specified + + +|provider +|string +|False +a|Required input field for on-premises use cases + +* enum: ["AWS", "AZURE", "GCP", "SGWS", "ONTAP_S3", "S3_COMPATIBLE"] + + +|region +|string +|False +a|Required input field for on-premises + + +|aws +|link:#aws[aws] +|False +a| + +|azure +|link:#azure[azure] +|False +a| + +|gcp +|link:#gcp[gcp] +|False +a| + +|sgws +|link:#sgws[sgws] +|False +a| + +|ontap-s3 +|link:#ontap-s3[ontap-s3] +|False +a| + +|s3-compatible +|link:#s3-compatible[s3-compatible] +|False +a| + +|bucket +|string +|False +a|Optional input + + +|ip-space +|string +|False +a|Required input field for on-premises use cases + + +|backup-policy +|link:#backup-policy[backup-policy] +|False +a| + +|max-transfer-rate +|number +|False +a|Modifies node-level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies unlimited throttling + + +|export-existing-snapshots +|boolean +|False +a|Exports pre-existing snapshots to object storage + + +|architecture +|string +|False +a|Type of storage architecture. Fan-out or Cascading + + +|snapshot-policy +|string +|False +a|Snapshot policy name. To disable local snapshot, pass the value as: none(case sensitive). + + +|replication-target +|link:#replication-target[replication-target] +|False +a| + +|fix-mismatch-labels +|boolean +|False +a| + +|toggle-rsw-scan +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/put-account-providers-cloudmanager_cbs-api-v2-sg-credentials-.adoc b/cbs/put-account-providers-cloudmanager_cbs-api-v2-sg-credentials-.adoc new file mode 100644 index 00000000..5b35b203 --- /dev/null +++ b/cbs/put-account-providers-cloudmanager_cbs-api-v2-sg-credentials-.adoc @@ -0,0 +1,151 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/put-account-providers-cloudmanager_cbs-api-v2-sg-credentials-.html' +summary: 'Update StorageGRID credentials' +--- + += Update StorageGRID credentials + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/sg/credentials/{storageServerName}`# + + + +Updates StorageGRID credentials in the NetApp Console SaaS application. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|storageServerName +|string +|path +|True +a|StorageGRID server name + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|port +|string +|False +a|StorageGRID node port. + + +|access-key +|string +|False +a|StorageGRID tenant access-key. + + +|secret-password +|string +|False +a|StorageGRID tenant secret-password. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "port": "string", + "access-key": "string", + "secret-password": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|port +|string +|False +a|StorageGRID node port. + + +|access-key +|string +|False +a|StorageGRID tenant access-key. + + +|secret-password +|string +|False +a|StorageGRID tenant secret-password. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/put-account-providers-cloudmanager_cbs-api-v2-working-environment-backup-policy.adoc b/cbs/put-account-providers-cloudmanager_cbs-api-v2-working-environment-backup-policy.adoc new file mode 100644 index 00000000..bd97d94f --- /dev/null +++ b/cbs/put-account-providers-cloudmanager_cbs-api-v2-working-environment-backup-policy.adoc @@ -0,0 +1,307 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/put-account-providers-cloudmanager_cbs-api-v2-working-environment-backup-policy.html' +summary: 'Update a backup policy (v2)' +--- + += Update a backup policy (v2) + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/backup-policy`# + + + +Updates a backup policy in a system. This V2 version of the API endpoint facilitates modification of the rule, label, retention, archive-after-days, and StorageGRID archival details which also includes cloud storage pool information. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|Account ID + + +|workingEnvironmentId +|string +|path +|True +a|System ID + + +|authorization +|string +|header +|True +a|User token + + +|X-Agent-Id +|string +|header +|True +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyName +|string +|True +a|Backup policy name + + +|rule +|array[link:#rule[rule]] +|True +a| + +|sgws-archival +|link:#sgws-archival[sgws-archival] +|False +a| + +|transfer-schedule +|string +|False +a| + +|archive-after-days +|string +|False +a|Archive after days value to which the policy will be modified, "never" implies the removal of the archive-after-days property from a backup policy. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "policyName": "string", + "rule": [ + { + "label": "string", + "retention": "string", + "period": "string" + } + ], + "sgws-archival": { + "cloud-storage-pool": { + "provider": "string", + "provider-account-id": "string", + "region": "string", + "access-key": "string", + "secret-password": "string", + "archive-storage-class": "string" + } + }, + "transfer-schedule": "string", + "archive-after-days": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#rule] +[.api-collapsible-fifth-title] +rule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|label +|string +|False +a| + +|retention +|string +|False +a| + +|period +|string +|False +a| + +|=== + + +[#cloud-storage-pool] +[.api-collapsible-fifth-title] +cloud-storage-pool + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provider +|string +|True +a|Cloud provider where the cloud storage pool is hosted + + +|provider-account-id +|string +|True +a|Cloud provider account ID where the cloud storage pool is hosted + + +|region +|string +|True +a|Cloud provider region where the cloud storage pool is hosted + + +|access-key +|string +|False +a|Required input field if the provider is AWS + + +|secret-password +|string +|False +a|Required input field if the provider is AWS + + +|archive-storage-class +|string +|False +a|Required for AWS to specify which storage class to use for archiving + + +|=== + + +[#sgws-archival] +[.api-collapsible-fifth-title] +sgws-archival + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloud-storage-pool +|link:#cloud-storage-pool[cloud-storage-pool] +|False +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyName +|string +|True +a|Backup policy name + + +|rule +|array[link:#rule[rule]] +|True +a| + +|sgws-archival +|link:#sgws-archival[sgws-archival] +|False +a| + +|transfer-schedule +|string +|False +a| + +|archive-after-days +|string +|False +a|Archive after days value to which the policy will be modified, "never" implies the removal of the archive-after-days property from a backup policy. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cbs/ransomware_scan_overview.adoc b/cbs/ransomware_scan_overview.adoc new file mode 100644 index 00000000..94cbf820 --- /dev/null +++ b/cbs/ransomware_scan_overview.adoc @@ -0,0 +1,15 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/ransomware_scan_overview.html' +summary: 'Ransomware scan endpoints in the NetApp Backup and Recovery REST API' +--- + += Ransomware scan endpoints in the NetApp Backup and Recovery REST API + + + +The Ransomware scan API endpoint enables you to initiate a ransomware scan on a specified snapshot available in the cloud object-store bucket. It scans only cloud backups. It does not support scanning local snapshots. Ransomware attacks on local snapshots cannot be detected. + + diff --git a/cbs/replication_overview.adoc b/cbs/replication_overview.adoc new file mode 100644 index 00000000..2e3c3e22 --- /dev/null +++ b/cbs/replication_overview.adoc @@ -0,0 +1,15 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/replication_overview.html' +summary: 'Replication endpoints in the NetApp Backup and Recovery REST API' +--- + += Replication endpoints in the NetApp Backup and Recovery REST API + + + +The Replication enpoint enables you to perform an action on a volume on which SnapMirror replication is enabled. Using this API, you will be able to perform a SnapMirror relationship update, delete, pause, resync, reverse-resync, abort, and resume functionality on a replicated volume. + + diff --git a/cbs/report_overview.adoc b/cbs/report_overview.adoc new file mode 100644 index 00000000..a033af2c --- /dev/null +++ b/cbs/report_overview.adoc @@ -0,0 +1,19 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/report_overview.html' +summary: 'Report endpoints in the NetApp Backup and Recovery REST API' +--- + += Report endpoints in the NetApp Backup and Recovery REST API + + + +The report endpoints enable users to create and retrieve an inventory report for the whole account or a specific list of systems. It is also possible to generate reports for specific storage VMs under a system. You can perform the following operations by using the report endpoints: + +* Generate an inventory report + + +* Retrieve inventory reports + + diff --git a/cbs/restore_overview.adoc b/cbs/restore_overview.adoc new file mode 100644 index 00000000..4e2ea3a1 --- /dev/null +++ b/cbs/restore_overview.adoc @@ -0,0 +1,20 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/restore_overview.html' +summary: 'Restore endpoints in the NetApp Backup and Recovery REST API' +--- + += Restore endpoints in the NetApp Backup and Recovery REST API + + + +The restore endpoints enable you to perform volume, folder and file-level restore operations. You can perform the following operations by using the Restore endpoints: + +* Restore volumes, folder, and files. + + +* Retrieve volume, folder, and file restore status. + + + + diff --git a/cbs/sfr_overview.adoc b/cbs/sfr_overview.adoc new file mode 100644 index 00000000..72c3a505 --- /dev/null +++ b/cbs/sfr_overview.adoc @@ -0,0 +1,22 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/sfr_overview.html' +summary: 'Single file restore endpoints in the NetApp Backup and Recovery REST API' +--- + += Single file restore endpoints in the NetApp Backup and Recovery REST API + + + +The single file restore (SFR) endpoints retrieve files from the volume snapshots. + +You can perform the following operations by using the SFR endpoints: + + +* Start a snapshot backup file explore operation. +* Retrieve the snapshot backup file explore status. +* List files during snapshot backup file explore operations. + + + + diff --git a/cbs/sidebar.yml b/cbs/sidebar.yml deleted file mode 100644 index 70286b09..00000000 --- a/cbs/sidebar.yml +++ /dev/null @@ -1,3 +0,0 @@ -section: cbs -title: Backup and Recovery -generate: cbs diff --git a/cbs/storagegrid_overview.adoc b/cbs/storagegrid_overview.adoc new file mode 100644 index 00000000..dface9d6 --- /dev/null +++ b/cbs/storagegrid_overview.adoc @@ -0,0 +1,22 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/storagegrid_overview.html' +summary: 'StorageGRID endpoints in the NetApp Backup and Recovery REST API' +--- + += StorageGRID endpoints in the NetApp Backup and Recovery REST API + + + +The StorageGRID API endpoints retrieve version and other details for the StorageGRID server. You can also discover StorageGRID WebScale server in the NetApp Console SaaS application. + +You can perform the following operations by using the StorageGRID endpoints: + + +* Retrieve StorageGRID server version +* Retrieve details of the StorageGRID server. +* Discover or add new StorageGRID server into the NetApp Console. + + + + diff --git a/cbs/system_overview.adoc b/cbs/system_overview.adoc new file mode 100644 index 00000000..1178f620 --- /dev/null +++ b/cbs/system_overview.adoc @@ -0,0 +1,25 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cbs/system_overview.html' +summary: 'System endpoints in the NetApp Backup and Recovery REST API' +--- + += System endpoints in the NetApp Backup and Recovery REST API + + + +The system endpoints retrieves details of the systems, manage the backup policies and configure an object store associated with a system. + +You can perform the following operations by using the system endpoints: + +* Retrieve the list and details of systems, backup policies, IP spaces, storage VMs, and volumes, snapshot-policies, peer-cluster relationships, and SnapMirror relationships. + + +* Create a backup policy and configure an object store. + + +* List system volume directories. + + +* Modify a backup policy. + + diff --git a/copysync/accounts_overview.adoc b/copysync/accounts_overview.adoc new file mode 100644 index 00000000..161840d4 --- /dev/null +++ b/copysync/accounts_overview.adoc @@ -0,0 +1,22 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/accounts_overview.html' +summary: 'Accounts REST API endpoints in the NetApp Copy and Sync REST API' +--- + += Accounts REST API endpoints in the NetApp Copy and Sync REST API + + + +The accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations. +The following actions can be performed with the accounts endpoints: + +* Retrieve account statistics information +* Add a BYOL license +* Retrieve a list of NSS credentials associated with an account +* Retrieve license information of an account +* Update subscription information (using the /register API call) + + diff --git a/copysync/copysync-x-doc.json b/copysync/copysync-x-doc.json deleted file mode 100644 index cc737f91..00000000 --- a/copysync/copysync-x-doc.json +++ /dev/null @@ -1,1035 +0,0 @@ -{ - "overview": "NetApp Copy and Sync REST API", - "permalink": "overview.html", - "paths": { - "/api/accounts": { - "get": { - "x-doc": { - "title": "Retrieve the tenancy accounts", - "category": "Accounts", - "filename": "get-api-accounts.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete the current account", - "category": "Accounts", - "filename": "delete-api-accounts.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/info": { - "get": { - "x-doc": { - "title": "Retrieve the account information", - "category": "Accounts", - "filename": "get-api-accounts-info.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/register": { - "put": { - "x-doc": { - "title": "Register an account to a marketplace", - "category": "Accounts", - "filename": "put-api-accounts-register.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/relationships-stats": { - "get": { - "x-doc": { - "title": "Retrieve the logged-in account's relationship status", - "category": "Accounts", - "filename": "get-api-accounts-relationships-stats.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/v2/accounts/{accountId}/nss-credentials": { - "put": { - "x-doc": { - "title": "Add NetApp support site credentials", - "category": "Accounts", - "filename": "put-api-v2-accounts-nss-credentials.html", - "subcategory": null, - "explorer": false - } - }, - "get": { - "x-doc": { - "title": "Retrieve NetApp support site credentials", - "category": "Accounts", - "filename": "get-api-v2-accounts-nss-credentials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/licenses-v2": { - "put": { - "x-doc": { - "title": "Add a license", - "category": "Accounts", - "filename": "put-api-accounts-licenses-v2.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/licenses": { - "get": { - "x-doc": { - "title": "Retrieve a list of all licenses", - "category": "Accounts", - "filename": "get-api-accounts-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/license-settings": { - "get": { - "x-doc": { - "title": "Retrieve license settings", - "category": "Accounts", - "filename": "get-api-accounts-license-settings.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/licenses-v2/{serialNumber}": { - "delete": { - "x-doc": { - "title": "Delete a license serial number", - "category": "Accounts", - "filename": "delete-api-accounts-licenses-v2-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/v2/accounts/{accountId}/nss-credentials/v2/{nssKeyId}": { - "delete": { - "x-doc": { - "title": "Delete NetApp support site credentials", - "category": "Accounts", - "filename": "delete-api-v2-accounts-nss-credentials-v2-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/messages/client": { - "get": { - "x-doc": { - "title": "Retrieve the asynchronous messages", - "category": "Messages", - "filename": "get-api-messages-client.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers": { - "get": { - "x-doc": { - "title": "Retrieve all the data brokers", - "category": "Data Brokers", - "filename": "get-api-data-brokers.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new installer for the NetApp data broker instance", - "category": "Data Brokers", - "filename": "post-api-data-brokers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}": { - "delete": { - "x-doc": { - "title": "Delete an existing NetApp data broker", - "category": "Data Brokers", - "filename": "delete-api-data-brokers-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/data-brokers/{id}/restart": { - "put": { - "x-doc": { - "title": "Restart a data broker", - "category": "Data Brokers", - "filename": "put-api-accounts-data-brokers-restart.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/data-brokers/{id}/proxy": { - "put": { - "x-doc": { - "title": "Update the proxy configuration for a data broker", - "category": "Data Brokers", - "filename": "put-api-accounts-data-brokers-proxy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/data-brokers/{id}/move": { - "put": { - "x-doc": { - "title": "Move the data broker between groups", - "category": "Data Brokers", - "filename": "put-api-accounts-data-brokers-move.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-cifs-shares": { - "get": { - "x-doc": { - "title": "Retrieve the CIFS shares", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-cifs-shares.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-cifs-share-folders": { - "get": { - "x-doc": { - "title": "Retrieve the CIFS server folders", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-cifs-share-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-nfs-exports": { - "get": { - "x-doc": { - "title": "Retrieve the NFS server folders", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-nfs-exports.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-nfs-export-folders": { - "get": { - "x-doc": { - "title": "Retrieve the NFS server folders by ID", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-nfs-export-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-s3-buckets": { - "get": { - "x-doc": { - "title": "Retrieve the S3 buckets", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-s3-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-s3-bucket-folders": { - "get": { - "x-doc": { - "title": "Retrieve the S3 bucket folders", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-s3-bucket-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-sgws-buckets": { - "get": { - "x-doc": { - "title": "Retrieve the StorageGRID buckets", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-sgws-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-sgws-bucket-folders": { - "get": { - "x-doc": { - "title": "Retrieve the StorageGRID bucket folders", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-sgws-bucket-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-ibm-buckets": { - "get": { - "x-doc": { - "title": "Retrieve the IBM buckets", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-ibm-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-ibm-bucket-folders": { - "get": { - "x-doc": { - "title": "Retrieve the IBM bucket folders", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-ibm-bucket-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-ontap-s3-buckets": { - "get": { - "x-doc": { - "title": "Retrieve the ONTAP S3 buckets", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-ontap-s3-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-ontap-s3-bucket-folders": { - "get": { - "x-doc": { - "title": "Retrieve the ONTAP S3 bucket folders", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-ontap-s3-bucket-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-alibaba-buckets": { - "get": { - "x-doc": { - "title": "Retrieve the Alibaba buckets", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-alibaba-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-alibaba-bucket-folders": { - "get": { - "x-doc": { - "title": "Retrieve the Alibaba bucket folders", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-alibaba-bucket-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-azure-blob-storage-containers": { - "get": { - "x-doc": { - "title": "Retrieve the Azure blob storage containers", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-azure-blob-storage-containers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-azure-blob-storage-container-folders": { - "get": { - "x-doc": { - "title": "Retrieve the Azure blob storage container folders", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-azure-blob-storage-container-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-gcp-buckets": { - "get": { - "x-doc": { - "title": "Retrieve the Google Cloud buckets", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-gcp-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-gcp-bucket-folders": { - "get": { - "x-doc": { - "title": "Retrieve the Google Cloud bucket folders", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-gcp-bucket-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/data-brokers/{id}/list-aws-kms-keys": { - "get": { - "x-doc": { - "title": "Retrieve the AWS KMS keys", - "category": "Data Brokers", - "filename": "get-api-data-brokers-list-aws-kms-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/data-brokers/{id}/list-s3-private-links": { - "get": { - "x-doc": { - "title": "Retrieve the S3 private links", - "category": "Data Brokers", - "filename": "get-api-accounts-data-brokers-list-s3-private-links.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/data-brokers/{id}/local-configuration": { - "get": { - "x-doc": { - "title": "Retrieve the data broker local configuration", - "category": "Data Brokers", - "filename": "get-api-accounts-data-brokers-local-configuration.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/groups": { - "get": { - "x-doc": { - "title": "Retrieve all groups", - "category": "Groups", - "filename": "get-api-groups.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/groups/{id}/download-data-brokers-logs": { - "put": { - "x-doc": { - "title": "Download the data broker group logs", - "category": "Groups", - "filename": "put-api-groups-download-data-brokers-logs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/settings": { - "put": { - "x-doc": { - "title": "Modify the group settings", - "category": "Groups", - "filename": "put-api-accounts-groups-settings.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-sftp-root-directory": { - "get": { - "x-doc": { - "title": "Retrieve the SFTP root directory", - "category": "Groups", - "filename": "get-api-accounts-groups-list-sftp-root-directory.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-sftp-directories": { - "get": { - "x-doc": { - "title": "Retrieve the SFTP server folders", - "category": "Groups", - "filename": "get-api-accounts-groups-list-sftp-directories.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-cifs-shares": { - "get": { - "x-doc": { - "title": "Retrieve the CIFS shares", - "category": "Groups", - "filename": "get-api-accounts-groups-list-cifs-shares.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-cifs-share-folders": { - "get": { - "x-doc": { - "title": "Retrieve the CIFS server folders", - "category": "Groups", - "filename": "get-api-accounts-groups-list-cifs-share-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-nfs-exports": { - "get": { - "x-doc": { - "title": "Retrieve the NFS server exports", - "category": "Groups", - "filename": "get-api-accounts-groups-list-nfs-exports.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-nfs-export-folders": { - "get": { - "x-doc": { - "title": "Retrieve the NFS server folders", - "category": "Groups", - "filename": "get-api-accounts-groups-list-nfs-export-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-aws-kms-keys": { - "get": { - "x-doc": { - "title": "Retrieve the AWS KMS keys", - "category": "Groups", - "filename": "get-api-accounts-groups-list-aws-kms-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-s3-buckets": { - "get": { - "x-doc": { - "title": "Retrieve the S3 buckets", - "category": "Groups", - "filename": "get-api-accounts-groups-list-s3-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-s3-bucket-folders": { - "get": { - "x-doc": { - "title": "Retrieve the S3 bucket folders", - "category": "Groups", - "filename": "get-api-accounts-groups-list-s3-bucket-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-sgws-buckets": { - "get": { - "x-doc": { - "title": "Retrieve the StorageGRID buckets", - "category": "Groups", - "filename": "get-api-accounts-groups-list-sgws-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-sgws-bucket-folders": { - "get": { - "x-doc": { - "title": "Retrieve the StorageGRID bucket folders", - "category": "Groups", - "filename": "get-api-accounts-groups-list-sgws-bucket-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-ontap-s3-buckets": { - "get": { - "x-doc": { - "title": "Retrieve the ONTAP S3 buckets", - "category": "Groups", - "filename": "get-api-accounts-groups-list-ontap-s3-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-ontap-s3-bucket-folders": { - "get": { - "x-doc": { - "title": "Retrieve the ONTAP S3 bucket folders", - "category": "Groups", - "filename": "get-api-accounts-groups-list-ontap-s3-bucket-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-ibm-buckets": { - "get": { - "x-doc": { - "title": "Retrieve the IBM buckets", - "category": "Groups", - "filename": "get-api-accounts-groups-list-ibm-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-ibm-bucket-folders": { - "get": { - "x-doc": { - "title": "Retrieve the IBM bucket folders", - "category": "Groups", - "filename": "get-api-accounts-groups-list-ibm-bucket-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-alibaba-buckets": { - "get": { - "x-doc": { - "title": "Retrieve the Alibaba buckets", - "category": "Groups", - "filename": "get-api-accounts-groups-list-alibaba-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-alibaba-bucket-folders": { - "get": { - "x-doc": { - "title": "Retrieve the Alibaba bucket folders", - "category": "Groups", - "filename": "get-api-accounts-groups-list-alibaba-bucket-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-azure-blob-storage-containers": { - "get": { - "x-doc": { - "title": "Retrieve the Azure blob storage containers", - "category": "Groups", - "filename": "get-api-accounts-groups-list-azure-blob-storage-containers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-azure-blob-storage-container-folders": { - "get": { - "x-doc": { - "title": "Retrieve the Azure blob storage container folders", - "category": "Groups", - "filename": "get-api-accounts-groups-list-azure-blob-storage-container-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-azure-dataLake-storage-containers": { - "get": { - "x-doc": { - "title": "Retrieve the Azure Data Lake Gen2 storage containers", - "category": "Groups", - "filename": "get-api-accounts-groups-list-azure-datalake-storage-containers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-azure-dataLake-storage-container-folders": { - "get": { - "x-doc": { - "title": "Retrieve the Azure Data Lake Gen2 storage container folders", - "category": "Groups", - "filename": "get-api-accounts-groups-list-azure-datalake-storage-container-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-gcp-buckets": { - "get": { - "x-doc": { - "title": "Retrieve the Google Cloud buckets", - "category": "Groups", - "filename": "get-api-accounts-groups-list-gcp-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-gcp-bucket-folders": { - "get": { - "x-doc": { - "title": "Retrieve the Google Cloud bucket folders", - "category": "Groups", - "filename": "get-api-accounts-groups-list-gcp-bucket-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-gcp-kms-keys": { - "get": { - "x-doc": { - "title": "Retrieve the Google Cloud KMS keys", - "category": "Groups", - "filename": "get-api-accounts-groups-list-gcp-kms-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-google-drives": { - "get": { - "x-doc": { - "title": "Retrieve the Google Drives", - "category": "Groups", - "filename": "get-api-accounts-groups-list-google-drives.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-google-drive-folders": { - "get": { - "x-doc": { - "title": "Retrieve the Google Drive folders", - "category": "Groups", - "filename": "get-api-accounts-groups-list-google-drive-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-box-root-folder": { - "get": { - "x-doc": { - "title": "Retrieve the Box API root folder", - "category": "Groups", - "filename": "get-api-accounts-groups-list-box-root-folder.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-box-folders": { - "get": { - "x-doc": { - "title": "Retrieve the Box API server folders", - "category": "Groups", - "filename": "get-api-accounts-groups-list-box-folders.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-s3-private-links": { - "get": { - "x-doc": { - "title": "Retrieve the S3 private links", - "category": "Groups", - "filename": "get-api-accounts-groups-list-s3-private-links.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/groups/{id}": { - "delete": { - "x-doc": { - "title": "Delete a data broker group", - "category": "Groups", - "filename": "delete-api-accounts-groups-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/relationships-v2": { - "get": { - "x-doc": { - "title": "Retrieve all relationships", - "category": "Relationships", - "filename": "get-api-relationships-v2.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new relationship", - "category": "Relationships", - "filename": "post-api-relationships-v2.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/relationships-v2/{id}": { - "get": { - "x-doc": { - "title": "Retrieve a relationship", - "category": "Relationships", - "filename": "get-api-relationships-v2-.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update the settings for a relationship", - "category": "Relationships", - "filename": "put-api-relationships-v2-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/relationships/{id}": { - "delete": { - "x-doc": { - "title": "Delete an existing relationship", - "category": "Relationships", - "filename": "delete-api-relationships-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/v2/accounts/{accountId}/relationships": { - "delete": { - "x-doc": { - "title": "Delete relationships", - "category": "Relationships", - "filename": "delete-api-v2-accounts-relationships.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/relationships/{id}/sync": { - "put": { - "x-doc": { - "title": "Initiate a relationship data sync", - "category": "Relationships", - "filename": "put-api-relationships-sync.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/relationships/{id}/abort": { - "put": { - "x-doc": { - "title": "Stop the relationship data sync", - "category": "Relationships", - "filename": "put-api-relationships-abort.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/relationships/end-points": { - "get": { - "x-doc": { - "title": "Retrieve the relationship endpoints", - "category": "Relationships", - "filename": "get-api-accounts-relationships-end-points.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/relationships/{id}/credentials": { - "put": { - "x-doc": { - "title": "Modify the source or target credentials", - "category": "Relationships", - "filename": "put-api-accounts-relationships-credentials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/relationships/{id}/tags": { - "put": { - "x-doc": { - "title": "Edit the relationship tags", - "category": "Relationships", - "filename": "put-api-accounts-relationships-tags.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/storages/{protocol}": { - "get": { - "x-doc": { - "title": "Retrieve the storage type", - "category": "Storages", - "filename": "get-api-storages-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/reports": { - "post": { - "x-doc": { - "title": "Create a new report", - "category": "Reports", - "filename": "post-api-accounts-reports.html", - "subcategory": null, - "explorer": false - } - }, - "get": { - "x-doc": { - "title": "Retrieve a list of all reports", - "category": "Reports", - "filename": "get-api-accounts-reports.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete the reports by a specified report ID", - "category": "Reports", - "filename": "delete-api-accounts-reports.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/reports/end-points": { - "get": { - "x-doc": { - "title": "Retrieve a list of the reports endpoints", - "category": "Reports", - "filename": "get-api-accounts-reports-end-points.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/accounts/{accountId}/reports/{id}": { - "get": { - "x-doc": { - "title": "Retrieve a report by a specified ID", - "category": "Reports", - "filename": "get-api-accounts-reports-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/api/timelines": { - "get": { - "x-doc": { - "title": "Retrieve timelines", - "category": "Timelines", - "filename": "get-api-timelines.html", - "subcategory": null, - "explorer": false - } - } - } - }, - "categories": [ - { - "id": "accounts", - "title": "Accounts REST API endpoints in the NetApp Copy and Sync REST API", - "permalink": "accounts_overview.html" - }, - { - "id": "data brokers", - "title": "Data brokers endpoints in the NetApp Copy and Sync REST API", - "permalink": "data_brokers_overview.html" - }, - { - "id": "groups", - "title": "Groups endpoints in the NetApp Copy and Sync REST API", - "permalink": "groups_overview.html" - }, - { - "id": "messages", - "title": "Messages endpoints in the NetApp Copy and Sync REST API", - "permalink": "messages_overview.html" - }, - { - "id": "relationships", - "title": "Relationships endpoints in the NetApp Copy and Sync REST API", - "permalink": "relationships_overview.html" - }, - { - "id": "reports", - "title": "Reports endpoints in the NetApp Copy and Sync REST API", - "permalink": "reports_overview.html" - }, - { - "id": "storages", - "title": "Storages endpoints in the NetApp Copy and Sync REST API", - "permalink": "storages_overview.html" - }, - { - "id": "timelines", - "title": "Timelines endpoints in the NetApp Copy and Sync REST API", - "permalink": "timelines_overview.html" - } - ] -} \ No newline at end of file diff --git a/copysync/copysync.json b/copysync/copysync.json deleted file mode 100644 index 09a0eb55..00000000 --- a/copysync/copysync.json +++ /dev/null @@ -1,17733 +0,0 @@ -{ - "openapi": "3.0.3", - "info": { - "title": "Console Copy and Sync API documentation", - "description": "
Overview\nThe NetApp Copy and Sync service offers a simple, secure, and automated way to migrate your data to any location in the cloud or on your premises. The service enables you to convert and move data stored in any object store including NFS or SMB servers, Amazon Simple Storage Service (S3), Google Drive, Box, and more. When using this service, you can create a sync relationship to copy data from any source to any destination target.

The service exposes an associated REST API which you can programmatically use to administer the Copy and Sync API resources. There are eight categories of endpoints defined within the NetApp Copy and Sync REST API:\n
    \n
  • Accounts
    • \n
  • Messages
    • \n
  • Data Brokers
    • \n
  • Groups
    • \n
  • Relationships
    • \n
  • Storages
    • \n
  • Reports
    • \n
  • Timelines (deprecated)
    • \n
\n

See the NetApp Copy and Sync APIs to get started.

\nNote: Before using the API reference documentation, review the Get started section for the NetApp Console APIs. For more information about the security tokens and identifiers you’ll need when using the API, review the Common workflows and tasks section.
\n

\n
\n
\nREST implementation\n

HTTP methods

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MethodDescription
POSTCreate a resource
GETRetrieve a resource instance or collection
PUTUpdate specific properties of an existing resource instance
DELETERemove an existing resource
\n

Request headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Request HeaderDescription
authorizationRequired. Contains a JWT token (user)
x-account-idContains the tenancy account ID and can be included depending on the API call
usernameContains SMB or SFTP username when calling the APIs related to SMB
passwordContains SMB or SFTP password when calling the APIs related to SMB
domainContains SMB domain when calling the APIs related to SMB
access-keyContains an AWS access key when calling the APIs related to StorageGRID, IBM, or ONTAP S3
secret-keyContains an AWS access key when calling the APIs related to StorageGRID, IBM, or ONTAP S3
storage-account-connection-stringContains an Azure storage account connection string when calling the APIs related to Azure storage accounts
x-bucket-nameContains a bucket name when calling the AWS list S3 private links API
private-keyContains a Google drive private key when calling the Google drive APIs
client-emailContains a Google drive client email when calling the Google drive APIs
subjectContains a Google drive subject when calling the Google drive APIs
client-secretContains a Box client secret when calling the Box APIs
public-key-idContains a Box public key ID when calling the Box APIs
private-keyContains a Box private key ID when calling the Box APIs
passphraseContains a Box passphrase ID when calling the Box APIs
x-netapp-external-request-id-srcContains an ID to use when accessing the external vault
x-netapp-external-request-id-trgContains an ID to use when accessing the external vault
\n

Query parameters

\n

A list of all the possible query parameters available for each service component is provided in the table below. This is a summary by component, however not every query parameter can be used with each endpoint in a specific component. See the detailed descriptions of the individual API calls for more details.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ComponentQuery Parameter
AccountsnoCreate (optional)
\n target (required)
\n
Messageslast (optional)
\n
Data Brokershost (required)
\n version(optional
\n path(optional)
\n isEFS(optional)
\n exportName(required)
\n accessPoint(optional)
\n bucket(required)
\n prefix(optional)
\n port(optional)
\n storageAccountName(required)
\n container(required)
\n region(required)
\n
Groupshost (required)
\n port(optional)
\n rootDirectory(required)
\n version(optional)
\n path(optional)
\n isEFS(optional)
\n exportName(required)
\n accessPoint(optional)
\n bucket(required)
\n prefix(optional)
\n port(required/optional)
\n storageAccountName(required)
\n container(required)
\n driveId(required)
\n folderId(optional or required)
\n folderName(optional)
\n clientId(required)
\n enterpriseId(required)
\n appName(optional)
\n region(required)
\n
Relationshipsrelationships (required)
\n
Storagesprovider (optional)
\n
Reportsreports (required)
\n
\n

Response headers

\n

This API uses the standard HTTP response headers common with all NetApp Console APIs. See REST implementation for more information.

\n

HTTP status codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP Status CodeDescription
200OK: Returned for successful operation completion
400Bad Request: Returned if the input is malformed and could not be parsed
401Unauthorized: Returned if user authentication failed or the token has expired
403Forbidden: Returned for authorization errors depending on the resource and token
404Not Found: Returned if the requested resource could not be found
500Processing Error: Returned if an error occurs on the server while processing the API call
\n
\n
\n
Error handling\nThe following processes are involved with error handling and processing:\n
    \n
  • The error is logged for supportability.
    • \n
  • The error is also returned to the API caller on synchronous operations.
    • \n
  • In case of asynchronous operations, the error will be returned on the GET /messages API.
    • \n
\n
\ncURL examples\nThe following example retrieves relationships for a specific account:\n

curl -X GET https://api.cloudsync.netapp.com/api/relationships-v2 -H \"accept: application/json\" -H \"authorization: \" -H \"x-account-id:\"

\n

The following example retrieves reports for a specific account:

\n

curl -X GET https://api.cloudsync.netapp.com/api/accounts//reports -H \"accept: application/json\" -H \"authorization: \"

\n


", - "version": "1.0.59" - }, - "components": { - "securitySchemes": { - "http": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "JWT" - } - }, - "schemas": {} - }, - "paths": { - "/api/accounts": { - "get": { - "tags": [ - "Accounts" - ], - "description": "Retrieves the tenancy accounts.", - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "description": "NetApp tenancy account name", - "type": "string" - }, - "accountId": { - "description": "NetApp tenancy public ID", - "type": "string" - } - }, - "required": [ - "name", - "accountId" - ] - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Accounts" - ], - "description": "Deletes the current account. WARNING: This action will delete the current account from the Copy and Sync API.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/info": { - "get": { - "tags": [ - "Accounts" - ], - "description": "Retrieves the account information.", - "parameters": [ - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "noCreate", - "required": false, - "description": "Don’t create the requested account if it doesn’t already exist" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "accountId": { - "description": "The logged in account's tenancy ID", - "type": "string" - }, - "name": { - "description": "The logged in account's name as retrieved from the OAuth provider", - "type": "string" - }, - "noCharge": { - "description": "Indicates whether all the relationships are Azure NetApp Files", - "type": "boolean" - }, - "daysLeftForTrial": { - "description": "Days left for a free trial or (-1) if the trial has already expired", - "type": "number" - }, - "subscriptionType": { - "description": " Subscription type", - "enum": [ - "CONTRACT", - "PAYGO" - ], - "type": "string" - }, - "subscriptionStatus": { - "description": "The account's AWS marketplace subscription status", - "enum": [ - "unsubscribed-init", - "resolve-failed", - "subscribe-success", - "unsubscribe-success" - ], - "type": "string" - }, - "subscriptionProvider": { - "description": "SaaS subscription type", - "enum": [ - "azure", - "aws" - ], - "type": "string" - } - }, - "required": [ - "accountId", - "name", - "noCharge", - "daysLeftForTrial", - "subscriptionType", - "subscriptionStatus", - "subscriptionProvider" - ] - } - } - } - } - } - } - }, - "/api/accounts/register": { - "put": { - "tags": [ - "Accounts" - ], - "description": "Registers an account to a marketplace.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mpProvider": { - "description": "Customer subscription provider received from the marketplace", - "enum": [ - "azure", - "aws" - ], - "type": "string" - }, - "mpCustomerToken": { - "description": "Customer subscription token received from the marketplace", - "type": "string" - } - }, - "required": [ - "mpProvider", - "mpCustomerToken" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/relationships-stats": { - "get": { - "tags": [ - "Accounts" - ], - "description": "Retrieves the logged-in account's relationship status.", - "parameters": [ - { - "schema": { - "enum": [ - "anf" - ], - "type": "string" - }, - "in": "query", - "name": "target", - "required": false, - "description": "Request for relationships with target Azure NetApp Files and source Cloud Volumes ONTAP stats" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sourceEdge", - "required": false, - "description": "Source Edge Cluster UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "targetEdge", - "required": false, - "description": "Target Edge Cluster UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "syncTarget", - "required": false, - "description": "Target sync type (edge or cloud) " - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "syncSource", - "required": false, - "description": "Source sync type (edge or cloud) " - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "totalBytes": { - "description": "Total bytes copied according to requested flags", - "type": "number" - }, - "numberOfRelationships": { - "description": "Total number of relationships according to the requested flags", - "type": "number" - }, - "totalFiles": { - "description": "Total number of files copied according to requested flags", - "type": "number" - }, - "bytesCopiedInTheLast30Days": { - "description": "Array of bytes copied per day in the last 30 days", - "type": "array", - "items": { - "type": "object", - "properties": { - "date": { - "description": "date", - "type": "string" - }, - "bytesCopied": { - "description": "Total bytes copied in a day", - "type": "number" - } - }, - "required": [ - "date", - "bytesCopied" - ] - } - } - }, - "required": [ - "totalBytes", - "totalFiles", - "bytesCopiedInTheLast30Days" - ] - } - } - } - } - } - } - }, - "/api/v2/accounts/{accountId}/nss-credentials": { - "put": { - "tags": [ - "Accounts" - ], - "description": "Adds the NetApp Support Site credentials.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nssUsername": { - "description": "NSS user", - "type": "string" - }, - "nssPassword": { - "description": "NSS password", - "type": "string" - } - }, - "required": [ - "nssUsername", - "nssPassword" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nssKeyId": { - "description": "NSS key ID", - "type": "string" - }, - "username": { - "description": "NSS username", - "type": "string" - } - }, - "required": [ - "nssKeyId", - "username" - ] - } - } - } - } - } - }, - "get": { - "tags": [ - "Accounts" - ], - "description": "Retrieves the NetApp Support Site credentials.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "nssKeyId": { - "description": "NSS key ID", - "type": "string" - }, - "username": { - "description": "NSS username", - "type": "string" - } - }, - "required": [ - "nssKeyId", - "username" - ] - } - } - } - } - } - } - } - }, - "/api/accounts/{accountId}/licenses-v2": { - "put": { - "tags": [ - "Accounts" - ], - "description": "Adds a license.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "serialNumber": { - "description": "Serial number for license", - "type": "string" - }, - "nssKeyId": { - "description": "NSS Key ID", - "type": "string" - } - }, - "required": [ - "serialNumber", - "nssKeyId" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "serialNumber": { - "description": "The license's serial number", - "type": "string" - }, - "reservedRelationships": { - "description": "The reserved relationships", - "type": "number" - }, - "expirationDate": { - "description": "The license expiration date", - "type": "number" - } - }, - "required": [ - "serialNumber", - "reservedRelationships", - "expirationDate" - ] - } - } - } - } - } - } - }, - "/api/accounts/licenses": { - "get": { - "tags": [ - "Accounts" - ], - "description": "Retrieves a list of all licenses.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "licenses": { - "type": "array", - "items": { - "type": "object", - "properties": { - "serialNumber": { - "description": "The license's serial number", - "type": "string" - }, - "reservedRelationships": { - "description": "The reserved relationships", - "type": "number" - }, - "expirationDate": { - "description": "The license expiration date", - "type": "number" - } - }, - "required": [ - "serialNumber", - "reservedRelationships", - "expirationDate" - ] - } - } - }, - "required": [ - "licenses" - ] - } - } - } - } - } - } - }, - "/api/accounts/license-settings": { - "get": { - "tags": [ - "Accounts" - ], - "description": "Retrieves the license settings.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "freeTrial": { - "description": "If it is on free trial period", - "type": "boolean" - }, - "existingRelationships": { - "description": "The number of the existing relationships", - "type": "number" - }, - "reservedRelationships": { - "description": "The number of the BYOL relationships used", - "type": "number" - }, - "totalReservedRelationships": { - "description": "The total number of the BYOL relationships available", - "type": "number" - }, - "chargedRelationships": { - "description": "The number of the charged relationships", - "type": "number" - } - }, - "required": [ - "freeTrial", - "existingRelationships", - "reservedRelationships", - "totalReservedRelationships", - "chargedRelationships" - ] - } - } - } - } - } - } - }, - "/api/accounts/{accountId}/licenses-v2/{serialNumber}": { - "delete": { - "tags": [ - "Accounts" - ], - "description": "Deletes a license serial number.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "serialNumber", - "required": true, - "description": "License Serial Number" - } - ], - "responses": { - "200": { - "description": "Default Response" - } - } - } - }, - "/api/v2/accounts/{accountId}/nss-credentials/v2/{nssKeyId}": { - "delete": { - "tags": [ - "Accounts" - ], - "description": "Deletes the NetApp Support Site credentials.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "nssKeyId", - "required": true, - "description": "NSS key ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "Default Response" - } - } - } - }, - "/api/messages/client": { - "get": { - "tags": [ - "Messages" - ], - "description": "Retrieves the asynchronous messages. This API endpoint refers to a long polling endpoint for asynchronous messages.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "last", - "required": false, - "description": "Last Received message ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": false, - "description": "NetApp Tenancy Account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Message ID" - }, - "header": { - "type": "object", - "description": "Identifies the message's source - data broker, groupID", - "properties": { - "clientId": { - "type": "string", - "description": "The queue ID of the requesting client" - }, - "agentId": { - "type": "string", - "description": "Source Data Broker ID " - }, - "groupId": { - "type": "string", - "description": "Source Data Broker Group ID " - }, - "requestId": { - "type": "string", - "description": "Request ID" - } - } - }, - "payload": { - "type": "object", - "additionalProperties": true, - "description": "Arbitrary message payload object" - } - } - } - } - } - } - } - } - } - }, - "/api/data-brokers": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves all the data brokers.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Data Broker ID", - "type": "string" - }, - "type": { - "enum": [ - "AWS", - "ONPREM", - "AZURE", - "GCP" - ], - "description": "Data Broker Type", - "type": "string" - }, - "name": { - "description": "Data Broker Name", - "type": "string" - }, - "status": { - "description": "'COMPLETE' for an online data broker or 'FAILED' otherwise. Only available after the data broker has contacted the service for the first time", - "type": "string" - }, - "message": { - "description": "The error message if the data broker has a 'FAILED' status", - "type": "string" - }, - "fileLink": { - "description": "The link to the Data Broker Cloud Formation template or installer", - "type": "string" - }, - "transferRate": { - "description": "The Data broker current transfer rate", - "type": "number" - }, - "lastPing": { - "description": "The last time the Data Broker services did contact this service (EPOCH TIME)", - "type": "number" - }, - "port": { - "description": "If this is a NetApp 'listener' Data Broker, this is the port that data broker listens on", - "type": "number" - }, - "latestVersion": { - "description": "Latest Data Broker version available", - "type": "string" - }, - "encryptionType": { - "description": "Data Broker Encryption type - in case it is part of nfs encrypted relationship", - "type": "string" - }, - "groupId": { - "description": "Data Broker Group Id", - "type": "string" - }, - "placement": { - "description": "Data Broker placement information", - "type": "object", - "properties": { - "instanceId": { - "description": "Data Broker instance ID", - "type": "string" - }, - "hostname": { - "description": "Data Broker host name", - "type": "string" - }, - "privateIp": { - "description": "Data Broker private IP address", - "type": "string" - }, - "publicIp": { - "description": "Data Broker public ip IP address", - "type": "string" - }, - "region": { - "description": "Data Broker Region", - "type": "string" - }, - "availabilityZone": { - "description": "Data Broker Subnet Availability Zone", - "type": "string" - }, - "vpcId": { - "description": "Data Broker AWS VPC ID", - "type": "string" - }, - "vpcCidrBlock": { - "description": "Data Broker AWS VPC CIDR block", - "type": "string" - }, - "subnetId": { - "description": "Data Broker AWS Subnet ID", - "type": "string" - }, - "subnetCidrBlock": { - "description": "Data Broker AWS Subnet CIDR block", - "type": "string" - }, - "version": { - "description": "Data Broker version", - "type": "string" - }, - "awsAccountId": { - "description": "AWS account ID in which the data broker was created", - "type": "string" - }, - "vault": { - "description": "Vault version", - "type": "string" - }, - "node": { - "description": "Node version", - "type": "string" - }, - "canUpdateNodeVersion": { - "description": "Indicates if advanced node version is compatible with this distribution", - "type": "boolean" - }, - "cpu": { - "description": "Data Broker number of CPUs", - "type": "string" - }, - "processMaxMem": { - "description": "Data Broker Maximum Memory for process", - "type": "string" - }, - "osTotalMem": { - "description": "Data Broker Total memory", - "type": "string" - }, - "release": { - "description": "Data Broker image release", - "type": "string" - }, - "os": { - "description": "Data Broker OS", - "type": "string" - }, - "distribution": { - "description": "Data Broker distribution", - "type": "string" - }, - "resourceGroupName": { - "description": "Azure Data Broker resource group", - "type": "string" - }, - "zone": { - "description": "Azure Data Broker zone", - "type": "string" - }, - "serviceAccount": { - "description": "GCP Data Broker service account", - "type": "string" - }, - "gcpProjectId": { - "description": "GCP project ID", - "type": "string" - }, - "scanner": { - "type": "object", - "properties": { - "processes": { - "description": "Transferrer processes number", - "type": "number" - }, - "processesLimit": { - "description": "Scanner processes limit number", - "type": "number" - }, - "concurrency": { - "description": "How many tasks in parallel each transferrer process handles", - "type": "number" - } - }, - "required": [ - "processes", - "concurrency" - ] - }, - "transferrer": { - "type": "object", - "properties": { - "processes": { - "description": "Transferrer processes number", - "type": "number" - }, - "processesLimit": { - "description": "Scanner processes limit number", - "type": "number" - }, - "concurrency": { - "description": "How many tasks in parallel each transferrer process handles", - "type": "number" - } - }, - "required": [ - "processes", - "concurrency" - ] - }, - "platform": { - "description": "Data broker platform", - "type": "string" - }, - "cpus": { - "description": "Number of CPUs", - "type": "number" - }, - "proxy": { - "description": "Proxy string", - "type": "string" - }, - "canUpdateProxy": { - "description": "Allow to change proxy configuration", - "type": "boolean" - } - }, - "required": [ - "hostname", - "version", - "node", - "processMaxMem", - "osTotalMem", - "release", - "os", - "platform", - "cpus" - ] - } - }, - "required": [ - "id", - "type", - "name" - ] - } - } - } - } - } - } - }, - "post": { - "tags": [ - "Data Brokers" - ], - "description": "Creates a new installer for the NetApp data broker instance.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "groupId": { - "type": "string" - }, - "port": { - "type": "number" - }, - "certificate": { - "description": "For Listener data broker - if the user wants his own certificate", - "type": "string" - }, - "privateKey": { - "description": "For Listener data broker - if the user wants his own certificate", - "type": "string" - }, - "serverName": { - "description": "For Listener data broker - if the user wants his own certificate", - "type": "string" - }, - "type": { - "enum": [ - "AWS", - "ONPREM", - "AZURE", - "GCP" - ], - "type": "string" - } - }, - "required": [ - "name", - "type" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "groupId", - "type", - "fileLink", - "id", - "name" - ], - "properties": { - "id": { - "description": "Data Broker ID", - "type": "string" - }, - "groupId": { - "description": "Data Broker group ID", - "type": "string" - }, - "type": { - "description": "Data Broker type", - "type": "string", - "enum": [ - "AWS", - "GCP", - "ONPREM", - "AZURE" - ] - }, - "latestVersion": { - "type": "string", - "description": "Data Broker latest version available" - }, - "fileLink": { - "description": "Data Broker installer or template link", - "type": "string" - }, - "name": { - "description": "Data Broker name", - "type": "string" - }, - "template": { - "description": "Data Broker template - relevant for GCP/AZURE/AWS", - "type": [ - "string", - "object" - ], - "additionalProperties": true, - "properties": { - "config": { - "type": "object", - "properties": { - "content": { - "type": "string" - } - } - }, - "imports": { - "type": "array", - "items": { - "content": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - } - } - }, - "/api/data-brokers/{id}": { - "delete": { - "tags": [ - "Data Brokers" - ], - "description": "Deletes an existing NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/data-brokers/{id}/restart": { - "put": { - "tags": [ - "Data Brokers" - ], - "description": "Restarts a data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/data-brokers/{id}/proxy": { - "put": { - "tags": [ - "Data Brokers" - ], - "description": "Updates the proxy configuration for a data broker.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "host": { - "description": "Proxy host", - "type": "string" - }, - "port": { - "description": "Proxy port", - "type": "string" - }, - "userName": { - "description": "Proxy userName", - "type": "string" - }, - "password": { - "description": "Proxy password", - "type": "string" - } - }, - "required": [ - "host", - "port" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/data-brokers/{id}/move": { - "put": { - "tags": [ - "Data Brokers" - ], - "description": "Moves the data broker between groups.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "targetGroupId": { - "description": "Target Group ID", - "type": "string" - }, - "targetGroupName": { - "description": "Target Group Name - use in case you want to move to a new group", - "type": "string" - } - } - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - } - ], - "responses": { - "200": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-cifs-shares": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the CIFS shares accessible from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "CIFS server hostname or IP" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "version", - "required": false, - "description": "CIFS version" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "username", - "required": true, - "description": "CIFS server username" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "password", - "required": true, - "description": "CIFS server password" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "domain", - "required": false, - "description": "CIFS server domain" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-cifs-share-folders": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the CIFS server folders from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "CIFS server hostname or IP" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "version", - "required": false, - "description": "CIFS version" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "path", - "required": false, - "description": "CIFS server share path" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "share", - "required": true, - "description": "Cifs share" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "username", - "required": true, - "description": "CIFS server username" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "password", - "required": true, - "description": "CIFS server password" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "domain", - "required": false, - "description": "CIFS server domain" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-nfs-exports": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the NFS server folders from a data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "NFS server hostname or IP" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "isEFS", - "required": false, - "description": "Indicates if the is target EFS" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-nfs-export-folders": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the NFS server folders from the data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "NFS server hostname or IP" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "exportName", - "required": true, - "description": "NFS server export" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "isEFS", - "required": false, - "description": "Indicates if the is target EFS" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "version", - "required": false, - "description": "NFS version supported versions 3, 4.0, 4.1, 4.2" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "accessPoint", - "required": false, - "description": "EFS access point" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "path", - "required": false, - "description": "NFS Export path" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-s3-buckets": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the S3 buckets accessible from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-s3-bucket-folders": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the S3 bucket folders from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Path inside the container, to list folders in" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-sgws-buckets": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the StorageGRID buckets accessible from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "Server hostname or IP" - }, - { - "schema": { - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "in": "query", - "name": "port", - "required": true, - "description": "Server port" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-sgws-bucket-folders": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the StorageGRID bucket folders from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "Server hostname or IP" - }, - { - "schema": { - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "in": "query", - "name": "port", - "required": false, - "description": "Server port" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Prefix" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-ibm-buckets": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the IBM buckets accessible from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "Server hostname or IP" - }, - { - "schema": { - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "in": "query", - "name": "port", - "required": true, - "description": "Server port" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-ibm-bucket-folders": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the IBM bucket folders from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "Server hostname or IP" - }, - { - "schema": { - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "in": "query", - "name": "port", - "required": false, - "description": "Server port" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Prefix" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-ontap-s3-buckets": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the ONTAP S3 buckets accessible from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "ONTAP S3 hostname or IP" - }, - { - "schema": { - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "in": "query", - "name": "port", - "required": false, - "description": "Server port" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-ontap-s3-bucket-folders": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the ONTAP S3 bucket folders from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "ONTAP S3 hostname or IP" - }, - { - "schema": { - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "in": "query", - "name": "port", - "required": false, - "description": "Server port" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Path inside the bucket, to list folders in" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-alibaba-buckets": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the Alibaba buckets accessible from a data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-alibaba-bucket-folders": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the Alibaba bucket folders from a data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Path inside the container, to list folders in" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-azure-blob-storage-containers": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the Azure blob storage containers.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "storageAccountName", - "required": true, - "description": "Azure storage account name" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "storage-account-connection-string", - "required": true, - "description": "Azure storage account connection-string" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-azure-blob-storage-container-folders": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the Azure blob storage container folders.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "storageAccountName", - "required": true, - "description": "Azure storage account name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "container", - "required": true, - "description": "Container" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Path inside the container, to list folders in" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "storage-account-connection-string", - "required": true, - "description": "Azure storage account connection-string" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-gcp-buckets": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the Google Cloud buckets accessible from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-gcp-bucket-folders": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the Google Cloud bucket folders from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Path inside the container, to list folders in" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/data-brokers/{id}/list-aws-kms-keys": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the AWS KMS keys from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "AWS Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/data-brokers/{id}/list-s3-private-links": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the S3 private links.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "region", - "required": true, - "description": "AWS region" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-bucket-name", - "required": false, - "description": " S3 bucket- for UI use" - } - ], - "deprecated": true, - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/data-brokers/{id}/local-configuration": { - "get": { - "tags": [ - "Data Brokers" - ], - "description": "Retrieves the data broker local configuration.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/groups": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves all data broker groups.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Group ID", - "type": "string" - }, - "name": { - "description": "Group Name", - "type": "string" - }, - "relationships": { - "type": "array", - "items": { - "description": "Relationship ID", - "type": "string" - } - }, - "encryptionType": { - "description": "Group encryption type", - "type": "string" - }, - "dataBrokers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Data Broker ID", - "type": "string" - }, - "type": { - "enum": [ - "AWS", - "ONPREM", - "AZURE", - "GCP" - ], - "description": "Data Broker Type", - "type": "string" - }, - "name": { - "description": "Data Broker Name", - "type": "string" - }, - "status": { - "description": "'COMPLETE' for an online data broker or 'FAILED' otherwise. Only available after the data broker has contacted the service for the first time", - "type": "string" - }, - "message": { - "description": "The error message if the data broker has a 'FAILED' status", - "type": "string" - }, - "fileLink": { - "description": "The link to the Data Broker Cloud Formation template or installer", - "type": "string" - }, - "transferRate": { - "description": "The Data broker current transfer rate", - "type": "number" - }, - "lastPing": { - "description": "The last time the Data Broker services did contact this service (EPOCH TIME)", - "type": "number" - }, - "port": { - "description": "If this is a NetApp 'listener' Data Broker, this is the port that data broker listens on", - "type": "number" - }, - "latestVersion": { - "description": "Latest Data Broker version available", - "type": "string" - }, - "encryptionType": { - "description": "Data Broker Encryption type - in case it is part of nfs encrypted relationship", - "type": "string" - }, - "groupId": { - "description": "Data Broker Group Id", - "type": "string" - }, - "placement": { - "description": "Data Broker placement information", - "type": "object", - "properties": { - "instanceId": { - "description": "Data Broker instance ID", - "type": "string" - }, - "hostname": { - "description": "Data Broker host name", - "type": "string" - }, - "privateIp": { - "description": "Data Broker private IP address", - "type": "string" - }, - "publicIp": { - "description": "Data Broker public ip IP address", - "type": "string" - }, - "region": { - "description": "Data Broker Region", - "type": "string" - }, - "availabilityZone": { - "description": "Data Broker Subnet Availability Zone", - "type": "string" - }, - "vpcId": { - "description": "Data Broker AWS VPC ID", - "type": "string" - }, - "vpcCidrBlock": { - "description": "Data Broker AWS VPC CIDR block", - "type": "string" - }, - "subnetId": { - "description": "Data Broker AWS Subnet ID", - "type": "string" - }, - "subnetCidrBlock": { - "description": "Data Broker AWS Subnet CIDR block", - "type": "string" - }, - "version": { - "description": "Data Broker version", - "type": "string" - }, - "awsAccountId": { - "description": "AWS account ID in which the data broker was created", - "type": "string" - }, - "vault": { - "description": "Vault version", - "type": "string" - }, - "node": { - "description": "Node version", - "type": "string" - }, - "canUpdateNodeVersion": { - "description": "Indicates if advanced node version is compatible with this distribution", - "type": "boolean" - }, - "cpu": { - "description": "Data Broker number of CPUs", - "type": "string" - }, - "processMaxMem": { - "description": "Data Broker Maximum Memory for process", - "type": "string" - }, - "osTotalMem": { - "description": "Data Broker Total memory", - "type": "string" - }, - "release": { - "description": "Data Broker image release", - "type": "string" - }, - "os": { - "description": "Data Broker OS", - "type": "string" - }, - "distribution": { - "description": "Data Broker distribution", - "type": "string" - }, - "resourceGroupName": { - "description": "Azure Data Broker resource group", - "type": "string" - }, - "zone": { - "description": "Azure Data Broker zone", - "type": "string" - }, - "serviceAccount": { - "description": "GCP Data Broker service account", - "type": "string" - }, - "gcpProjectId": { - "description": "GCP project ID", - "type": "string" - }, - "scanner": { - "type": "object", - "properties": { - "processes": { - "description": "Transferrer processes number", - "type": "number" - }, - "processesLimit": { - "description": "Scanner processes limit number", - "type": "number" - }, - "concurrency": { - "description": "How many tasks in parallel each transferrer process handles", - "type": "number" - } - }, - "required": [ - "processes", - "concurrency" - ] - }, - "transferrer": { - "type": "object", - "properties": { - "processes": { - "description": "Transferrer processes number", - "type": "number" - }, - "processesLimit": { - "description": "Scanner processes limit number", - "type": "number" - }, - "concurrency": { - "description": "How many tasks in parallel each transferrer process handles", - "type": "number" - } - }, - "required": [ - "processes", - "concurrency" - ] - }, - "platform": { - "description": "Data broker platform", - "type": "string" - }, - "cpus": { - "description": "Number of CPUs", - "type": "number" - }, - "proxy": { - "description": "Proxy string", - "type": "string" - }, - "canUpdateProxy": { - "description": "Allow to change proxy configuration", - "type": "boolean" - } - }, - "required": [ - "hostname", - "version", - "node", - "processMaxMem", - "osTotalMem", - "release", - "os", - "platform", - "cpus" - ] - } - }, - "required": [ - "id", - "type", - "name" - ] - } - }, - "createdAt": { - "description": "Group creation time", - "type": "string" - }, - "configuration": { - "type": "object", - "properties": { - "scanner": { - "type": "object", - "properties": { - "concurrency": { - "default": 50, - "description": "Concurrency - Number of tasks running in parallel", - "maximum": 200, - "minimum": 1, - "type": "number" - }, - "processesLimit": { - "default": 10, - "description": "Processes Limit - Number of concurrent processes", - "maximum": 10, - "minimum": 1, - "type": "number" - } - } - }, - "transferrer": { - "type": "object", - "properties": { - "concurrency": { - "default": 50, - "description": "Concurrency - Number of tasks running in parallel", - "maximum": 200, - "minimum": 1, - "type": "number" - }, - "processesLimit": { - "default": 10, - "description": "Processes Limit - Number of concurrent processes", - "maximum": 10, - "minimum": 1, - "type": "number" - } - } - } - } - } - }, - "required": [ - "id", - "name", - "dataBrokers", - "createdAt" - ] - } - } - } - } - } - } - } - }, - "/api/groups/{id}/download-data-brokers-logs": { - "put": { - "tags": [ - "Groups" - ], - "description": "Downloads the data broker group logs.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Broker Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/settings": { - "put": { - "tags": [ - "Groups" - ], - "description": "Modifies the data broker group settings.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "description": "Group Name", - "type": "string" - }, - "scanner": { - "type": "object", - "properties": { - "concurrency": { - "default": 50, - "description": "Concurrency - Number of tasks running in parallel", - "maximum": 200, - "minimum": 1, - "type": "number" - }, - "processesLimit": { - "default": 10, - "description": "Processes Limit - Number of concurrent processes", - "maximum": 10, - "minimum": 1, - "type": "number" - } - } - }, - "transferrer": { - "type": "object", - "properties": { - "concurrency": { - "default": 50, - "description": "Concurrency - Number of tasks running in parallel", - "maximum": 200, - "minimum": 1, - "type": "number" - }, - "processesLimit": { - "default": 10, - "description": "Processes Limit - Number of concurrent processes", - "maximum": 10, - "minimum": 1, - "type": "number" - } - } - } - } - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "description": "Group ID", - "type": "string" - }, - "name": { - "description": "Group Name", - "type": "string" - }, - "dataBrokers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Data Broker ID", - "type": "string" - }, - "type": { - "enum": [ - "AWS", - "ONPREM", - "AZURE", - "GCP" - ], - "description": "Data Broker Type", - "type": "string" - }, - "name": { - "description": "Data Broker Name", - "type": "string" - }, - "status": { - "description": "'COMPLETE' for an online data broker or 'FAILED' otherwise. Only available after the data broker has contacted the service for the first time", - "type": "string" - }, - "message": { - "description": "The error message if the data broker has a 'FAILED' status", - "type": "string" - }, - "fileLink": { - "description": "The link to the Data Broker Cloud Formation template or installer", - "type": "string" - }, - "transferRate": { - "description": "The Data broker current transfer rate", - "type": "number" - }, - "lastPing": { - "description": "The last time the Data Broker services did contact this service (EPOCH TIME)", - "type": "number" - }, - "port": { - "description": "If this is a NetApp 'listener' Data Broker, this is the port that data broker listens on", - "type": "number" - }, - "latestVersion": { - "description": "Latest Data Broker version available", - "type": "string" - }, - "encryptionType": { - "description": "Data Broker Encryption type - in case it is part of nfs encrypted relationship", - "type": "string" - }, - "groupId": { - "description": "Data Broker Group Id", - "type": "string" - }, - "placement": { - "description": "Data Broker placement information", - "type": "object", - "properties": { - "instanceId": { - "description": "Data Broker instance ID", - "type": "string" - }, - "hostname": { - "description": "Data Broker host name", - "type": "string" - }, - "privateIp": { - "description": "Data Broker private IP address", - "type": "string" - }, - "publicIp": { - "description": "Data Broker public ip IP address", - "type": "string" - }, - "region": { - "description": "Data Broker Region", - "type": "string" - }, - "availabilityZone": { - "description": "Data Broker Subnet Availability Zone", - "type": "string" - }, - "vpcId": { - "description": "Data Broker AWS VPC ID", - "type": "string" - }, - "vpcCidrBlock": { - "description": "Data Broker AWS VPC CIDR block", - "type": "string" - }, - "subnetId": { - "description": "Data Broker AWS Subnet ID", - "type": "string" - }, - "subnetCidrBlock": { - "description": "Data Broker AWS Subnet CIDR block", - "type": "string" - }, - "version": { - "description": "Data Broker version", - "type": "string" - }, - "awsAccountId": { - "description": "AWS account ID in which the data broker was created", - "type": "string" - }, - "vault": { - "description": "Vault version", - "type": "string" - }, - "node": { - "description": "Node version", - "type": "string" - }, - "canUpdateNodeVersion": { - "description": "Indicates if advanced node version is compatible with this distribution", - "type": "boolean" - }, - "cpu": { - "description": "Data Broker number of CPUs", - "type": "string" - }, - "processMaxMem": { - "description": "Data Broker Maximum Memory for process", - "type": "string" - }, - "osTotalMem": { - "description": "Data Broker Total memory", - "type": "string" - }, - "release": { - "description": "Data Broker image release", - "type": "string" - }, - "os": { - "description": "Data Broker OS", - "type": "string" - }, - "distribution": { - "description": "Data Broker distribution", - "type": "string" - }, - "resourceGroupName": { - "description": "Azure Data Broker resource group", - "type": "string" - }, - "zone": { - "description": "Azure Data Broker zone", - "type": "string" - }, - "serviceAccount": { - "description": "GCP Data Broker service account", - "type": "string" - }, - "gcpProjectId": { - "description": "GCP project ID", - "type": "string" - }, - "scanner": { - "type": "object", - "properties": { - "processes": { - "description": "Transferrer processes number", - "type": "number" - }, - "processesLimit": { - "description": "Scanner processes limit number", - "type": "number" - }, - "concurrency": { - "description": "How many tasks in parallel each transferrer process handles", - "type": "number" - } - }, - "required": [ - "processes", - "concurrency" - ] - }, - "transferrer": { - "type": "object", - "properties": { - "processes": { - "description": "Transferrer processes number", - "type": "number" - }, - "processesLimit": { - "description": "Scanner processes limit number", - "type": "number" - }, - "concurrency": { - "description": "How many tasks in parallel each transferrer process handles", - "type": "number" - } - }, - "required": [ - "processes", - "concurrency" - ] - }, - "platform": { - "description": "Data broker platform", - "type": "string" - }, - "cpus": { - "description": "Number of CPUs", - "type": "number" - }, - "proxy": { - "description": "Proxy string", - "type": "string" - }, - "canUpdateProxy": { - "description": "Allow to change proxy configuration", - "type": "boolean" - } - }, - "required": [ - "hostname", - "version", - "node", - "processMaxMem", - "osTotalMem", - "release", - "os", - "platform", - "cpus" - ] - } - }, - "required": [ - "id", - "type", - "name" - ] - } - }, - "configuration": { - "type": "object", - "properties": { - "scanner": { - "type": "object", - "properties": { - "concurrency": { - "default": 50, - "description": "Concurrency - Number of tasks running in parallel", - "maximum": 200, - "minimum": 1, - "type": "number" - }, - "processesLimit": { - "default": 10, - "description": "Processes Limit - Number of concurrent processes", - "maximum": 10, - "minimum": 1, - "type": "number" - } - } - }, - "transferrer": { - "type": "object", - "properties": { - "concurrency": { - "default": 50, - "description": "Concurrency - Number of tasks running in parallel", - "maximum": 200, - "minimum": 1, - "type": "number" - }, - "processesLimit": { - "default": 10, - "description": "Processes Limit - Number of concurrent processes", - "maximum": 10, - "minimum": 1, - "type": "number" - } - } - } - } - } - }, - "required": [ - "id", - "name", - "dataBrokers" - ] - } - } - } - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-sftp-root-directory": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the SFTP root directory.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "SFTP server hostname or IP" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "port", - "required": true, - "description": "SFTP server port" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "username", - "required": true, - "description": "SFTP server username" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "password", - "required": true, - "description": "SFTP server password" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-sftp-directories": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the SFTP server folders from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "SFTP server hostname or IP" - }, - { - "schema": { - "type": "number" - }, - "in": "query", - "name": "port", - "required": true, - "description": "SFTP server port" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "rootDirectory", - "required": true, - "description": "SFTP server root directory path" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "path", - "required": false, - "description": "SFTP server root directory path" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "username", - "required": true, - "description": "SFTP server username" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "password", - "required": true, - "description": "SFTP server password" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-cifs-shares": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the CIFS shares accessible from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "CIFS server hostname or IP" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "version", - "required": false, - "description": "CIFS version" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "username", - "required": true, - "description": "CIFS server username" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "password", - "required": true, - "description": "CIFS server password" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "domain", - "required": false, - "description": "CIFS server domain" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-cifs-share-folders": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the CIFS server folders from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "CIFS server hostname or IP" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "version", - "required": false, - "description": "CIFS version" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "path", - "required": false, - "description": "CIFS server share path" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "share", - "required": true, - "description": "Cifs share" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "username", - "required": true, - "description": "CIFS server username" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "password", - "required": true, - "description": "CIFS server password" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "domain", - "required": false, - "description": "CIFS server domain" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-nfs-exports": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the NFS server exports from a data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "NFS server hostname or IP" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "isEFS", - "required": false, - "description": "Indicates if the is target EFS" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-nfs-export-folders": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the NFS server folders from a data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "NFS server hostname or IP" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "exportName", - "required": true, - "description": "NFS server export" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "isEFS", - "required": false, - "description": "Indicates if the is target EFS" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "version", - "required": false, - "description": "NFS version supported versions 3, 4.0, 4.1, 4.2" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "accessPoint", - "required": false, - "description": "EFS access point" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "path", - "required": false, - "description": "NFS Export path" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-aws-kms-keys": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the AWS KMS keys from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-s3-buckets": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the S3 buckets accessible from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-s3-bucket-folders": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the S3 bucket folders from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Path inside the container, to list folders in" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-sgws-buckets": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the StorageGRID buckets accessible from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "Server hostname or IP" - }, - { - "schema": { - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "in": "query", - "name": "port", - "required": true, - "description": "Server port" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-sgws-bucket-folders": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the StorageGRID bucket folders from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "Server hostname or IP" - }, - { - "schema": { - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "in": "query", - "name": "port", - "required": false, - "description": "Server port" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Prefix" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-ontap-s3-buckets": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the ONTAP S3 buckets accessible from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "ONTAP S3 hostname or IP" - }, - { - "schema": { - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "in": "query", - "name": "port", - "required": false, - "description": "Server port" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-ontap-s3-bucket-folders": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the ONTAP S3 bucket folders from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "ONTAP S3 hostname or IP" - }, - { - "schema": { - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "in": "query", - "name": "port", - "required": false, - "description": "Server port" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Path inside the bucket, to list folders in" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-ibm-buckets": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the IBM buckets accessible from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "Server hostname or IP" - }, - { - "schema": { - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "in": "query", - "name": "port", - "required": true, - "description": "Server port" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-ibm-bucket-folders": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the IBM bucket folders from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "host", - "required": true, - "description": "Server hostname or IP" - }, - { - "schema": { - "maximum": 65535, - "minimum": 1, - "type": "number" - }, - "in": "query", - "name": "port", - "required": false, - "description": "Server port" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Prefix" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-alibaba-buckets": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the Alibaba buckets accessible from a data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-alibaba-bucket-folders": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the Alibaba bucket folders from a data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Path inside the container, to list folders in" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "access-key", - "required": true, - "description": "StorageGRID server access-key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "secret-key", - "required": true, - "description": "StorageGRID server secret-key" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-azure-blob-storage-containers": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the Azure blob storage containers.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "storageAccountName", - "required": true, - "description": "Azure storage account name" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "storage-account-connection-string", - "required": true, - "description": "Azure storage account connection-string" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-azure-blob-storage-container-folders": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the Azure blob storage container folders.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "storageAccountName", - "required": true, - "description": "Azure storage account name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "container", - "required": true, - "description": "Container" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Path inside the container, to list folders in" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "storage-account-connection-string", - "required": true, - "description": "Azure storage account connection-string" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-azure-dataLake-storage-containers": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the Azure Data Lake Gen2 storage containers.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "storageAccountName", - "required": true, - "description": "Azure storage account name" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "storage-account-connection-string", - "required": true, - "description": "Azure storage account connection-string" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-azure-dataLake-storage-container-folders": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the Azure Data Lake Gen2 storage container folders.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "storageAccountName", - "required": true, - "description": "Azure storage account name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "container", - "required": true, - "description": "Container" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "path", - "required": false, - "description": "Path inside the container, to list folders in" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "storage-account-connection-string", - "required": true, - "description": "Azure storage account connection-string" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-gcp-buckets": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the Google Cloud buckets accessible from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-gcp-bucket-folders": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the Google Cloud bucket folders from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "prefix", - "required": false, - "description": "Path inside the container, to list folders in" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-gcp-kms-keys": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the Google Cloud KMS keys accessible from a NetApp data broker.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "bucket", - "required": true, - "description": "Bucket" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-google-drives": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the Google drives objects.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "private-key", - "required": true, - "description": "Google Drive service account private key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "client-email", - "required": true, - "description": "Google Drive service account client email" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "subject", - "required": true, - "description": "Google Drive user email" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-google-drive-folders": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the Google Drive folders.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "driveId", - "required": true, - "description": "Google Drive ID" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "folderId", - "required": false, - "description": "Folder ID" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "folderName", - "required": false, - "description": "Path inside the container, to list folders in" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "private-key", - "required": true, - "description": "Google Drive service account private key" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "client-email", - "required": true, - "description": "Google Drive service account client email" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "subject", - "required": true, - "description": "Google Drive user email" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-box-root-folder": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the Box API root folder.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "clientId", - "required": true, - "description": "Box clientID" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "enterpriseId", - "required": true, - "description": "Box enterpriseID" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "appName", - "required": false, - "description": "Box appName" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "client-secret", - "required": true, - "description": "Box clientSecret" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "public-key-id", - "required": true, - "description": "Box publicKeyID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "private-key", - "required": true, - "description": "Box privateKey" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "passphrase", - "required": true, - "description": "Box passphrase" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-box-folders": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the Box API server folders from a NetApp data broker group.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "clientId", - "required": true, - "description": "Box clientID" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "enterpriseId", - "required": true, - "description": "Box enterpriseID" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "folderId", - "required": true, - "description": "BOX parent folder ID" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "folderName", - "required": false, - "description": "BOX parent folder name" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "appName", - "required": false, - "description": "Box appName" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "client-secret", - "required": true, - "description": "Box clientSecret" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "public-key-id", - "required": true, - "description": "Box publicKeyID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "private-key", - "required": true, - "description": "Box privateKey" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "passphrase", - "required": true, - "description": "Box passphrase" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}/list-s3-private-links": { - "get": { - "tags": [ - "Groups" - ], - "description": "Retrieves the S3 private links.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "region", - "required": true, - "description": "AWS region" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-bucket-name", - "required": false, - "description": " S3 bucket- for UI use" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/groups/{id}": { - "delete": { - "tags": [ - "Groups" - ], - "description": "Deletes a data broker group.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Data Brokers Group ID" - } - ], - "responses": { - "200": { - "description": "Default Response" - } - } - } - }, - "/api/relationships-v2": { - "get": { - "tags": [ - "Relationships" - ], - "description": "Retrieves all relationships.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Relationship ID" - }, - "isCM": { - "type": "string", - "description": "Was the relationship created through CloudManager" - }, - "dataBroker": { - "type": "string", - "description": "Data Broker ID" - }, - "relationshipId": { - "type": "string", - "description": "Relationship ID" - }, - "source": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "description": "Endpoint protocol", - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ] - }, - "cifs": { - "type": "object", - "description": "CIFS Details", - "properties": { - "host": { - "type": "string", - "description": "CIFS host" - }, - "share": { - "type": "string", - "description": "CIFS share" - }, - "provider": { - "type": "string", - "description": "CIFS type", - "enum": [ - "cifs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx" - ] - }, - "path": { - "type": "string", - "description": "CIFS path" - }, - "version": { - "type": "string", - "description": "Supported CIFS versions", - "enum": [ - "1.0", - "2.0", - "2.1", - "3.0", - "3.11" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "credentials": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - } - }, - "required": [ - "host", - "share", - "provider" - ] - }, - "nfs": { - "type": "object", - "description": "NFS Details", - "properties": { - "host": { - "type": "string", - "description": "NFS host" - }, - "export": { - "type": "string", - "description": "NFS export" - }, - "provider": { - "type": "string", - "description": "NFS type", - "enum": [ - "nfs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx", - "efs" - ] - }, - "path": { - "type": "string", - "description": "NFS path" - }, - "version": { - "type": "string", - "description": "Supported NFS versions", - "enum": [ - "3", - "4.0", - "4.1", - "4.2" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "accessPoint": { - "type": "string", - "description": "EFS access point" - } - }, - "required": [ - "host", - "export", - "provider" - ] - }, - "s3": { - "type": "object", - "description": "S3 details", - "properties": { - "host": { - "type": "string", - "description": "SGWS or IBM or ONTAP host" - }, - "port": { - "type": "integer", - "description": "SGWS or IBM or ONTAP port" - }, - "bucket": { - "type": "string", - "description": "Bucket" - }, - "prefix": { - "type": "string", - "description": "Prefix" - }, - "region": { - "type": "string", - "description": "Bucket region" - }, - "encryption": { - "type": "object", - "description": "S3 encryption", - "properties": { - "protocol": { - "type": "string", - "description": "Encryption type", - "enum": [ - "kms", - "aes256" - ], - "default": "aes256" - }, - "keyId": { - "type": "string", - "description": "Encryption key arn in case it is kms encryption" - } - } - }, - "privateLinkDns": { - "type": "string", - "description": "AWS S3 Private Link DNS" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "S3 Storage Class", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_IR", - "DEEP_ARCHIVE", - "IA" - ] - }, - "provider": { - "type": "string", - "description": "Object Storage Type", - "enum": [ - "s3", - "alibaba", - "sgws", - "ibm", - "ontap" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID - for storageGrid system" - }, - "glacier": { - "type": "object", - "description": "Glacier storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Expedited", - "enum": [ - "Expedited", - "Standard", - "Bulk" - ], - "description": "Glacier retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "deepArchive": { - "type": "object", - "description": "Deep Archive storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Standard", - "enum": [ - "Standard", - "Bulk" - ], - "description": "Deep Archive retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "local": { - "type": "object", - "description": "Local object details", - "properties": { - "path": { - "type": "string", - "description": "Local Path" - } - }, - "required": [ - "path" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Details", - "required": [ - "container", - "provider" - ], - "properties": { - "container": { - "type": "string", - "description": "Azure Blob Storage container name" - }, - "storageAccountName": { - "type": "string", - "description": "Azure Blob Storage account name" - }, - "prefix": { - "type": "string", - "description": "Container blob prefix" - }, - "path": { - "type": "string", - "description": "Container path, used in azure data lake storage" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "blobTier": { - "type": "string", - "enum": [ - "HOT", - "COOL", - "ARCHIVE", - "COLD" - ], - "default": "HOT", - "description": "Blob tier type" - }, - "provider": { - "type": "string", - "description": "Azure type", - "enum": [ - "azure", - "azure_data_lake" - ], - "default": "azure" - } - } - }, - "gcp": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "GCP Bucket" - }, - "prefix": { - "type": "string", - "description": "GCP Bucket prefix" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "GCP Storage Class", - "enum": [ - "STANDARD", - "NEARLINE", - "COLDLINE", - "ARCHIVE" - ], - "default": "STANDARD" - }, - "kmsKeyName": { - "type": "string", - "description": "GCP Kms name" - }, - "provider": { - "type": "string", - "description": "GCP Type", - "enum": [ - "gcp" - ], - "default": "gcp" - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "driveId": { - "type": "string", - "description": "Drive Id" - }, - "driveName": { - "type": "string", - "description": "Drive Name" - }, - "folderId": { - "type": "string", - "description": "Google Drive folderId" - }, - "path": { - "type": "string", - "description": "Folder path" - }, - "provider": { - "type": "string", - "description": "Google Drive Type", - "enum": [ - "gdrive" - ], - "default": "gdrive" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "subject": { - "type": "string", - "description": "subject - user email" - } - }, - "required": [ - "driveId", - "provider", - "subject" - ] - }, - "sftp": { - "type": "object", - "properties": { - "host": { - "type": "string", - "description": "SFTP host" - }, - "port": { - "type": "integer", - "description": "SFTP port number" - }, - "path": { - "type": "string", - "description": "Directory path" - }, - "rootDirectory": { - "type": "string", - "description": "Root Directory path" - }, - "provider": { - "type": "string", - "description": "SFTP Type", - "enum": [ - "sftp" - ], - "default": "sftp" - } - }, - "required": [ - "host", - "port", - "rootDirectory", - "provider" - ] - }, - "box": { - "type": "object", - "properties": { - "rootDirectory": { - "type": "string", - "description": "Root Directory" - }, - "path": { - "type": "string", - "description": "path" - }, - "folderId": { - "type": "string", - "description": "Folder ID" - }, - "clientId": { - "type": "string", - "description": "Client ID" - }, - "appName": { - "type": "string", - "description": "Box Application Name" - }, - "enterpriseId": { - "type": "string", - "description": "Enterprise Id" - }, - "provider": { - "type": "string", - "description": "Box Type", - "enum": [ - "box" - ], - "default": "box" - } - }, - "required": [ - "folderId", - "provider", - "clientId" - ] - } - } - }, - "target": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "description": "Endpoint protocol", - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ] - }, - "cifs": { - "type": "object", - "description": "CIFS Details", - "properties": { - "host": { - "type": "string", - "description": "CIFS host" - }, - "share": { - "type": "string", - "description": "CIFS share" - }, - "provider": { - "type": "string", - "description": "CIFS type", - "enum": [ - "cifs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx" - ] - }, - "path": { - "type": "string", - "description": "CIFS path" - }, - "version": { - "type": "string", - "description": "Supported CIFS versions", - "enum": [ - "1.0", - "2.0", - "2.1", - "3.0", - "3.11" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "credentials": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - } - }, - "required": [ - "host", - "share", - "provider" - ] - }, - "nfs": { - "type": "object", - "description": "NFS Details", - "properties": { - "host": { - "type": "string", - "description": "NFS host" - }, - "export": { - "type": "string", - "description": "NFS export" - }, - "provider": { - "type": "string", - "description": "NFS type", - "enum": [ - "nfs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx", - "efs" - ] - }, - "path": { - "type": "string", - "description": "NFS path" - }, - "version": { - "type": "string", - "description": "Supported NFS versions", - "enum": [ - "3", - "4.0", - "4.1", - "4.2" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "accessPoint": { - "type": "string", - "description": "EFS access point" - } - }, - "required": [ - "host", - "export", - "provider" - ] - }, - "s3": { - "type": "object", - "description": "S3 details", - "properties": { - "host": { - "type": "string", - "description": "SGWS or IBM or ONTAP host" - }, - "port": { - "type": "integer", - "description": "SGWS or IBM or ONTAP port" - }, - "bucket": { - "type": "string", - "description": "Bucket" - }, - "prefix": { - "type": "string", - "description": "Prefix" - }, - "region": { - "type": "string", - "description": "Bucket region" - }, - "encryption": { - "type": "object", - "description": "S3 encryption", - "properties": { - "protocol": { - "type": "string", - "description": "Encryption type", - "enum": [ - "kms", - "aes256" - ], - "default": "aes256" - }, - "keyId": { - "type": "string", - "description": "Encryption key arn in case it is kms encryption" - } - } - }, - "privateLinkDns": { - "type": "string", - "description": "AWS S3 Private Link DNS" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "S3 Storage Class", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_IR", - "DEEP_ARCHIVE", - "IA" - ] - }, - "provider": { - "type": "string", - "description": "Object Storage Type", - "enum": [ - "s3", - "alibaba", - "sgws", - "ibm", - "ontap" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID - for storageGrid system" - }, - "glacier": { - "type": "object", - "description": "Glacier storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Expedited", - "enum": [ - "Expedited", - "Standard", - "Bulk" - ], - "description": "Glacier retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "deepArchive": { - "type": "object", - "description": "Deep Archive storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Standard", - "enum": [ - "Standard", - "Bulk" - ], - "description": "Deep Archive retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "local": { - "type": "object", - "description": "Local object details", - "properties": { - "path": { - "type": "string", - "description": "Local Path" - } - }, - "required": [ - "path" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Details", - "required": [ - "container", - "provider" - ], - "properties": { - "container": { - "type": "string", - "description": "Azure Blob Storage container name" - }, - "storageAccountName": { - "type": "string", - "description": "Azure Blob Storage account name" - }, - "prefix": { - "type": "string", - "description": "Container blob prefix" - }, - "path": { - "type": "string", - "description": "Container path, used in azure data lake storage" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "blobTier": { - "type": "string", - "enum": [ - "HOT", - "COOL", - "ARCHIVE", - "COLD" - ], - "default": "HOT", - "description": "Blob tier type" - }, - "provider": { - "type": "string", - "description": "Azure type", - "enum": [ - "azure", - "azure_data_lake" - ], - "default": "azure" - } - } - }, - "gcp": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "GCP Bucket" - }, - "prefix": { - "type": "string", - "description": "GCP Bucket prefix" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "GCP Storage Class", - "enum": [ - "STANDARD", - "NEARLINE", - "COLDLINE", - "ARCHIVE" - ], - "default": "STANDARD" - }, - "kmsKeyName": { - "type": "string", - "description": "GCP Kms name" - }, - "provider": { - "type": "string", - "description": "GCP Type", - "enum": [ - "gcp" - ], - "default": "gcp" - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "driveId": { - "type": "string", - "description": "Drive Id" - }, - "driveName": { - "type": "string", - "description": "Drive Name" - }, - "folderId": { - "type": "string", - "description": "Google Drive folderId" - }, - "path": { - "type": "string", - "description": "Folder path" - }, - "provider": { - "type": "string", - "description": "Google Drive Type", - "enum": [ - "gdrive" - ], - "default": "gdrive" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "subject": { - "type": "string", - "description": "subject - user email" - } - }, - "required": [ - "driveId", - "provider", - "subject" - ] - }, - "sftp": { - "type": "object", - "properties": { - "host": { - "type": "string", - "description": "SFTP host" - }, - "port": { - "type": "integer", - "description": "SFTP port number" - }, - "path": { - "type": "string", - "description": "Directory path" - }, - "rootDirectory": { - "type": "string", - "description": "Root Directory path" - }, - "provider": { - "type": "string", - "description": "SFTP Type", - "enum": [ - "sftp" - ], - "default": "sftp" - } - }, - "required": [ - "host", - "port", - "rootDirectory", - "provider" - ] - }, - "box": { - "type": "object", - "properties": { - "rootDirectory": { - "type": "string", - "description": "Root Directory" - }, - "path": { - "type": "string", - "description": "path" - }, - "folderId": { - "type": "string", - "description": "Folder ID" - }, - "clientId": { - "type": "string", - "description": "Client ID" - }, - "appName": { - "type": "string", - "description": "Box Application Name" - }, - "enterpriseId": { - "type": "string", - "description": "Enterprise Id" - }, - "provider": { - "type": "string", - "description": "Box Type", - "enum": [ - "box" - ], - "default": "box" - } - }, - "required": [ - "folderId", - "provider", - "clientId" - ] - } - } - }, - "encryption": { - "type": "object", - "properties": { - "initiator": { - "description": "Initiator details", - "type": "object", - "properties": { - "dataBrokerId": { - "type": "string", - "description": "Data Broker Id" - }, - "groupId": { - "type": "string", - "description": "Group Id" - }, - "encryptionType": { - "type": "string", - "description": "Data Broker network location - if initiator is src, listener must be trg", - "enum": [ - "src", - "trg" - ] - } - }, - "required": [ - "endpointType" - ] - }, - "listener": { - "description": "Listener details", - "type": "object", - "properties": { - "dataBrokerId": { - "type": "string", - "description": "Data Broker Id" - }, - "groupId": { - "type": "string", - "description": "Group Id" - }, - "encryptionType": { - "type": "string", - "description": "Data Broker network location - if initiator is src, listener must be trg", - "enum": [ - "src", - "trg" - ] - } - }, - "required": [ - "endpointType" - ] - } - } - }, - "group": { - "type": "string", - "description": "Group ID" - }, - "settings": { - "properties": { - "gracePeriod": { - "type": "number", - "description": "Grace period time ( seconds )" - }, - "deleteOnSource": { - "type": "boolean", - "description": "Enable delete on source" - }, - "deleteOnTarget": { - "type": "boolean", - "description": "Enable delete on target" - }, - "objectTagging": { - "type": "boolean", - "description": "Use S3 tagging to store object metadata" - }, - "retries": { - "type": "integer", - "description": "Number of retries" - }, - "copyAcl": { - "type": "boolean", - "description": "Enable ACL copy" - }, - "copyData": { - "type": "boolean", - "description": "Copy data only" - }, - "continuousSync": { - "type": "boolean", - "description": "Listen to object notifications" - }, - "fileTypes": { - "type": "object", - "description": "The file types that is included in the relationship", - "properties": { - "files": { - "type": "boolean", - "description": "Include files" - }, - "directories": { - "type": "boolean", - "description": "Include directories" - }, - "symlinks": { - "type": "boolean", - "description": "Include symbolic links" - }, - "hardlinks": { - "type": "boolean", - "description": "include hard links" - } - } - }, - "compareBy": { - "type": "object", - "description": "The file attributes that should be compared", - "properties": { - "uid": { - "type": "boolean", - "description": "uid ( relevant when source or target is file system )" - }, - "gid": { - "type": "boolean", - "description": "gid ( relevant when source or target is file system )" - }, - "mtime": { - "type": "boolean", - "description": "mtime" - }, - "mode": { - "type": "boolean", - "description": "mode" - } - } - }, - "copyProperties": { - "type": "object", - "description": "The object properties that should be copied", - "properties": { - "metadata": { - "type": "boolean", - "description": "copy metadata ( cloud to cloud )" - }, - "tags": { - "type": "boolean", - "description": "copy tags ( cloud to cloud only S3 compatible )" - } - } - }, - "files": { - "type": "object", - "description": "Settings related to files.", - "properties": { - "excludeExtensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded extensions array (For example - [\".log\", \".tar.gz\"])" - }, - "excludeByRegex": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded files by regex (For example - \"\\.txt\\.\" will exclude the files file.doc.txt.gz)" - }, - "minSize": { - "type": "integer", - "description": "Minimum file size (in bytes). Only files of equal or larger size will be transferred by the relationship" - }, - "maxSize": { - "type": "integer", - "description": "Maximum file size (in bytes). Only files of equal or smaller size will be transferred by the relationship" - }, - "minDate": { - "type": "string", - "description": "Data broker will sync files that were last modified after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'" - }, - "maxDate": { - "type": [ - "null", - "string" - ], - "description": "Data broker will sync files that were last modified before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date" - }, - "minCreationDate": { - "type": "string", - "description": "Data broker will sync files that were created after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'" - }, - "maxCreationDate": { - "type": [ - "null", - "string" - ], - "description": "Data broker will sync files that were created before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date" - } - } - }, - "directories": { - "type": "object", - "description": "Settings related to directories.", - "properties": { - "excludeNames": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded directories names array (For example - [\"dir1\"])" - }, - "excludeByRegex": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded directories names by regex (For example - \"\\.*tmp.*\\.\" will exclude the directories with names that include tmp )" - } - } - }, - "schedule": { - "type": "object", - "description": "Sync schedule settings.", - "properties": { - "syncInDays": { - "type": "integer", - "description": "Days interval for sync scheduler" - }, - "syncInHours": { - "type": "integer", - "description": "" - }, - "syncInMinutes": { - "type": "integer", - "description": "" - }, - "isEnabled": { - "type": "boolean", - "description": "Activate automatic scheduler" - }, - "nextTime": { - "type": "string", - "description": "The first time the relationship should run" - }, - "syncWhenCreated": { - "type": "boolean", - "default": true, - "description": "Start the sync upon creation" - } - } - }, - "notifications": { - "type": "object", - "description": "Notifications settings.", - "properties": { - "cm": { - "type": "object", - "description": "NetApp Console notifications", - "properties": { - "done": { - "type": "boolean", - "description": "Should send notification about DONE status" - }, - "failed": { - "type": "boolean", - "description": "Should send notification about FAILED status" - }, - "aborted": { - "type": "boolean", - "description": "Should send notification about ABORTED status" - }, - "running_continuously": { - "type": "boolean", - "description": "Should send notification about RUNNING_CONTINUOUSLY status" - } - } - } - } - }, - "scheduleAbort": { - "type": "object", - "description": "Schedule abort settings.", - "properties": { - "abortInDays": { - "type": "integer", - "description": "Days interval for abort scheduler" - }, - "abortInHours": { - "type": "integer", - "description": "Hours interval for abort scheduler" - }, - "abortInMinutes": { - "type": "integer", - "description": "Minutes interval for abort scheduler" - }, - "isEnabled": { - "type": "boolean", - "description": "Activate automatic scheduler abort" - } - } - } - }, - "required": [ - "copyData", - "gracePeriod", - "deleteOnSource", - "deleteOnTarget", - "objectTagging", - "retries", - "fileTypes", - "compareBy", - "files", - "directories", - "schedule", - "scheduleAbort" - ], - "type": "object" - }, - "activity": { - "type": "object", - "additionalProperties": true, - "properties": { - "syncType": { - "type": "string", - "description": "field for UI - to indicate if we copy only acl or copy also data" - }, - "status": { - "type": "string", - "description": "Relationship status", - "enum": [ - "RUNNING", - "DONE", - "FAILED", - "ABORTED", - "PENDING" - ] - }, - "type": { - "type": "string", - "description": "Relationship phase - Initial copy or sync" - }, - "bytesMarkedForCopy": { - "type": "number", - "description": "Bytes marked for copy" - }, - "filesMarkedForCopy": { - "type": "number", - "description": "Files marked for copy" - }, - "dirsMarkedForCopy": { - "type": "number", - "description": "Directories marked for copy" - }, - "filesCopied": { - "type": "number", - "description": "Files copied" - }, - "bytesCopied": { - "type": "number", - "description": "Bytes copied" - }, - "dirsCopied": { - "type": "number", - "description": "Directories copied" - }, - "filesFailed": { - "type": "number", - "description": "files failed to copy" - }, - "bytesFailed": { - "type": "number", - "description": "Bytes failed to copy" - }, - "dirsFailed": { - "type": "number", - "description": "Directories failed to copy" - }, - "filesMarkedForRemove": { - "type": "number", - "description": "Files marked for remove" - }, - "bytesMarkedForRemove": { - "type": "number", - "description": "Byes marked for remove" - }, - "dirsMarkedForRemove": { - "type": "number", - "description": "Directories marked for remove" - }, - "filesRemoved": { - "type": "number", - "description": "Files removed" - }, - "bytesRemoved": { - "type": "number", - "description": "Bytes removed" - }, - "dirsRemoved": { - "type": "number", - "description": "Directories removed" - }, - "bytesRemovedFailed": { - "type": "number", - "description": "Bytes failed to remove" - }, - "filesRemovedFailed": { - "type": "number", - "description": "Filed failed to remove" - }, - "filesMarkedForIgnore": { - "type": "number", - "description": "Files marked for ignore" - }, - "dirsScanned": { - "type": "number", - "description": "Directories scanned" - }, - "filesScanned": { - "type": "number", - "description": "Files scanned" - }, - "bytesScanned": { - "type": "number", - "description": "Bytes scanned" - }, - "dirsFailedToScan": { - "type": "number", - "description": "Directories failed to scan" - }, - "timeEstimation": { - "type": "number", - "description": "Time estimation until the end of the sync" - }, - "progress": { - "type": "number", - "description": "Relationship progress" - }, - "endTime": { - "type": "string", - "description": "End time" - }, - "startTime": { - "type": "string", - "description": "Start time" - }, - "executionTime": { - "type": "number", - "description": "Execution time" - }, - "failureMessage": { - "type": "string", - "description": "Failure message" - }, - "lastMessageTime": { - "type": "string", - "description": "Last message time" - }, - "topFiveMostCommonRelationshipErrors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "step": { - "type": "string", - "description": "Sync step that failed - TRANSFER or SCAN" - }, - "errorCode": { - "type": "string", - "description": "Error code" - }, - "counter": { - "type": "number", - "description": "Number of errors" - }, - "description": { - "type": "string", - "description": "Error description" - } - } - } - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "dataBrokerId": { - "type": "string", - "description": "Data Broker with initialized error" - }, - "reason": { - "type": "string", - "description": "Error" - } - } - } - } - } - }, - "createdAt": { - "type": "number", - "description": "Relationship Creation time" - }, - "customHeaders": { - "type": "object", - "description": "Custom headers for the relationship", - "properties": { - "x-netapp-external-request-id-src": { - "type": "string", - "description": "Source request ID header" - }, - "x-netapp-external-request-id-trg": { - "type": "string", - "description": "Target request ID header" - }, - "x-source-edge": { - "type": "string", - "description": "Edge cluster UUID" - }, - "x-target-edge": { - "type": "string", - "description": "Edge cluster UUID" - }, - "x-sync-source": { - "type": "string", - "description": "Is source Edge" - }, - "x-sync-target": { - "type": "string", - "description": "is target Edge" - } - } - }, - "extraInformation": { - "type": "object", - "properties": { - "dataSenseQueryUid": { - "type": "string", - "description": "Data sense query uid" - }, - "connectorId": { - "type": "string", - "description": "Console agent ID ( for data sense query )" - } - } - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - } - }, - "required": [ - "id", - "source", - "target", - "createdAt" - ] - } - } - } - } - } - } - }, - "post": { - "tags": [ - "Relationships" - ], - "description": "Creates a new relationship.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "dataBrokerId": { - "type": "string", - "deprecated": true, - "description": "Data Broker ID - this is deprecated - use `groupId` instead" - }, - "groupId": { - "type": "string", - "description": "Data broker group ID" - }, - "source": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "description": "Endpoint protocol", - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ] - }, - "cifs": { - "type": "object", - "description": "CIFS Details", - "properties": { - "host": { - "type": "string", - "description": "CIFS host" - }, - "share": { - "type": "string", - "description": "CIFS share" - }, - "provider": { - "type": "string", - "description": "CIFS type", - "enum": [ - "cifs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx" - ] - }, - "path": { - "type": "string", - "description": "CIFS path" - }, - "version": { - "type": "string", - "description": "Supported CIFS versions", - "enum": [ - "1.0", - "2.0", - "2.1", - "3.0", - "3.11" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "credentials": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - } - }, - "required": [ - "host", - "share", - "provider" - ] - }, - "nfs": { - "type": "object", - "description": "NFS Details", - "properties": { - "host": { - "type": "string", - "description": "NFS host" - }, - "export": { - "type": "string", - "description": "NFS export" - }, - "provider": { - "type": "string", - "description": "NFS type", - "enum": [ - "nfs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx", - "efs" - ] - }, - "path": { - "type": "string", - "description": "NFS path" - }, - "version": { - "type": "string", - "description": "Supported NFS versions", - "enum": [ - "3", - "4.0", - "4.1", - "4.2" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "accessPoint": { - "type": "string", - "description": "EFS access point" - } - }, - "required": [ - "host", - "export", - "provider" - ] - }, - "s3": { - "type": "object", - "description": "S3 details", - "properties": { - "host": { - "type": "string", - "description": "SGWS or IBM or ONTAP host" - }, - "port": { - "type": "integer", - "description": "SGWS or IBM or ONTAP port" - }, - "bucket": { - "type": "string", - "description": "Bucket" - }, - "prefix": { - "type": "string", - "description": "Prefix" - }, - "region": { - "type": "string", - "description": "Bucket region" - }, - "encryption": { - "type": "object", - "description": "S3 encryption", - "properties": { - "protocol": { - "type": "string", - "description": "Encryption type", - "enum": [ - "kms", - "aes256" - ], - "default": "aes256" - }, - "keyId": { - "type": "string", - "description": "Encryption key arn in case it is kms encryption" - } - } - }, - "privateLinkDns": { - "type": "string", - "description": "AWS S3 Private Link DNS" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "S3 Storage Class", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_IR", - "DEEP_ARCHIVE", - "IA" - ] - }, - "provider": { - "type": "string", - "description": "Object Storage Type", - "enum": [ - "s3", - "alibaba", - "sgws", - "ibm", - "ontap" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID - for storageGrid system" - }, - "glacier": { - "type": "object", - "description": "Glacier storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Expedited", - "enum": [ - "Expedited", - "Standard", - "Bulk" - ], - "description": "Glacier retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "deepArchive": { - "type": "object", - "description": "Deep Archive storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Standard", - "enum": [ - "Standard", - "Bulk" - ], - "description": "Deep Archive retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "credentials": { - "type": "object", - "description": "S3 provider credentials", - "properties": { - "accessKey": { - "type": "string", - "description": "Access Key" - }, - "secretKey": { - "type": "string", - "description": "Secret Key" - } - }, - "required": [ - "accessKey", - "secretKey" - ] - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "local": { - "type": "object", - "description": "Local object details", - "properties": { - "path": { - "type": "string", - "description": "Local Path" - } - }, - "required": [ - "path" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Details", - "required": [ - "container", - "provider" - ], - "properties": { - "container": { - "type": "string", - "description": "Azure Blob Storage container name" - }, - "storageAccountName": { - "type": "string", - "description": "Azure Blob Storage account name" - }, - "prefix": { - "type": "string", - "description": "Container blob prefix" - }, - "path": { - "type": "string", - "description": "Container path, used in azure data lake storage" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "blobTier": { - "type": "string", - "enum": [ - "HOT", - "COOL", - "ARCHIVE", - "COLD" - ], - "default": "HOT", - "description": "Blob tier type" - }, - "provider": { - "type": "string", - "description": "Azure type", - "enum": [ - "azure", - "azure_data_lake" - ], - "default": "azure" - }, - "credentials": { - "type": "object", - "description": "Azure Blob Storage Credentials", - "properties": { - "storageAccountConnectionString": { - "type": "string", - "description": "Azure Blob Storage account Connection string ( for blob to blob copy should be SaS-Connection-String)" - } - } - } - } - }, - "gcp": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "GCP Bucket" - }, - "prefix": { - "type": "string", - "description": "GCP Bucket prefix" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "GCP Storage Class", - "enum": [ - "STANDARD", - "NEARLINE", - "COLDLINE", - "ARCHIVE" - ], - "default": "STANDARD" - }, - "kmsKeyName": { - "type": "string", - "description": "GCP Kms name" - }, - "provider": { - "type": "string", - "description": "GCP Type", - "enum": [ - "gcp" - ], - "default": "gcp" - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "sftp": { - "type": "object", - "properties": { - "host": { - "type": "string", - "description": "SFTP host" - }, - "port": { - "type": "integer", - "description": "SFTP port number" - }, - "path": { - "type": "string", - "description": "Directory path" - }, - "rootDirectory": { - "type": "string", - "description": "Root Directory path" - }, - "provider": { - "type": "string", - "description": "SFTP Type", - "enum": [ - "sftp" - ], - "default": "sftp" - }, - "credentials": { - "type": "object", - "properties": { - "username": { - "type": "string", - "description": "UserName" - }, - "password": { - "type": "string", - "description": "Password" - } - } - } - }, - "required": [ - "host", - "port", - "rootDirectory", - "provider", - "credentials" - ] - }, - "box": { - "type": "object", - "properties": { - "rootDirectory": { - "type": "string", - "description": "Root Directory" - }, - "path": { - "type": "string", - "description": "path" - }, - "folderId": { - "type": "string", - "description": "Folder ID" - }, - "clientId": { - "type": "string", - "description": "Client ID" - }, - "appName": { - "type": "string", - "description": "Box Application Name" - }, - "enterpriseId": { - "type": "string", - "description": "Enterprise Id" - }, - "provider": { - "type": "string", - "description": "Box Type", - "enum": [ - "box" - ], - "default": "box" - }, - "credentials": { - "type": "object", - "properties": { - "clientSecret": { - "type": "string", - "description": "Client secret" - }, - "publicKeyId": { - "type": "string", - "description": "Public Key Id" - }, - "privateKey": { - "type": "string", - "description": "Private Key" - }, - "passphrase": { - "type": "string", - "description": "Passphrase" - } - }, - "required": [ - "clientSecret", - "publicKeyId", - "privateKey", - "passphrase" - ] - } - }, - "required": [ - "folderId", - "provider", - "clientId", - "credentials", - "enterpriseId" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "driveId": { - "type": "string", - "description": "Drive Id" - }, - "driveName": { - "type": "string", - "description": "Drive Name" - }, - "folderId": { - "type": "string", - "description": "Google Drive folderId - Relevant in case of Download" - }, - "path": { - "type": "string", - "description": "Folder path - full path ( not including driveId )" - }, - "provider": { - "type": "string", - "description": "Google Drive Type", - "enum": [ - "gdrive" - ], - "default": "gdrive" - }, - "subject": { - "type": "string", - "description": "subject - user email" - }, - "credentials": { - "type": "object", - "properties": { - "clientEmail": { - "type": "string", - "description": "Service Account email" - }, - "privateKey": { - "type": "string", - "description": "Private Key" - } - }, - "required": [ - "clientEmail", - "privateKey" - ] - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - } - }, - "required": [ - "driveId", - "provider", - "credentials", - "subject" - ] - } - } - }, - "sourceCredentials": { - "type": "object", - "properties": { - "sftp": { - "type": "object", - "properties": { - "username": { - "type": "string", - "description": "UserName" - }, - "password": { - "type": "string", - "description": "Password" - } - } - }, - "cifs": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - }, - "s3": { - "type": "object", - "description": "S3 provider credentials", - "properties": { - "accessKey": { - "type": "string", - "description": "Access Key" - }, - "secretKey": { - "type": "string", - "description": "Secret Key" - } - }, - "required": [ - "accessKey", - "secretKey" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Credentials", - "properties": { - "storageAccountConnectionString": { - "type": "string", - "description": "Azure Blob Storage account Connection string ( for blob to blob copy should be SaS-Connection-String)" - } - } - }, - "box": { - "type": "object", - "properties": { - "clientSecret": { - "type": "string", - "description": "Client secret" - }, - "publicKeyId": { - "type": "string", - "description": "Public Key Id" - }, - "privateKey": { - "type": "string", - "description": "Private Key" - }, - "passphrase": { - "type": "string", - "description": "Passphrase" - } - }, - "required": [ - "clientSecret", - "publicKeyId", - "privateKey", - "passphrase" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "clientEmail": { - "type": "string", - "description": "Service Account email" - }, - "privateKey": { - "type": "string", - "description": "Private Key" - } - }, - "required": [ - "clientEmail", - "privateKey" - ] - } - } - }, - "target": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "description": "Endpoint protocol", - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ] - }, - "cifs": { - "type": "object", - "description": "CIFS Details", - "properties": { - "host": { - "type": "string", - "description": "CIFS host" - }, - "share": { - "type": "string", - "description": "CIFS share" - }, - "provider": { - "type": "string", - "description": "CIFS type", - "enum": [ - "cifs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx" - ] - }, - "path": { - "type": "string", - "description": "CIFS path" - }, - "version": { - "type": "string", - "description": "Supported CIFS versions", - "enum": [ - "1.0", - "2.0", - "2.1", - "3.0", - "3.11" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "credentials": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - } - }, - "required": [ - "host", - "share", - "provider" - ] - }, - "nfs": { - "type": "object", - "description": "NFS Details", - "properties": { - "host": { - "type": "string", - "description": "NFS host" - }, - "export": { - "type": "string", - "description": "NFS export" - }, - "provider": { - "type": "string", - "description": "NFS type", - "enum": [ - "nfs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx", - "efs" - ] - }, - "path": { - "type": "string", - "description": "NFS path" - }, - "version": { - "type": "string", - "description": "Supported NFS versions", - "enum": [ - "3", - "4.0", - "4.1", - "4.2" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "accessPoint": { - "type": "string", - "description": "EFS access point" - } - }, - "required": [ - "host", - "export", - "provider" - ] - }, - "s3": { - "type": "object", - "description": "S3 details", - "properties": { - "host": { - "type": "string", - "description": "SGWS or IBM or ONTAP host" - }, - "port": { - "type": "integer", - "description": "SGWS or IBM or ONTAP port" - }, - "bucket": { - "type": "string", - "description": "Bucket" - }, - "prefix": { - "type": "string", - "description": "Prefix" - }, - "region": { - "type": "string", - "description": "Bucket region" - }, - "encryption": { - "type": "object", - "description": "S3 encryption", - "properties": { - "protocol": { - "type": "string", - "description": "Encryption type", - "enum": [ - "kms", - "aes256" - ], - "default": "aes256" - }, - "keyId": { - "type": "string", - "description": "Encryption key arn in case it is kms encryption" - } - } - }, - "privateLinkDns": { - "type": "string", - "description": "AWS S3 Private Link DNS" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "S3 Storage Class", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_IR", - "DEEP_ARCHIVE", - "IA" - ] - }, - "provider": { - "type": "string", - "description": "Object Storage Type", - "enum": [ - "s3", - "alibaba", - "sgws", - "ibm", - "ontap" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID - for storageGrid system" - }, - "glacier": { - "type": "object", - "description": "Glacier storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Expedited", - "enum": [ - "Expedited", - "Standard", - "Bulk" - ], - "description": "Glacier retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "deepArchive": { - "type": "object", - "description": "Deep Archive storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Standard", - "enum": [ - "Standard", - "Bulk" - ], - "description": "Deep Archive retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "credentials": { - "type": "object", - "description": "S3 provider credentials", - "properties": { - "accessKey": { - "type": "string", - "description": "Access Key" - }, - "secretKey": { - "type": "string", - "description": "Secret Key" - } - }, - "required": [ - "accessKey", - "secretKey" - ] - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "local": { - "type": "object", - "description": "Local object details", - "properties": { - "path": { - "type": "string", - "description": "Local Path" - } - }, - "required": [ - "path" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Details", - "required": [ - "container", - "provider" - ], - "properties": { - "container": { - "type": "string", - "description": "Azure Blob Storage container name" - }, - "storageAccountName": { - "type": "string", - "description": "Azure Blob Storage account name" - }, - "prefix": { - "type": "string", - "description": "Container blob prefix" - }, - "path": { - "type": "string", - "description": "Container path, used in azure data lake storage" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "blobTier": { - "type": "string", - "enum": [ - "HOT", - "COOL", - "ARCHIVE", - "COLD" - ], - "default": "HOT", - "description": "Blob tier type" - }, - "provider": { - "type": "string", - "description": "Azure type", - "enum": [ - "azure", - "azure_data_lake" - ], - "default": "azure" - }, - "credentials": { - "type": "object", - "description": "Azure Blob Storage Credentials", - "properties": { - "storageAccountConnectionString": { - "type": "string", - "description": "Azure Blob Storage account Connection string ( for blob to blob copy should be SaS-Connection-String)" - } - } - } - } - }, - "gcp": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "GCP Bucket" - }, - "prefix": { - "type": "string", - "description": "GCP Bucket prefix" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "GCP Storage Class", - "enum": [ - "STANDARD", - "NEARLINE", - "COLDLINE", - "ARCHIVE" - ], - "default": "STANDARD" - }, - "kmsKeyName": { - "type": "string", - "description": "GCP Kms name" - }, - "provider": { - "type": "string", - "description": "GCP Type", - "enum": [ - "gcp" - ], - "default": "gcp" - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "sftp": { - "type": "object", - "properties": { - "host": { - "type": "string", - "description": "SFTP host" - }, - "port": { - "type": "integer", - "description": "SFTP port number" - }, - "path": { - "type": "string", - "description": "Directory path" - }, - "rootDirectory": { - "type": "string", - "description": "Root Directory path" - }, - "provider": { - "type": "string", - "description": "SFTP Type", - "enum": [ - "sftp" - ], - "default": "sftp" - }, - "credentials": { - "type": "object", - "properties": { - "username": { - "type": "string", - "description": "UserName" - }, - "password": { - "type": "string", - "description": "Password" - } - } - } - }, - "required": [ - "host", - "port", - "rootDirectory", - "provider", - "credentials" - ] - }, - "box": { - "type": "object", - "properties": { - "rootDirectory": { - "type": "string", - "description": "Root Directory" - }, - "path": { - "type": "string", - "description": "path" - }, - "folderId": { - "type": "string", - "description": "Folder ID" - }, - "clientId": { - "type": "string", - "description": "Client ID" - }, - "appName": { - "type": "string", - "description": "Box Application Name" - }, - "enterpriseId": { - "type": "string", - "description": "Enterprise Id" - }, - "provider": { - "type": "string", - "description": "Box Type", - "enum": [ - "box" - ], - "default": "box" - }, - "credentials": { - "type": "object", - "properties": { - "clientSecret": { - "type": "string", - "description": "Client secret" - }, - "publicKeyId": { - "type": "string", - "description": "Public Key Id" - }, - "privateKey": { - "type": "string", - "description": "Private Key" - }, - "passphrase": { - "type": "string", - "description": "Passphrase" - } - }, - "required": [ - "clientSecret", - "publicKeyId", - "privateKey", - "passphrase" - ] - } - }, - "required": [ - "folderId", - "provider", - "clientId", - "credentials", - "enterpriseId" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "driveId": { - "type": "string", - "description": "Drive Id" - }, - "driveName": { - "type": "string", - "description": "Drive Name" - }, - "folderId": { - "type": "string", - "description": "Google Drive folderId - Relevant in case of Download" - }, - "path": { - "type": "string", - "description": "Folder path - full path ( not including driveId )" - }, - "provider": { - "type": "string", - "description": "Google Drive Type", - "enum": [ - "gdrive" - ], - "default": "gdrive" - }, - "subject": { - "type": "string", - "description": "subject - user email" - }, - "credentials": { - "type": "object", - "properties": { - "clientEmail": { - "type": "string", - "description": "Service Account email" - }, - "privateKey": { - "type": "string", - "description": "Private Key" - } - }, - "required": [ - "clientEmail", - "privateKey" - ] - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - } - }, - "required": [ - "driveId", - "provider", - "credentials", - "subject" - ] - } - } - }, - "targetCredentials": { - "type": "object", - "properties": { - "sftp": { - "type": "object", - "properties": { - "username": { - "type": "string", - "description": "UserName" - }, - "password": { - "type": "string", - "description": "Password" - } - } - }, - "cifs": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - }, - "s3": { - "type": "object", - "description": "S3 provider credentials", - "properties": { - "accessKey": { - "type": "string", - "description": "Access Key" - }, - "secretKey": { - "type": "string", - "description": "Secret Key" - } - }, - "required": [ - "accessKey", - "secretKey" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Credentials", - "properties": { - "storageAccountConnectionString": { - "type": "string", - "description": "Azure Blob Storage account Connection string ( for blob to blob copy should be SaS-Connection-String)" - } - } - }, - "box": { - "type": "object", - "properties": { - "clientSecret": { - "type": "string", - "description": "Client secret" - }, - "publicKeyId": { - "type": "string", - "description": "Public Key Id" - }, - "privateKey": { - "type": "string", - "description": "Private Key" - }, - "passphrase": { - "type": "string", - "description": "Passphrase" - } - }, - "required": [ - "clientSecret", - "publicKeyId", - "privateKey", - "passphrase" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "clientEmail": { - "type": "string", - "description": "Service Account email" - }, - "privateKey": { - "type": "string", - "description": "Private Key" - } - }, - "required": [ - "clientEmail", - "privateKey" - ] - } - } - }, - "encryption": { - "type": "object", - "properties": { - "initiator": { - "description": "Initiator details", - "type": "object", - "properties": { - "dataBrokerId": { - "type": "string", - "description": "Data Broker Id" - }, - "groupId": { - "type": "string", - "description": "Group Id" - }, - "encryptionType": { - "type": "string", - "description": "Data Broker network location - if initiator is src, listener must be trg", - "enum": [ - "src", - "trg" - ] - } - }, - "required": [ - "endpointType" - ] - }, - "listener": { - "description": "Listener details", - "type": "object", - "properties": { - "dataBrokerId": { - "type": "string", - "description": "Data Broker Id" - }, - "groupId": { - "type": "string", - "description": "Group Id" - }, - "encryptionType": { - "type": "string", - "description": "Data Broker network location - if initiator is src, listener must be trg", - "enum": [ - "src", - "trg" - ] - } - }, - "required": [ - "endpointType" - ] - } - } - }, - "group": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Group Id" - }, - "name": { - "type": "string", - "description": "Group Name" - }, - "dataBrokers": { - "type": "array", - "description": "Data Brokers attached to the group", - "items": { - "type": "object", - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "description": "Data Broker ID", - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "AWS", - "GCP", - "ONPREM", - "AZURE" - ] - }, - "name": { - "type": "string", - "description": "Data Broker Name" - }, - "status": { - "type": "string", - "description": "'COMPLETE' for online data broker or 'FAILED' otherwise. Only available after the data broker has contacted the service for the first time" - }, - "message": { - "type": "string", - "description": "The error message in case the data broker is in 'FAILED' status" - }, - "fileLink": { - "type": "string", - "description": "The link to the Data Broker Cloud Formation template or installer" - }, - "transferRate": { - "type": "number", - "description": "The Data broker current transfer rate" - }, - "lastPing": { - "type": "integer", - "description": "The last time the Data Broker services did contact this service (EPOCH TIME)" - }, - "port": { - "type": "integer", - "description": "In case this is a NetApp 'listener' Data Broker, this is the port that data broker listens on" - }, - "latestVersion": { - "type": "string", - "description": "Latest Data Broker version available" - }, - "encryptionType": { - "type": "string", - "description": "Data Broker Encryption type - in case it is part of nfs encrypted relationship" - }, - "groupId": { - "type": "string", - "description": "Data Broker Group ID" - }, - "placement": { - "type": "object", - "description": "Data Broker placement information", - "properties": { - "instanceId": { - "type": "string", - "description": "Data Broker instance ID" - }, - "hostname": { - "type": "string", - "description": "Data Broker host name" - }, - "privateIp": { - "type": "string", - "description": "Data Broker private IP address" - }, - "region": { - "type": "string", - "description": "Data Broker AWS Region" - }, - "availabilityZone": { - "type": "string", - "description": "Data Broker AWS Subnet Availability Zone" - }, - "vpcId": { - "type": "string", - "description": "Data Broker AWS VPC ID" - }, - "vpcCidrBlock": { - "type": "string", - "description": "Data Broker AWS VPC CIDR block" - }, - "subnetId": { - "type": "string", - "description": "Data Broker AWS Subnet ID" - }, - "subnetCidrBlock": { - "type": "string", - "description": "Data Broker AWS Subnet CIDR block" - }, - "version": { - "type": "string", - "description": "Data Broker version" - }, - "awsAccountId": { - "type": "string", - "description": "AWS account ID in which the data broker was created" - }, - "vault": { - "type": "string", - "description": "Vault version" - }, - "node": { - "type": "string", - "description": "Node version" - }, - "canUpdateNodeVersion": { - "type": "boolean", - "description": "Indicates if advanced node version is compatible with this distribution" - }, - "cpu": { - "type": "string", - "description": "Data Broker number of cpus" - }, - "processMaxMem": { - "type": "string", - "description": "Data Broker Max Memory for process" - }, - "osTotalMem": { - "type": "string", - "description": "Data Broker Total memory" - }, - "release": { - "type": "string", - "description": "Data Broker image release" - }, - "os": { - "type": "string", - "description": "Data Broker OS" - }, - "distribution": { - "type": "string", - "description": "Data Broker distribution" - }, - "resourceGroupName": { - "type": "string", - "description": "Azure Data Broker resource group" - }, - "zone": { - "type": "string", - "description": "Azure Data Broker zone" - }, - "serviceAccount": { - "type": "string", - "description": "GCP Data Broker service account" - }, - "gcpProjectId": { - "type": "string", - "description": "GCP project ID" - }, - "scanner": { - "type": "object", - "properties": { - "processes": { - "type": "number", - "description": "Scanner processes number" - }, - "processesLimit": { - "type": "number", - "description": "Scanner processes limit number" - }, - "concurrency": { - "type": "number", - "description": "How many tasks in parallel each scanner process handles" - } - } - }, - "transferrer": { - "type": "object", - "properties": { - "processes": { - "type": "number", - "description": "Transferrer processes number" - }, - "processesLimit": { - "type": "number", - "description": "Scanner processes limit number" - }, - "concurrency": { - "type": "number", - "description": "How many tasks in parallel each transferrer process handles" - } - } - }, - "platform": { - "type": "string", - "description": "Data broker platform" - }, - "cpus": { - "type": "number", - "description": "Number of Cpus" - }, - "proxy": { - "type": "string", - "description": "Proxy string" - }, - "canUpdateProxy": { - "type": "boolean", - "description": "Allow to change proxy configuration" - } - } - } - } - } - }, - "createdAt": { - "type": "string", - "description": "Group creation time" - } - }, - "required": [ - "id", - "name", - "createdAt", - "dataBrokers" - ] - }, - "settings": { - "type": "object", - "properties": { - "gracePeriod": { - "type": "number", - "description": "Grace period time ( seconds )" - }, - "deleteOnSource": { - "type": "boolean", - "description": "Enable delete on source" - }, - "deleteOnTarget": { - "type": "boolean", - "description": "Enable delete on target" - }, - "objectTagging": { - "type": "boolean", - "description": "Use S3 tagging to store object metadata" - }, - "retries": { - "type": "integer", - "description": "Number of retries" - }, - "copyAcl": { - "type": "boolean", - "description": "Enable ACL copy" - }, - "copyData": { - "type": "boolean", - "description": "Copy data only" - }, - "continuousSync": { - "type": "boolean", - "description": "Listen to object notifications" - }, - "fileTypes": { - "type": "object", - "description": "The file types that is included in the relationship", - "properties": { - "files": { - "type": "boolean", - "description": "Include files" - }, - "directories": { - "type": "boolean", - "description": "Include directories" - }, - "symlinks": { - "type": "boolean", - "description": "Include symbolic links" - }, - "hardlinks": { - "type": "boolean", - "description": "include hard links" - } - } - }, - "compareBy": { - "type": "object", - "description": "The file attributes that should be compared", - "properties": { - "uid": { - "type": "boolean", - "description": "uid ( relevant when source or target is file system )" - }, - "gid": { - "type": "boolean", - "description": "gid ( relevant when source or target is file system )" - }, - "mtime": { - "type": "boolean", - "description": "mtime" - }, - "mode": { - "type": "boolean", - "description": "mode" - } - } - }, - "copyProperties": { - "type": "object", - "description": "The object properties that should be copied", - "properties": { - "metadata": { - "type": "boolean", - "description": "copy metadata ( cloud to cloud )" - }, - "tags": { - "type": "boolean", - "description": "copy tags ( cloud to cloud only S3 compatible )" - } - } - }, - "files": { - "type": "object", - "description": "Settings related to files.", - "properties": { - "excludeExtensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded extensions array (For example - [\".log\", \".tar.gz\"])" - }, - "excludeByRegex": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded files by regex (For example - \"\\.txt\\.\" will exclude the files file.doc.txt.gz)" - }, - "minSize": { - "type": "integer", - "description": "Minimum file size (in bytes). Only files of equal or larger size will be transferred by the relationship" - }, - "maxSize": { - "type": "integer", - "description": "Maximum file size (in bytes). Only files of equal or smaller size will be transferred by the relationship" - }, - "minDate": { - "type": "string", - "description": "Data broker will sync files that were last modified after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'" - }, - "maxDate": { - "type": [ - "null", - "string" - ], - "description": "Data broker will sync files that were last modified before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date" - }, - "minCreationDate": { - "type": "string", - "description": "Data broker will sync files that were created after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'" - }, - "maxCreationDate": { - "type": [ - "null", - "string" - ], - "description": "Data broker will sync files that were created before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date" - } - } - }, - "directories": { - "type": "object", - "description": "Settings related to directories.", - "properties": { - "excludeNames": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded directories names array (For example - [\"dir1\"])" - }, - "excludeByRegex": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded directories names by regex (For example - \"\\.*tmp.*\\.\" will exclude the directories with names that include tmp )" - } - } - }, - "schedule": { - "type": "object", - "description": "Sync schedule settings.", - "properties": { - "syncInDays": { - "type": "integer", - "description": "Days interval for sync scheduler" - }, - "syncInHours": { - "type": "integer", - "description": "" - }, - "syncInMinutes": { - "type": "integer", - "description": "" - }, - "isEnabled": { - "type": "boolean", - "description": "Activate automatic scheduler" - }, - "nextTime": { - "type": "string", - "description": "The first time the relationship should run" - }, - "syncWhenCreated": { - "type": "boolean", - "default": true, - "description": "Start the sync upon creation" - } - } - }, - "notifications": { - "type": "object", - "description": "Notifications settings.", - "properties": { - "cm": { - "type": "object", - "description": "NetApp Console notifications", - "properties": { - "done": { - "type": "boolean", - "description": "Should send notification about DONE status" - }, - "failed": { - "type": "boolean", - "description": "Should send notification about FAILED status" - }, - "aborted": { - "type": "boolean", - "description": "Should send notification about ABORTED status" - }, - "running_continuously": { - "type": "boolean", - "description": "Should send notification about RUNNING_CONTINUOUSLY status" - } - } - } - } - }, - "scheduleAbort": { - "type": "object", - "description": "Schedule abort settings.", - "properties": { - "abortInDays": { - "type": "integer", - "description": "Days interval for abort scheduler" - }, - "abortInHours": { - "type": "integer", - "description": "Hours interval for abort scheduler" - }, - "abortInMinutes": { - "type": "integer", - "description": "Minutes interval for abort scheduler" - }, - "isEnabled": { - "type": "boolean", - "description": "Activate automatic scheduler abort" - } - } - } - } - }, - "activity": { - "type": "object", - "additionalProperties": true, - "properties": { - "syncType": { - "type": "string", - "description": "field for UI - to indicate if we copy only acl or copy also data" - }, - "status": { - "type": "string", - "description": "Relationship status", - "enum": [ - "RUNNING", - "DONE", - "FAILED", - "ABORTED", - "PENDING" - ] - }, - "type": { - "type": "string", - "description": "Relationship phase - Initial copy or sync" - }, - "bytesMarkedForCopy": { - "type": "number", - "description": "Bytes marked for copy" - }, - "filesMarkedForCopy": { - "type": "number", - "description": "Files marked for copy" - }, - "dirsMarkedForCopy": { - "type": "number", - "description": "Directories marked for copy" - }, - "filesCopied": { - "type": "number", - "description": "Files copied" - }, - "bytesCopied": { - "type": "number", - "description": "Bytes copied" - }, - "dirsCopied": { - "type": "number", - "description": "Directories copied" - }, - "filesFailed": { - "type": "number", - "description": "files failed to copy" - }, - "bytesFailed": { - "type": "number", - "description": "Bytes failed to copy" - }, - "dirsFailed": { - "type": "number", - "description": "Directories failed to copy" - }, - "filesMarkedForRemove": { - "type": "number", - "description": "Files marked for remove" - }, - "bytesMarkedForRemove": { - "type": "number", - "description": "Byes marked for remove" - }, - "dirsMarkedForRemove": { - "type": "number", - "description": "Directories marked for remove" - }, - "filesRemoved": { - "type": "number", - "description": "Files removed" - }, - "bytesRemoved": { - "type": "number", - "description": "Bytes removed" - }, - "dirsRemoved": { - "type": "number", - "description": "Directories removed" - }, - "bytesRemovedFailed": { - "type": "number", - "description": "Bytes failed to remove" - }, - "filesRemovedFailed": { - "type": "number", - "description": "Filed failed to remove" - }, - "filesMarkedForIgnore": { - "type": "number", - "description": "Files marked for ignore" - }, - "dirsScanned": { - "type": "number", - "description": "Directories scanned" - }, - "filesScanned": { - "type": "number", - "description": "Files scanned" - }, - "bytesScanned": { - "type": "number", - "description": "Bytes scanned" - }, - "dirsFailedToScan": { - "type": "number", - "description": "Directories failed to scan" - }, - "timeEstimation": { - "type": "number", - "description": "Time estimation until the end of the sync" - }, - "progress": { - "type": "number", - "description": "Relationship progress" - }, - "endTime": { - "type": "string", - "description": "End time" - }, - "startTime": { - "type": "string", - "description": "Start time" - }, - "executionTime": { - "type": "number", - "description": "Execution time" - }, - "failureMessage": { - "type": "string", - "description": "Failure message" - }, - "lastMessageTime": { - "type": "string", - "description": "Last message time" - }, - "topFiveMostCommonRelationshipErrors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "step": { - "type": "string", - "description": "Sync step that failed - TRANSFER or SCAN" - }, - "errorCode": { - "type": "string", - "description": "Error code" - }, - "counter": { - "type": "number", - "description": "Number of errors" - }, - "description": { - "type": "string", - "description": "Error description" - } - } - } - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "dataBrokerId": { - "type": "string", - "description": "Data Broker with initialized error" - }, - "reason": { - "type": "string", - "description": "Error" - } - } - } - } - } - }, - "createdAt": { - "type": "number", - "description": "Relationship Creation time" - }, - "customHeaders": { - "type": "object", - "description": "Custom headers for the relationship", - "properties": { - "x-netapp-external-request-id-src": { - "type": "string", - "description": "Source request ID header" - }, - "x-netapp-external-request-id-trg": { - "type": "string", - "description": "Target request ID header" - }, - "x-source-edge": { - "type": "string", - "description": "Edge cluster UUID" - }, - "x-target-edge": { - "type": "string", - "description": "Edge cluster UUID" - }, - "x-sync-source": { - "type": "string", - "description": "Is source Edge" - }, - "x-sync-target": { - "type": "string", - "description": "is target Edge" - } - } - }, - "extraInformation": { - "type": "object", - "properties": { - "dataSenseQueryUid": { - "type": "string", - "description": "Data sense query uid" - }, - "connectorId": { - "type": "string", - "description": "Console agent ID ( for data sense query )" - } - } - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - } - }, - "required": [ - "source", - "target" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-netapp-external-request-id-src", - "required": false, - "description": "Source request ID header" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-netapp-external-request-id-trg", - "required": false, - "description": "Target request ID header" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-source-edge", - "required": false, - "description": "Edge cluster UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-target-edge", - "required": false, - "description": "Edge cluster UUID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-sync-source", - "required": false, - "description": "Is source Edge" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-sync-target", - "required": false, - "description": "is target Edge" - } - ], - "responses": { - "202": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Relationship ID" - }, - "isCM": { - "type": "string", - "description": "Was the relationship created through CloudManager" - }, - "dataBroker": { - "type": "string", - "description": "Data Broker ID" - }, - "relationshipId": { - "type": "string", - "description": "Relationship ID" - }, - "source": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "description": "Endpoint protocol", - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ] - }, - "cifs": { - "type": "object", - "description": "CIFS Details", - "properties": { - "host": { - "type": "string", - "description": "CIFS host" - }, - "share": { - "type": "string", - "description": "CIFS share" - }, - "provider": { - "type": "string", - "description": "CIFS type", - "enum": [ - "cifs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx" - ] - }, - "path": { - "type": "string", - "description": "CIFS path" - }, - "version": { - "type": "string", - "description": "Supported CIFS versions", - "enum": [ - "1.0", - "2.0", - "2.1", - "3.0", - "3.11" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "credentials": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - } - }, - "required": [ - "host", - "share", - "provider" - ] - }, - "nfs": { - "type": "object", - "description": "NFS Details", - "properties": { - "host": { - "type": "string", - "description": "NFS host" - }, - "export": { - "type": "string", - "description": "NFS export" - }, - "provider": { - "type": "string", - "description": "NFS type", - "enum": [ - "nfs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx", - "efs" - ] - }, - "path": { - "type": "string", - "description": "NFS path" - }, - "version": { - "type": "string", - "description": "Supported NFS versions", - "enum": [ - "3", - "4.0", - "4.1", - "4.2" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "accessPoint": { - "type": "string", - "description": "EFS access point" - } - }, - "required": [ - "host", - "export", - "provider" - ] - }, - "s3": { - "type": "object", - "description": "S3 details", - "properties": { - "host": { - "type": "string", - "description": "SGWS or IBM or ONTAP host" - }, - "port": { - "type": "integer", - "description": "SGWS or IBM or ONTAP port" - }, - "bucket": { - "type": "string", - "description": "Bucket" - }, - "prefix": { - "type": "string", - "description": "Prefix" - }, - "region": { - "type": "string", - "description": "Bucket region" - }, - "encryption": { - "type": "object", - "description": "S3 encryption", - "properties": { - "protocol": { - "type": "string", - "description": "Encryption type", - "enum": [ - "kms", - "aes256" - ], - "default": "aes256" - }, - "keyId": { - "type": "string", - "description": "Encryption key arn in case it is kms encryption" - } - } - }, - "privateLinkDns": { - "type": "string", - "description": "AWS S3 Private Link DNS" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "S3 Storage Class", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_IR", - "DEEP_ARCHIVE", - "IA" - ] - }, - "provider": { - "type": "string", - "description": "Object Storage Type", - "enum": [ - "s3", - "alibaba", - "sgws", - "ibm", - "ontap" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID - for storageGrid system" - }, - "glacier": { - "type": "object", - "description": "Glacier storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Expedited", - "enum": [ - "Expedited", - "Standard", - "Bulk" - ], - "description": "Glacier retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "deepArchive": { - "type": "object", - "description": "Deep Archive storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Standard", - "enum": [ - "Standard", - "Bulk" - ], - "description": "Deep Archive retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "local": { - "type": "object", - "description": "Local object details", - "properties": { - "path": { - "type": "string", - "description": "Local Path" - } - }, - "required": [ - "path" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Details", - "required": [ - "container", - "provider" - ], - "properties": { - "container": { - "type": "string", - "description": "Azure Blob Storage container name" - }, - "storageAccountName": { - "type": "string", - "description": "Azure Blob Storage account name" - }, - "prefix": { - "type": "string", - "description": "Container blob prefix" - }, - "path": { - "type": "string", - "description": "Container path, used in azure data lake storage" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "blobTier": { - "type": "string", - "enum": [ - "HOT", - "COOL", - "ARCHIVE", - "COLD" - ], - "default": "HOT", - "description": "Blob tier type" - }, - "provider": { - "type": "string", - "description": "Azure type", - "enum": [ - "azure", - "azure_data_lake" - ], - "default": "azure" - } - } - }, - "gcp": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "GCP Bucket" - }, - "prefix": { - "type": "string", - "description": "GCP Bucket prefix" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "GCP Storage Class", - "enum": [ - "STANDARD", - "NEARLINE", - "COLDLINE", - "ARCHIVE" - ], - "default": "STANDARD" - }, - "kmsKeyName": { - "type": "string", - "description": "GCP Kms name" - }, - "provider": { - "type": "string", - "description": "GCP Type", - "enum": [ - "gcp" - ], - "default": "gcp" - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "driveId": { - "type": "string", - "description": "Drive Id" - }, - "driveName": { - "type": "string", - "description": "Drive Name" - }, - "folderId": { - "type": "string", - "description": "Google Drive folderId" - }, - "path": { - "type": "string", - "description": "Folder path" - }, - "provider": { - "type": "string", - "description": "Google Drive Type", - "enum": [ - "gdrive" - ], - "default": "gdrive" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "subject": { - "type": "string", - "description": "subject - user email" - } - }, - "required": [ - "driveId", - "provider", - "subject" - ] - }, - "sftp": { - "type": "object", - "properties": { - "host": { - "type": "string", - "description": "SFTP host" - }, - "port": { - "type": "integer", - "description": "SFTP port number" - }, - "path": { - "type": "string", - "description": "Directory path" - }, - "rootDirectory": { - "type": "string", - "description": "Root Directory path" - }, - "provider": { - "type": "string", - "description": "SFTP Type", - "enum": [ - "sftp" - ], - "default": "sftp" - } - }, - "required": [ - "host", - "port", - "rootDirectory", - "provider" - ] - }, - "box": { - "type": "object", - "properties": { - "rootDirectory": { - "type": "string", - "description": "Root Directory" - }, - "path": { - "type": "string", - "description": "path" - }, - "folderId": { - "type": "string", - "description": "Folder ID" - }, - "clientId": { - "type": "string", - "description": "Client ID" - }, - "appName": { - "type": "string", - "description": "Box Application Name" - }, - "enterpriseId": { - "type": "string", - "description": "Enterprise Id" - }, - "provider": { - "type": "string", - "description": "Box Type", - "enum": [ - "box" - ], - "default": "box" - } - }, - "required": [ - "folderId", - "provider", - "clientId" - ] - } - } - }, - "target": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "description": "Endpoint protocol", - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ] - }, - "cifs": { - "type": "object", - "description": "CIFS Details", - "properties": { - "host": { - "type": "string", - "description": "CIFS host" - }, - "share": { - "type": "string", - "description": "CIFS share" - }, - "provider": { - "type": "string", - "description": "CIFS type", - "enum": [ - "cifs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx" - ] - }, - "path": { - "type": "string", - "description": "CIFS path" - }, - "version": { - "type": "string", - "description": "Supported CIFS versions", - "enum": [ - "1.0", - "2.0", - "2.1", - "3.0", - "3.11" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "credentials": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - } - }, - "required": [ - "host", - "share", - "provider" - ] - }, - "nfs": { - "type": "object", - "description": "NFS Details", - "properties": { - "host": { - "type": "string", - "description": "NFS host" - }, - "export": { - "type": "string", - "description": "NFS export" - }, - "provider": { - "type": "string", - "description": "NFS type", - "enum": [ - "nfs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx", - "efs" - ] - }, - "path": { - "type": "string", - "description": "NFS path" - }, - "version": { - "type": "string", - "description": "Supported NFS versions", - "enum": [ - "3", - "4.0", - "4.1", - "4.2" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "accessPoint": { - "type": "string", - "description": "EFS access point" - } - }, - "required": [ - "host", - "export", - "provider" - ] - }, - "s3": { - "type": "object", - "description": "S3 details", - "properties": { - "host": { - "type": "string", - "description": "SGWS or IBM or ONTAP host" - }, - "port": { - "type": "integer", - "description": "SGWS or IBM or ONTAP port" - }, - "bucket": { - "type": "string", - "description": "Bucket" - }, - "prefix": { - "type": "string", - "description": "Prefix" - }, - "region": { - "type": "string", - "description": "Bucket region" - }, - "encryption": { - "type": "object", - "description": "S3 encryption", - "properties": { - "protocol": { - "type": "string", - "description": "Encryption type", - "enum": [ - "kms", - "aes256" - ], - "default": "aes256" - }, - "keyId": { - "type": "string", - "description": "Encryption key arn in case it is kms encryption" - } - } - }, - "privateLinkDns": { - "type": "string", - "description": "AWS S3 Private Link DNS" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "S3 Storage Class", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_IR", - "DEEP_ARCHIVE", - "IA" - ] - }, - "provider": { - "type": "string", - "description": "Object Storage Type", - "enum": [ - "s3", - "alibaba", - "sgws", - "ibm", - "ontap" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID - for storageGrid system" - }, - "glacier": { - "type": "object", - "description": "Glacier storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Expedited", - "enum": [ - "Expedited", - "Standard", - "Bulk" - ], - "description": "Glacier retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "deepArchive": { - "type": "object", - "description": "Deep Archive storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Standard", - "enum": [ - "Standard", - "Bulk" - ], - "description": "Deep Archive retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "local": { - "type": "object", - "description": "Local object details", - "properties": { - "path": { - "type": "string", - "description": "Local Path" - } - }, - "required": [ - "path" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Details", - "required": [ - "container", - "provider" - ], - "properties": { - "container": { - "type": "string", - "description": "Azure Blob Storage container name" - }, - "storageAccountName": { - "type": "string", - "description": "Azure Blob Storage account name" - }, - "prefix": { - "type": "string", - "description": "Container blob prefix" - }, - "path": { - "type": "string", - "description": "Container path, used in azure data lake storage" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "blobTier": { - "type": "string", - "enum": [ - "HOT", - "COOL", - "ARCHIVE", - "COLD" - ], - "default": "HOT", - "description": "Blob tier type" - }, - "provider": { - "type": "string", - "description": "Azure type", - "enum": [ - "azure", - "azure_data_lake" - ], - "default": "azure" - } - } - }, - "gcp": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "GCP Bucket" - }, - "prefix": { - "type": "string", - "description": "GCP Bucket prefix" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "GCP Storage Class", - "enum": [ - "STANDARD", - "NEARLINE", - "COLDLINE", - "ARCHIVE" - ], - "default": "STANDARD" - }, - "kmsKeyName": { - "type": "string", - "description": "GCP Kms name" - }, - "provider": { - "type": "string", - "description": "GCP Type", - "enum": [ - "gcp" - ], - "default": "gcp" - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "driveId": { - "type": "string", - "description": "Drive Id" - }, - "driveName": { - "type": "string", - "description": "Drive Name" - }, - "folderId": { - "type": "string", - "description": "Google Drive folderId" - }, - "path": { - "type": "string", - "description": "Folder path" - }, - "provider": { - "type": "string", - "description": "Google Drive Type", - "enum": [ - "gdrive" - ], - "default": "gdrive" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "subject": { - "type": "string", - "description": "subject - user email" - } - }, - "required": [ - "driveId", - "provider", - "subject" - ] - }, - "sftp": { - "type": "object", - "properties": { - "host": { - "type": "string", - "description": "SFTP host" - }, - "port": { - "type": "integer", - "description": "SFTP port number" - }, - "path": { - "type": "string", - "description": "Directory path" - }, - "rootDirectory": { - "type": "string", - "description": "Root Directory path" - }, - "provider": { - "type": "string", - "description": "SFTP Type", - "enum": [ - "sftp" - ], - "default": "sftp" - } - }, - "required": [ - "host", - "port", - "rootDirectory", - "provider" - ] - }, - "box": { - "type": "object", - "properties": { - "rootDirectory": { - "type": "string", - "description": "Root Directory" - }, - "path": { - "type": "string", - "description": "path" - }, - "folderId": { - "type": "string", - "description": "Folder ID" - }, - "clientId": { - "type": "string", - "description": "Client ID" - }, - "appName": { - "type": "string", - "description": "Box Application Name" - }, - "enterpriseId": { - "type": "string", - "description": "Enterprise Id" - }, - "provider": { - "type": "string", - "description": "Box Type", - "enum": [ - "box" - ], - "default": "box" - } - }, - "required": [ - "folderId", - "provider", - "clientId" - ] - } - } - }, - "encryption": { - "type": "object", - "properties": { - "initiator": { - "description": "Initiator details", - "type": "object", - "properties": { - "dataBrokerId": { - "type": "string", - "description": "Data Broker Id" - }, - "groupId": { - "type": "string", - "description": "Group Id" - }, - "encryptionType": { - "type": "string", - "description": "Data Broker network location - if initiator is src, listener must be trg", - "enum": [ - "src", - "trg" - ] - } - }, - "required": [ - "endpointType" - ] - }, - "listener": { - "description": "Listener details", - "type": "object", - "properties": { - "dataBrokerId": { - "type": "string", - "description": "Data Broker Id" - }, - "groupId": { - "type": "string", - "description": "Group Id" - }, - "encryptionType": { - "type": "string", - "description": "Data Broker network location - if initiator is src, listener must be trg", - "enum": [ - "src", - "trg" - ] - } - }, - "required": [ - "endpointType" - ] - } - } - }, - "group": { - "type": "string", - "description": "Group ID" - }, - "settings": { - "properties": { - "gracePeriod": { - "type": "number", - "description": "Grace period time ( seconds )" - }, - "deleteOnSource": { - "type": "boolean", - "description": "Enable delete on source" - }, - "deleteOnTarget": { - "type": "boolean", - "description": "Enable delete on target" - }, - "objectTagging": { - "type": "boolean", - "description": "Use S3 tagging to store object metadata" - }, - "retries": { - "type": "integer", - "description": "Number of retries" - }, - "copyAcl": { - "type": "boolean", - "description": "Enable ACL copy" - }, - "copyData": { - "type": "boolean", - "description": "Copy data only" - }, - "continuousSync": { - "type": "boolean", - "description": "Listen to object notifications" - }, - "fileTypes": { - "type": "object", - "description": "The file types that is included in the relationship", - "properties": { - "files": { - "type": "boolean", - "description": "Include files" - }, - "directories": { - "type": "boolean", - "description": "Include directories" - }, - "symlinks": { - "type": "boolean", - "description": "Include symbolic links" - }, - "hardlinks": { - "type": "boolean", - "description": "include hard links" - } - } - }, - "compareBy": { - "type": "object", - "description": "The file attributes that should be compared", - "properties": { - "uid": { - "type": "boolean", - "description": "uid ( relevant when source or target is file system )" - }, - "gid": { - "type": "boolean", - "description": "gid ( relevant when source or target is file system )" - }, - "mtime": { - "type": "boolean", - "description": "mtime" - }, - "mode": { - "type": "boolean", - "description": "mode" - } - } - }, - "copyProperties": { - "type": "object", - "description": "The object properties that should be copied", - "properties": { - "metadata": { - "type": "boolean", - "description": "copy metadata ( cloud to cloud )" - }, - "tags": { - "type": "boolean", - "description": "copy tags ( cloud to cloud only S3 compatible )" - } - } - }, - "files": { - "type": "object", - "description": "Settings related to files.", - "properties": { - "excludeExtensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded extensions array (For example - [\".log\", \".tar.gz\"])" - }, - "excludeByRegex": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded files by regex (For example - \"\\.txt\\.\" will exclude the files file.doc.txt.gz)" - }, - "minSize": { - "type": "integer", - "description": "Minimum file size (in bytes). Only files of equal or larger size will be transferred by the relationship" - }, - "maxSize": { - "type": "integer", - "description": "Maximum file size (in bytes). Only files of equal or smaller size will be transferred by the relationship" - }, - "minDate": { - "type": "string", - "description": "Data broker will sync files that were last modified after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'" - }, - "maxDate": { - "type": [ - "null", - "string" - ], - "description": "Data broker will sync files that were last modified before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date" - }, - "minCreationDate": { - "type": "string", - "description": "Data broker will sync files that were created after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'" - }, - "maxCreationDate": { - "type": [ - "null", - "string" - ], - "description": "Data broker will sync files that were created before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date" - } - } - }, - "directories": { - "type": "object", - "description": "Settings related to directories.", - "properties": { - "excludeNames": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded directories names array (For example - [\"dir1\"])" - }, - "excludeByRegex": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded directories names by regex (For example - \"\\.*tmp.*\\.\" will exclude the directories with names that include tmp )" - } - } - }, - "schedule": { - "type": "object", - "description": "Sync schedule settings.", - "properties": { - "syncInDays": { - "type": "integer", - "description": "Days interval for sync scheduler" - }, - "syncInHours": { - "type": "integer", - "description": "" - }, - "syncInMinutes": { - "type": "integer", - "description": "" - }, - "isEnabled": { - "type": "boolean", - "description": "Activate automatic scheduler" - }, - "nextTime": { - "type": "string", - "description": "The first time the relationship should run" - }, - "syncWhenCreated": { - "type": "boolean", - "default": true, - "description": "Start the sync upon creation" - } - } - }, - "notifications": { - "type": "object", - "description": "Notifications settings.", - "properties": { - "cm": { - "type": "object", - "description": "NetApp Console notifications", - "properties": { - "done": { - "type": "boolean", - "description": "Should send notification about DONE status" - }, - "failed": { - "type": "boolean", - "description": "Should send notification about FAILED status" - }, - "aborted": { - "type": "boolean", - "description": "Should send notification about ABORTED status" - }, - "running_continuously": { - "type": "boolean", - "description": "Should send notification about RUNNING_CONTINUOUSLY status" - } - } - } - } - }, - "scheduleAbort": { - "type": "object", - "description": "Schedule abort settings.", - "properties": { - "abortInDays": { - "type": "integer", - "description": "Days interval for abort scheduler" - }, - "abortInHours": { - "type": "integer", - "description": "Hours interval for abort scheduler" - }, - "abortInMinutes": { - "type": "integer", - "description": "Minutes interval for abort scheduler" - }, - "isEnabled": { - "type": "boolean", - "description": "Activate automatic scheduler abort" - } - } - } - }, - "required": [ - "copyData", - "gracePeriod", - "deleteOnSource", - "deleteOnTarget", - "objectTagging", - "retries", - "fileTypes", - "compareBy", - "files", - "directories", - "schedule", - "scheduleAbort" - ], - "type": "object" - }, - "activity": { - "type": "object", - "additionalProperties": true, - "properties": { - "syncType": { - "type": "string", - "description": "field for UI - to indicate if we copy only acl or copy also data" - }, - "status": { - "type": "string", - "description": "Relationship status", - "enum": [ - "RUNNING", - "DONE", - "FAILED", - "ABORTED", - "PENDING" - ] - }, - "type": { - "type": "string", - "description": "Relationship phase - Initial copy or sync" - }, - "bytesMarkedForCopy": { - "type": "number", - "description": "Bytes marked for copy" - }, - "filesMarkedForCopy": { - "type": "number", - "description": "Files marked for copy" - }, - "dirsMarkedForCopy": { - "type": "number", - "description": "Directories marked for copy" - }, - "filesCopied": { - "type": "number", - "description": "Files copied" - }, - "bytesCopied": { - "type": "number", - "description": "Bytes copied" - }, - "dirsCopied": { - "type": "number", - "description": "Directories copied" - }, - "filesFailed": { - "type": "number", - "description": "files failed to copy" - }, - "bytesFailed": { - "type": "number", - "description": "Bytes failed to copy" - }, - "dirsFailed": { - "type": "number", - "description": "Directories failed to copy" - }, - "filesMarkedForRemove": { - "type": "number", - "description": "Files marked for remove" - }, - "bytesMarkedForRemove": { - "type": "number", - "description": "Byes marked for remove" - }, - "dirsMarkedForRemove": { - "type": "number", - "description": "Directories marked for remove" - }, - "filesRemoved": { - "type": "number", - "description": "Files removed" - }, - "bytesRemoved": { - "type": "number", - "description": "Bytes removed" - }, - "dirsRemoved": { - "type": "number", - "description": "Directories removed" - }, - "bytesRemovedFailed": { - "type": "number", - "description": "Bytes failed to remove" - }, - "filesRemovedFailed": { - "type": "number", - "description": "Filed failed to remove" - }, - "filesMarkedForIgnore": { - "type": "number", - "description": "Files marked for ignore" - }, - "dirsScanned": { - "type": "number", - "description": "Directories scanned" - }, - "filesScanned": { - "type": "number", - "description": "Files scanned" - }, - "bytesScanned": { - "type": "number", - "description": "Bytes scanned" - }, - "dirsFailedToScan": { - "type": "number", - "description": "Directories failed to scan" - }, - "timeEstimation": { - "type": "number", - "description": "Time estimation until the end of the sync" - }, - "progress": { - "type": "number", - "description": "Relationship progress" - }, - "endTime": { - "type": "string", - "description": "End time" - }, - "startTime": { - "type": "string", - "description": "Start time" - }, - "executionTime": { - "type": "number", - "description": "Execution time" - }, - "failureMessage": { - "type": "string", - "description": "Failure message" - }, - "lastMessageTime": { - "type": "string", - "description": "Last message time" - }, - "topFiveMostCommonRelationshipErrors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "step": { - "type": "string", - "description": "Sync step that failed - TRANSFER or SCAN" - }, - "errorCode": { - "type": "string", - "description": "Error code" - }, - "counter": { - "type": "number", - "description": "Number of errors" - }, - "description": { - "type": "string", - "description": "Error description" - } - } - } - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "dataBrokerId": { - "type": "string", - "description": "Data Broker with initialized error" - }, - "reason": { - "type": "string", - "description": "Error" - } - } - } - } - } - }, - "createdAt": { - "type": "number", - "description": "Relationship Creation time" - }, - "customHeaders": { - "type": "object", - "description": "Custom headers for the relationship", - "properties": { - "x-netapp-external-request-id-src": { - "type": "string", - "description": "Source request ID header" - }, - "x-netapp-external-request-id-trg": { - "type": "string", - "description": "Target request ID header" - }, - "x-source-edge": { - "type": "string", - "description": "Edge cluster UUID" - }, - "x-target-edge": { - "type": "string", - "description": "Edge cluster UUID" - }, - "x-sync-source": { - "type": "string", - "description": "Is source Edge" - }, - "x-sync-target": { - "type": "string", - "description": "is target Edge" - } - } - }, - "extraInformation": { - "type": "object", - "properties": { - "dataSenseQueryUid": { - "type": "string", - "description": "Data sense query uid" - }, - "connectorId": { - "type": "string", - "description": "Console agent ID ( for data sense query )" - } - } - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - } - }, - "required": [ - "id", - "source", - "target", - "createdAt" - ] - } - } - } - } - } - } - }, - "/api/relationships-v2/{id}": { - "get": { - "tags": [ - "Relationships" - ], - "description": "Retrieves a relationship.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Relationship ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Relationship ID" - }, - "isCM": { - "type": "string", - "description": "Was the relationship created through CloudManager" - }, - "dataBroker": { - "type": "string", - "description": "Data Broker ID" - }, - "relationshipId": { - "type": "string", - "description": "Relationship ID" - }, - "source": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "description": "Endpoint protocol", - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ] - }, - "cifs": { - "type": "object", - "description": "CIFS Details", - "properties": { - "host": { - "type": "string", - "description": "CIFS host" - }, - "share": { - "type": "string", - "description": "CIFS share" - }, - "provider": { - "type": "string", - "description": "CIFS type", - "enum": [ - "cifs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx" - ] - }, - "path": { - "type": "string", - "description": "CIFS path" - }, - "version": { - "type": "string", - "description": "Supported CIFS versions", - "enum": [ - "1.0", - "2.0", - "2.1", - "3.0", - "3.11" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "credentials": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - } - }, - "required": [ - "host", - "share", - "provider" - ] - }, - "nfs": { - "type": "object", - "description": "NFS Details", - "properties": { - "host": { - "type": "string", - "description": "NFS host" - }, - "export": { - "type": "string", - "description": "NFS export" - }, - "provider": { - "type": "string", - "description": "NFS type", - "enum": [ - "nfs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx", - "efs" - ] - }, - "path": { - "type": "string", - "description": "NFS path" - }, - "version": { - "type": "string", - "description": "Supported NFS versions", - "enum": [ - "3", - "4.0", - "4.1", - "4.2" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "accessPoint": { - "type": "string", - "description": "EFS access point" - } - }, - "required": [ - "host", - "export", - "provider" - ] - }, - "s3": { - "type": "object", - "description": "S3 details", - "properties": { - "host": { - "type": "string", - "description": "SGWS or IBM or ONTAP host" - }, - "port": { - "type": "integer", - "description": "SGWS or IBM or ONTAP port" - }, - "bucket": { - "type": "string", - "description": "Bucket" - }, - "prefix": { - "type": "string", - "description": "Prefix" - }, - "region": { - "type": "string", - "description": "Bucket region" - }, - "encryption": { - "type": "object", - "description": "S3 encryption", - "properties": { - "protocol": { - "type": "string", - "description": "Encryption type", - "enum": [ - "kms", - "aes256" - ], - "default": "aes256" - }, - "keyId": { - "type": "string", - "description": "Encryption key arn in case it is kms encryption" - } - } - }, - "privateLinkDns": { - "type": "string", - "description": "AWS S3 Private Link DNS" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "S3 Storage Class", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_IR", - "DEEP_ARCHIVE", - "IA" - ] - }, - "provider": { - "type": "string", - "description": "Object Storage Type", - "enum": [ - "s3", - "alibaba", - "sgws", - "ibm", - "ontap" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID - for storageGrid system" - }, - "glacier": { - "type": "object", - "description": "Glacier storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Expedited", - "enum": [ - "Expedited", - "Standard", - "Bulk" - ], - "description": "Glacier retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "deepArchive": { - "type": "object", - "description": "Deep Archive storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Standard", - "enum": [ - "Standard", - "Bulk" - ], - "description": "Deep Archive retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "local": { - "type": "object", - "description": "Local object details", - "properties": { - "path": { - "type": "string", - "description": "Local Path" - } - }, - "required": [ - "path" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Details", - "required": [ - "container", - "provider" - ], - "properties": { - "container": { - "type": "string", - "description": "Azure Blob Storage container name" - }, - "storageAccountName": { - "type": "string", - "description": "Azure Blob Storage account name" - }, - "prefix": { - "type": "string", - "description": "Container blob prefix" - }, - "path": { - "type": "string", - "description": "Container path, used in azure data lake storage" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "blobTier": { - "type": "string", - "enum": [ - "HOT", - "COOL", - "ARCHIVE", - "COLD" - ], - "default": "HOT", - "description": "Blob tier type" - }, - "provider": { - "type": "string", - "description": "Azure type", - "enum": [ - "azure", - "azure_data_lake" - ], - "default": "azure" - } - } - }, - "gcp": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "GCP Bucket" - }, - "prefix": { - "type": "string", - "description": "GCP Bucket prefix" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "GCP Storage Class", - "enum": [ - "STANDARD", - "NEARLINE", - "COLDLINE", - "ARCHIVE" - ], - "default": "STANDARD" - }, - "kmsKeyName": { - "type": "string", - "description": "GCP Kms name" - }, - "provider": { - "type": "string", - "description": "GCP Type", - "enum": [ - "gcp" - ], - "default": "gcp" - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "driveId": { - "type": "string", - "description": "Drive Id" - }, - "driveName": { - "type": "string", - "description": "Drive Name" - }, - "folderId": { - "type": "string", - "description": "Google Drive folderId" - }, - "path": { - "type": "string", - "description": "Folder path" - }, - "provider": { - "type": "string", - "description": "Google Drive Type", - "enum": [ - "gdrive" - ], - "default": "gdrive" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "subject": { - "type": "string", - "description": "subject - user email" - } - }, - "required": [ - "driveId", - "provider", - "subject" - ] - }, - "sftp": { - "type": "object", - "properties": { - "host": { - "type": "string", - "description": "SFTP host" - }, - "port": { - "type": "integer", - "description": "SFTP port number" - }, - "path": { - "type": "string", - "description": "Directory path" - }, - "rootDirectory": { - "type": "string", - "description": "Root Directory path" - }, - "provider": { - "type": "string", - "description": "SFTP Type", - "enum": [ - "sftp" - ], - "default": "sftp" - } - }, - "required": [ - "host", - "port", - "rootDirectory", - "provider" - ] - }, - "box": { - "type": "object", - "properties": { - "rootDirectory": { - "type": "string", - "description": "Root Directory" - }, - "path": { - "type": "string", - "description": "path" - }, - "folderId": { - "type": "string", - "description": "Folder ID" - }, - "clientId": { - "type": "string", - "description": "Client ID" - }, - "appName": { - "type": "string", - "description": "Box Application Name" - }, - "enterpriseId": { - "type": "string", - "description": "Enterprise Id" - }, - "provider": { - "type": "string", - "description": "Box Type", - "enum": [ - "box" - ], - "default": "box" - } - }, - "required": [ - "folderId", - "provider", - "clientId" - ] - } - } - }, - "target": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "description": "Endpoint protocol", - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ] - }, - "cifs": { - "type": "object", - "description": "CIFS Details", - "properties": { - "host": { - "type": "string", - "description": "CIFS host" - }, - "share": { - "type": "string", - "description": "CIFS share" - }, - "provider": { - "type": "string", - "description": "CIFS type", - "enum": [ - "cifs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx" - ] - }, - "path": { - "type": "string", - "description": "CIFS path" - }, - "version": { - "type": "string", - "description": "Supported CIFS versions", - "enum": [ - "1.0", - "2.0", - "2.1", - "3.0", - "3.11" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "credentials": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - } - }, - "required": [ - "host", - "share", - "provider" - ] - }, - "nfs": { - "type": "object", - "description": "NFS Details", - "properties": { - "host": { - "type": "string", - "description": "NFS host" - }, - "export": { - "type": "string", - "description": "NFS export" - }, - "provider": { - "type": "string", - "description": "NFS type", - "enum": [ - "nfs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx", - "efs" - ] - }, - "path": { - "type": "string", - "description": "NFS path" - }, - "version": { - "type": "string", - "description": "Supported NFS versions", - "enum": [ - "3", - "4.0", - "4.1", - "4.2" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "accessPoint": { - "type": "string", - "description": "EFS access point" - } - }, - "required": [ - "host", - "export", - "provider" - ] - }, - "s3": { - "type": "object", - "description": "S3 details", - "properties": { - "host": { - "type": "string", - "description": "SGWS or IBM or ONTAP host" - }, - "port": { - "type": "integer", - "description": "SGWS or IBM or ONTAP port" - }, - "bucket": { - "type": "string", - "description": "Bucket" - }, - "prefix": { - "type": "string", - "description": "Prefix" - }, - "region": { - "type": "string", - "description": "Bucket region" - }, - "encryption": { - "type": "object", - "description": "S3 encryption", - "properties": { - "protocol": { - "type": "string", - "description": "Encryption type", - "enum": [ - "kms", - "aes256" - ], - "default": "aes256" - }, - "keyId": { - "type": "string", - "description": "Encryption key arn in case it is kms encryption" - } - } - }, - "privateLinkDns": { - "type": "string", - "description": "AWS S3 Private Link DNS" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "S3 Storage Class", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_IR", - "DEEP_ARCHIVE", - "IA" - ] - }, - "provider": { - "type": "string", - "description": "Object Storage Type", - "enum": [ - "s3", - "alibaba", - "sgws", - "ibm", - "ontap" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID - for storageGrid system" - }, - "glacier": { - "type": "object", - "description": "Glacier storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Expedited", - "enum": [ - "Expedited", - "Standard", - "Bulk" - ], - "description": "Glacier retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "deepArchive": { - "type": "object", - "description": "Deep Archive storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Standard", - "enum": [ - "Standard", - "Bulk" - ], - "description": "Deep Archive retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "local": { - "type": "object", - "description": "Local object details", - "properties": { - "path": { - "type": "string", - "description": "Local Path" - } - }, - "required": [ - "path" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Details", - "required": [ - "container", - "provider" - ], - "properties": { - "container": { - "type": "string", - "description": "Azure Blob Storage container name" - }, - "storageAccountName": { - "type": "string", - "description": "Azure Blob Storage account name" - }, - "prefix": { - "type": "string", - "description": "Container blob prefix" - }, - "path": { - "type": "string", - "description": "Container path, used in azure data lake storage" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "blobTier": { - "type": "string", - "enum": [ - "HOT", - "COOL", - "ARCHIVE", - "COLD" - ], - "default": "HOT", - "description": "Blob tier type" - }, - "provider": { - "type": "string", - "description": "Azure type", - "enum": [ - "azure", - "azure_data_lake" - ], - "default": "azure" - } - } - }, - "gcp": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "GCP Bucket" - }, - "prefix": { - "type": "string", - "description": "GCP Bucket prefix" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "GCP Storage Class", - "enum": [ - "STANDARD", - "NEARLINE", - "COLDLINE", - "ARCHIVE" - ], - "default": "STANDARD" - }, - "kmsKeyName": { - "type": "string", - "description": "GCP Kms name" - }, - "provider": { - "type": "string", - "description": "GCP Type", - "enum": [ - "gcp" - ], - "default": "gcp" - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "driveId": { - "type": "string", - "description": "Drive Id" - }, - "driveName": { - "type": "string", - "description": "Drive Name" - }, - "folderId": { - "type": "string", - "description": "Google Drive folderId" - }, - "path": { - "type": "string", - "description": "Folder path" - }, - "provider": { - "type": "string", - "description": "Google Drive Type", - "enum": [ - "gdrive" - ], - "default": "gdrive" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "subject": { - "type": "string", - "description": "subject - user email" - } - }, - "required": [ - "driveId", - "provider", - "subject" - ] - }, - "sftp": { - "type": "object", - "properties": { - "host": { - "type": "string", - "description": "SFTP host" - }, - "port": { - "type": "integer", - "description": "SFTP port number" - }, - "path": { - "type": "string", - "description": "Directory path" - }, - "rootDirectory": { - "type": "string", - "description": "Root Directory path" - }, - "provider": { - "type": "string", - "description": "SFTP Type", - "enum": [ - "sftp" - ], - "default": "sftp" - } - }, - "required": [ - "host", - "port", - "rootDirectory", - "provider" - ] - }, - "box": { - "type": "object", - "properties": { - "rootDirectory": { - "type": "string", - "description": "Root Directory" - }, - "path": { - "type": "string", - "description": "path" - }, - "folderId": { - "type": "string", - "description": "Folder ID" - }, - "clientId": { - "type": "string", - "description": "Client ID" - }, - "appName": { - "type": "string", - "description": "Box Application Name" - }, - "enterpriseId": { - "type": "string", - "description": "Enterprise Id" - }, - "provider": { - "type": "string", - "description": "Box Type", - "enum": [ - "box" - ], - "default": "box" - } - }, - "required": [ - "folderId", - "provider", - "clientId" - ] - } - } - }, - "encryption": { - "type": "object", - "properties": { - "initiator": { - "description": "Initiator details", - "type": "object", - "properties": { - "dataBrokerId": { - "type": "string", - "description": "Data Broker Id" - }, - "groupId": { - "type": "string", - "description": "Group Id" - }, - "encryptionType": { - "type": "string", - "description": "Data Broker network location - if initiator is src, listener must be trg", - "enum": [ - "src", - "trg" - ] - } - }, - "required": [ - "endpointType" - ] - }, - "listener": { - "description": "Listener details", - "type": "object", - "properties": { - "dataBrokerId": { - "type": "string", - "description": "Data Broker Id" - }, - "groupId": { - "type": "string", - "description": "Group Id" - }, - "encryptionType": { - "type": "string", - "description": "Data Broker network location - if initiator is src, listener must be trg", - "enum": [ - "src", - "trg" - ] - } - }, - "required": [ - "endpointType" - ] - } - } - }, - "group": { - "type": "string", - "description": "Group ID" - }, - "settings": { - "properties": { - "gracePeriod": { - "type": "number", - "description": "Grace period time ( seconds )" - }, - "deleteOnSource": { - "type": "boolean", - "description": "Enable delete on source" - }, - "deleteOnTarget": { - "type": "boolean", - "description": "Enable delete on target" - }, - "objectTagging": { - "type": "boolean", - "description": "Use S3 tagging to store object metadata" - }, - "retries": { - "type": "integer", - "description": "Number of retries" - }, - "copyAcl": { - "type": "boolean", - "description": "Enable ACL copy" - }, - "copyData": { - "type": "boolean", - "description": "Copy data only" - }, - "continuousSync": { - "type": "boolean", - "description": "Listen to object notifications" - }, - "fileTypes": { - "type": "object", - "description": "The file types that is included in the relationship", - "properties": { - "files": { - "type": "boolean", - "description": "Include files" - }, - "directories": { - "type": "boolean", - "description": "Include directories" - }, - "symlinks": { - "type": "boolean", - "description": "Include symbolic links" - }, - "hardlinks": { - "type": "boolean", - "description": "include hard links" - } - } - }, - "compareBy": { - "type": "object", - "description": "The file attributes that should be compared", - "properties": { - "uid": { - "type": "boolean", - "description": "uid ( relevant when source or target is file system )" - }, - "gid": { - "type": "boolean", - "description": "gid ( relevant when source or target is file system )" - }, - "mtime": { - "type": "boolean", - "description": "mtime" - }, - "mode": { - "type": "boolean", - "description": "mode" - } - } - }, - "copyProperties": { - "type": "object", - "description": "The object properties that should be copied", - "properties": { - "metadata": { - "type": "boolean", - "description": "copy metadata ( cloud to cloud )" - }, - "tags": { - "type": "boolean", - "description": "copy tags ( cloud to cloud only S3 compatible )" - } - } - }, - "files": { - "type": "object", - "description": "Settings related to files.", - "properties": { - "excludeExtensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded extensions array (For example - [\".log\", \".tar.gz\"])" - }, - "excludeByRegex": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded files by regex (For example - \"\\.txt\\.\" will exclude the files file.doc.txt.gz)" - }, - "minSize": { - "type": "integer", - "description": "Minimum file size (in bytes). Only files of equal or larger size will be transferred by the relationship" - }, - "maxSize": { - "type": "integer", - "description": "Maximum file size (in bytes). Only files of equal or smaller size will be transferred by the relationship" - }, - "minDate": { - "type": "string", - "description": "Data broker will sync files that were last modified after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'" - }, - "maxDate": { - "type": [ - "null", - "string" - ], - "description": "Data broker will sync files that were last modified before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date" - }, - "minCreationDate": { - "type": "string", - "description": "Data broker will sync files that were created after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'" - }, - "maxCreationDate": { - "type": [ - "null", - "string" - ], - "description": "Data broker will sync files that were created before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date" - } - } - }, - "directories": { - "type": "object", - "description": "Settings related to directories.", - "properties": { - "excludeNames": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded directories names array (For example - [\"dir1\"])" - }, - "excludeByRegex": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded directories names by regex (For example - \"\\.*tmp.*\\.\" will exclude the directories with names that include tmp )" - } - } - }, - "schedule": { - "type": "object", - "description": "Sync schedule settings.", - "properties": { - "syncInDays": { - "type": "integer", - "description": "Days interval for sync scheduler" - }, - "syncInHours": { - "type": "integer", - "description": "" - }, - "syncInMinutes": { - "type": "integer", - "description": "" - }, - "isEnabled": { - "type": "boolean", - "description": "Activate automatic scheduler" - }, - "nextTime": { - "type": "string", - "description": "The first time the relationship should run" - }, - "syncWhenCreated": { - "type": "boolean", - "default": true, - "description": "Start the sync upon creation" - } - } - }, - "notifications": { - "type": "object", - "description": "Notifications settings.", - "properties": { - "cm": { - "type": "object", - "description": "NetApp Console notifications", - "properties": { - "done": { - "type": "boolean", - "description": "Should send notification about DONE status" - }, - "failed": { - "type": "boolean", - "description": "Should send notification about FAILED status" - }, - "aborted": { - "type": "boolean", - "description": "Should send notification about ABORTED status" - }, - "running_continuously": { - "type": "boolean", - "description": "Should send notification about RUNNING_CONTINUOUSLY status" - } - } - } - } - }, - "scheduleAbort": { - "type": "object", - "description": "Schedule abort settings.", - "properties": { - "abortInDays": { - "type": "integer", - "description": "Days interval for abort scheduler" - }, - "abortInHours": { - "type": "integer", - "description": "Hours interval for abort scheduler" - }, - "abortInMinutes": { - "type": "integer", - "description": "Minutes interval for abort scheduler" - }, - "isEnabled": { - "type": "boolean", - "description": "Activate automatic scheduler abort" - } - } - } - }, - "required": [ - "copyData", - "gracePeriod", - "deleteOnSource", - "deleteOnTarget", - "objectTagging", - "retries", - "fileTypes", - "compareBy", - "files", - "directories", - "schedule", - "scheduleAbort" - ], - "type": "object" - }, - "activity": { - "type": "object", - "additionalProperties": true, - "properties": { - "syncType": { - "type": "string", - "description": "field for UI - to indicate if we copy only acl or copy also data" - }, - "status": { - "type": "string", - "description": "Relationship status", - "enum": [ - "RUNNING", - "DONE", - "FAILED", - "ABORTED", - "PENDING" - ] - }, - "type": { - "type": "string", - "description": "Relationship phase - Initial copy or sync" - }, - "bytesMarkedForCopy": { - "type": "number", - "description": "Bytes marked for copy" - }, - "filesMarkedForCopy": { - "type": "number", - "description": "Files marked for copy" - }, - "dirsMarkedForCopy": { - "type": "number", - "description": "Directories marked for copy" - }, - "filesCopied": { - "type": "number", - "description": "Files copied" - }, - "bytesCopied": { - "type": "number", - "description": "Bytes copied" - }, - "dirsCopied": { - "type": "number", - "description": "Directories copied" - }, - "filesFailed": { - "type": "number", - "description": "files failed to copy" - }, - "bytesFailed": { - "type": "number", - "description": "Bytes failed to copy" - }, - "dirsFailed": { - "type": "number", - "description": "Directories failed to copy" - }, - "filesMarkedForRemove": { - "type": "number", - "description": "Files marked for remove" - }, - "bytesMarkedForRemove": { - "type": "number", - "description": "Byes marked for remove" - }, - "dirsMarkedForRemove": { - "type": "number", - "description": "Directories marked for remove" - }, - "filesRemoved": { - "type": "number", - "description": "Files removed" - }, - "bytesRemoved": { - "type": "number", - "description": "Bytes removed" - }, - "dirsRemoved": { - "type": "number", - "description": "Directories removed" - }, - "bytesRemovedFailed": { - "type": "number", - "description": "Bytes failed to remove" - }, - "filesRemovedFailed": { - "type": "number", - "description": "Filed failed to remove" - }, - "filesMarkedForIgnore": { - "type": "number", - "description": "Files marked for ignore" - }, - "dirsScanned": { - "type": "number", - "description": "Directories scanned" - }, - "filesScanned": { - "type": "number", - "description": "Files scanned" - }, - "bytesScanned": { - "type": "number", - "description": "Bytes scanned" - }, - "dirsFailedToScan": { - "type": "number", - "description": "Directories failed to scan" - }, - "timeEstimation": { - "type": "number", - "description": "Time estimation until the end of the sync" - }, - "progress": { - "type": "number", - "description": "Relationship progress" - }, - "endTime": { - "type": "string", - "description": "End time" - }, - "startTime": { - "type": "string", - "description": "Start time" - }, - "executionTime": { - "type": "number", - "description": "Execution time" - }, - "failureMessage": { - "type": "string", - "description": "Failure message" - }, - "lastMessageTime": { - "type": "string", - "description": "Last message time" - }, - "topFiveMostCommonRelationshipErrors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "step": { - "type": "string", - "description": "Sync step that failed - TRANSFER or SCAN" - }, - "errorCode": { - "type": "string", - "description": "Error code" - }, - "counter": { - "type": "number", - "description": "Number of errors" - }, - "description": { - "type": "string", - "description": "Error description" - } - } - } - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "dataBrokerId": { - "type": "string", - "description": "Data Broker with initialized error" - }, - "reason": { - "type": "string", - "description": "Error" - } - } - } - } - } - }, - "createdAt": { - "type": "number", - "description": "Relationship Creation time" - }, - "customHeaders": { - "type": "object", - "description": "Custom headers for the relationship", - "properties": { - "x-netapp-external-request-id-src": { - "type": "string", - "description": "Source request ID header" - }, - "x-netapp-external-request-id-trg": { - "type": "string", - "description": "Target request ID header" - }, - "x-source-edge": { - "type": "string", - "description": "Edge cluster UUID" - }, - "x-target-edge": { - "type": "string", - "description": "Edge cluster UUID" - }, - "x-sync-source": { - "type": "string", - "description": "Is source Edge" - }, - "x-sync-target": { - "type": "string", - "description": "is target Edge" - } - } - }, - "extraInformation": { - "type": "object", - "properties": { - "dataSenseQueryUid": { - "type": "string", - "description": "Data sense query uid" - }, - "connectorId": { - "type": "string", - "description": "Console agent ID ( for data sense query )" - } - } - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - } - }, - "required": [ - "id", - "source", - "target", - "createdAt" - ] - } - } - } - } - } - }, - "put": { - "tags": [ - "Relationships" - ], - "description": "Updates the settings for a relationship.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "gracePeriod": { - "type": "number", - "description": "Grace period time ( seconds )" - }, - "deleteOnSource": { - "type": "boolean", - "description": "Enable delete on source" - }, - "deleteOnTarget": { - "type": "boolean", - "description": "Enable delete on target" - }, - "objectTagging": { - "type": "boolean", - "description": "Use S3 tagging to store object metadata" - }, - "retries": { - "type": "integer", - "description": "Number of retries" - }, - "copyAcl": { - "type": "boolean", - "description": "Enable ACL copy" - }, - "copyData": { - "type": "boolean", - "description": "Copy data only" - }, - "continuousSync": { - "type": "boolean", - "description": "Listen to object notifications" - }, - "fileTypes": { - "type": "object", - "description": "The file types that is included in the relationship", - "properties": { - "files": { - "type": "boolean", - "description": "Include files" - }, - "directories": { - "type": "boolean", - "description": "Include directories" - }, - "symlinks": { - "type": "boolean", - "description": "Include symbolic links" - }, - "hardlinks": { - "type": "boolean", - "description": "include hard links" - } - } - }, - "compareBy": { - "type": "object", - "description": "The file attributes that should be compared", - "properties": { - "uid": { - "type": "boolean", - "description": "uid ( relevant when source or target is file system )" - }, - "gid": { - "type": "boolean", - "description": "gid ( relevant when source or target is file system )" - }, - "mtime": { - "type": "boolean", - "description": "mtime" - }, - "mode": { - "type": "boolean", - "description": "mode" - } - } - }, - "copyProperties": { - "type": "object", - "description": "The object properties that should be copied", - "properties": { - "metadata": { - "type": "boolean", - "description": "copy metadata ( cloud to cloud )" - }, - "tags": { - "type": "boolean", - "description": "copy tags ( cloud to cloud only S3 compatible )" - } - } - }, - "files": { - "type": "object", - "description": "Settings related to files.", - "properties": { - "excludeExtensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded extensions array (For example - [\".log\", \".tar.gz\"])" - }, - "excludeByRegex": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded files by regex (For example - \"\\.txt\\.\" will exclude the files file.doc.txt.gz)" - }, - "minSize": { - "type": "integer", - "description": "Minimum file size (in bytes). Only files of equal or larger size will be transferred by the relationship" - }, - "maxSize": { - "type": "integer", - "description": "Maximum file size (in bytes). Only files of equal or smaller size will be transferred by the relationship" - }, - "minDate": { - "type": "string", - "description": "Data broker will sync files that were last modified after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'" - }, - "maxDate": { - "type": [ - "null", - "string" - ], - "description": "Data broker will sync files that were last modified before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date" - }, - "minCreationDate": { - "type": "string", - "description": "Data broker will sync files that were created after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'" - }, - "maxCreationDate": { - "type": [ - "null", - "string" - ], - "description": "Data broker will sync files that were created before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date" - } - } - }, - "directories": { - "type": "object", - "description": "Settings related to directories.", - "properties": { - "excludeNames": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded directories names array (For example - [\"dir1\"])" - }, - "excludeByRegex": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded directories names by regex (For example - \"\\.*tmp.*\\.\" will exclude the directories with names that include tmp )" - } - } - }, - "schedule": { - "type": "object", - "description": "Sync schedule settings.", - "properties": { - "syncInDays": { - "type": "integer", - "description": "Days interval for sync scheduler" - }, - "syncInHours": { - "type": "integer", - "description": "" - }, - "syncInMinutes": { - "type": "integer", - "description": "" - }, - "isEnabled": { - "type": "boolean", - "description": "Activate automatic scheduler" - }, - "nextTime": { - "type": "string", - "description": "The first time the relationship should run" - }, - "syncWhenCreated": { - "type": "boolean", - "default": true, - "description": "Start the sync upon creation" - } - } - }, - "notifications": { - "type": "object", - "description": "Notifications settings.", - "properties": { - "cm": { - "type": "object", - "description": "NetApp Console notifications", - "properties": { - "done": { - "type": "boolean", - "description": "Should send notification about DONE status" - }, - "failed": { - "type": "boolean", - "description": "Should send notification about FAILED status" - }, - "aborted": { - "type": "boolean", - "description": "Should send notification about ABORTED status" - }, - "running_continuously": { - "type": "boolean", - "description": "Should send notification about RUNNING_CONTINUOUSLY status" - } - } - } - } - }, - "scheduleAbort": { - "type": "object", - "description": "Schedule abort settings.", - "properties": { - "abortInDays": { - "type": "integer", - "description": "Days interval for abort scheduler" - }, - "abortInHours": { - "type": "integer", - "description": "Hours interval for abort scheduler" - }, - "abortInMinutes": { - "type": "integer", - "description": "Minutes interval for abort scheduler" - }, - "isEnabled": { - "type": "boolean", - "description": "Activate automatic scheduler abort" - } - } - } - } - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Relationship ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "properties": { - "gracePeriod": { - "type": "number", - "description": "Grace period time ( seconds )" - }, - "deleteOnSource": { - "type": "boolean", - "description": "Enable delete on source" - }, - "deleteOnTarget": { - "type": "boolean", - "description": "Enable delete on target" - }, - "objectTagging": { - "type": "boolean", - "description": "Use S3 tagging to store object metadata" - }, - "retries": { - "type": "integer", - "description": "Number of retries" - }, - "copyAcl": { - "type": "boolean", - "description": "Enable ACL copy" - }, - "copyData": { - "type": "boolean", - "description": "Copy data only" - }, - "continuousSync": { - "type": "boolean", - "description": "Listen to object notifications" - }, - "fileTypes": { - "type": "object", - "description": "The file types that is included in the relationship", - "properties": { - "files": { - "type": "boolean", - "description": "Include files" - }, - "directories": { - "type": "boolean", - "description": "Include directories" - }, - "symlinks": { - "type": "boolean", - "description": "Include symbolic links" - }, - "hardlinks": { - "type": "boolean", - "description": "include hard links" - } - } - }, - "compareBy": { - "type": "object", - "description": "The file attributes that should be compared", - "properties": { - "uid": { - "type": "boolean", - "description": "uid ( relevant when source or target is file system )" - }, - "gid": { - "type": "boolean", - "description": "gid ( relevant when source or target is file system )" - }, - "mtime": { - "type": "boolean", - "description": "mtime" - }, - "mode": { - "type": "boolean", - "description": "mode" - } - } - }, - "copyProperties": { - "type": "object", - "description": "The object properties that should be copied", - "properties": { - "metadata": { - "type": "boolean", - "description": "copy metadata ( cloud to cloud )" - }, - "tags": { - "type": "boolean", - "description": "copy tags ( cloud to cloud only S3 compatible )" - } - } - }, - "files": { - "type": "object", - "description": "Settings related to files.", - "properties": { - "excludeExtensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded extensions array (For example - [\".log\", \".tar.gz\"])" - }, - "excludeByRegex": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded files by regex (For example - \"\\.txt\\.\" will exclude the files file.doc.txt.gz)" - }, - "minSize": { - "type": "integer", - "description": "Minimum file size (in bytes). Only files of equal or larger size will be transferred by the relationship" - }, - "maxSize": { - "type": "integer", - "description": "Maximum file size (in bytes). Only files of equal or smaller size will be transferred by the relationship" - }, - "minDate": { - "type": "string", - "description": "Data broker will sync files that were last modified after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'" - }, - "maxDate": { - "type": [ - "null", - "string" - ], - "description": "Data broker will sync files that were last modified before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date" - }, - "minCreationDate": { - "type": "string", - "description": "Data broker will sync files that were created after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21'" - }, - "maxCreationDate": { - "type": [ - "null", - "string" - ], - "description": "Data broker will sync files that were created before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date" - } - } - }, - "directories": { - "type": "object", - "description": "Settings related to directories.", - "properties": { - "excludeNames": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded directories names array (For example - [\"dir1\"])" - }, - "excludeByRegex": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Excluded directories names by regex (For example - \"\\.*tmp.*\\.\" will exclude the directories with names that include tmp )" - } - } - }, - "schedule": { - "type": "object", - "description": "Sync schedule settings.", - "properties": { - "syncInDays": { - "type": "integer", - "description": "Days interval for sync scheduler" - }, - "syncInHours": { - "type": "integer", - "description": "" - }, - "syncInMinutes": { - "type": "integer", - "description": "" - }, - "isEnabled": { - "type": "boolean", - "description": "Activate automatic scheduler" - }, - "nextTime": { - "type": "string", - "description": "The first time the relationship should run" - }, - "syncWhenCreated": { - "type": "boolean", - "default": true, - "description": "Start the sync upon creation" - } - } - }, - "notifications": { - "type": "object", - "description": "Notifications settings.", - "properties": { - "cm": { - "type": "object", - "description": "NetApp Console notifications", - "properties": { - "done": { - "type": "boolean", - "description": "Should send notification about DONE status" - }, - "failed": { - "type": "boolean", - "description": "Should send notification about FAILED status" - }, - "aborted": { - "type": "boolean", - "description": "Should send notification about ABORTED status" - }, - "running_continuously": { - "type": "boolean", - "description": "Should send notification about RUNNING_CONTINUOUSLY status" - } - } - } - } - }, - "scheduleAbort": { - "type": "object", - "description": "Schedule abort settings.", - "properties": { - "abortInDays": { - "type": "integer", - "description": "Days interval for abort scheduler" - }, - "abortInHours": { - "type": "integer", - "description": "Hours interval for abort scheduler" - }, - "abortInMinutes": { - "type": "integer", - "description": "Minutes interval for abort scheduler" - }, - "isEnabled": { - "type": "boolean", - "description": "Activate automatic scheduler abort" - } - } - } - }, - "required": [ - "copyData", - "gracePeriod", - "deleteOnSource", - "deleteOnTarget", - "objectTagging", - "retries", - "fileTypes", - "compareBy", - "files", - "directories", - "schedule", - "scheduleAbort" - ], - "type": "object" - } - } - } - } - } - } - }, - "/api/relationships/{id}": { - "delete": { - "tags": [ - "Relationships" - ], - "description": "Deletes an existing relationship.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Relationship ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "Default Response" - } - } - } - }, - "/api/v2/accounts/{accountId}/relationships": { - "delete": { - "tags": [ - "Relationships" - ], - "description": "Deletes relationships.", - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "relationships", - "required": true, - "description": "Relationship IDs to delete" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "204": { - "description": "Default Response" - } - } - } - }, - "/api/relationships/{id}/sync": { - "put": { - "tags": [ - "Relationships" - ], - "description": "Initiates a relationship data sync.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Relationship ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/relationships/{id}/abort": { - "put": { - "tags": [ - "Relationships" - ], - "description": "Stops a relationship data sync.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Relationship ID" - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/relationships/end-points": { - "get": { - "tags": [ - "Relationships" - ], - "description": "Retrieves the relationship endpoints.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "relationships": { - "type": "array", - "items": { - "type": "object", - "properties": { - "source": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Endpoint ID system ID or aws,azure,gcp,sgws,ibm" - }, - "metadata": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "Bucket name" - }, - "host": { - "type": "string", - "description": "Host" - }, - "container": { - "type": "string", - "description": "Container" - }, - "provider": { - "type": "string", - "description": "Provider" - } - } - } - }, - "required": [ - "id" - ] - }, - "target": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Endpoint ID system ID or aws,azure,gcp,sgws,ibm" - }, - "metadata": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "Bucket name" - }, - "host": { - "type": "string", - "description": "Host" - }, - "container": { - "type": "string", - "description": "Container" - }, - "provider": { - "type": "string", - "description": "Provider" - } - } - } - }, - "required": [ - "id" - ] - } - } - } - } - } - } - } - } - } - } - } - }, - "/api/accounts/{accountId}/relationships/{id}/credentials": { - "put": { - "tags": [ - "Relationships" - ], - "description": "Modifies the source or target credentials.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "source": { - "type": "object", - "properties": { - "sftp": { - "type": "object", - "properties": { - "username": { - "type": "string", - "description": "UserName" - }, - "password": { - "type": "string", - "description": "Password" - } - } - }, - "cifs": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - }, - "s3": { - "type": "object", - "description": "S3 provider credentials", - "properties": { - "accessKey": { - "type": "string", - "description": "Access Key" - }, - "secretKey": { - "type": "string", - "description": "Secret Key" - } - }, - "required": [ - "accessKey", - "secretKey" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Credentials", - "properties": { - "storageAccountConnectionString": { - "type": "string", - "description": "Azure Blob Storage account Connection string ( for blob to blob copy should be SaS-Connection-String)" - } - } - }, - "box": { - "type": "object", - "properties": { - "clientSecret": { - "type": "string", - "description": "Client secret" - }, - "publicKeyId": { - "type": "string", - "description": "Public Key Id" - }, - "privateKey": { - "type": "string", - "description": "Private Key" - }, - "passphrase": { - "type": "string", - "description": "Passphrase" - } - }, - "required": [ - "clientSecret", - "publicKeyId", - "privateKey", - "passphrase" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "clientEmail": { - "type": "string", - "description": "Service Account email" - }, - "privateKey": { - "type": "string", - "description": "Private Key" - } - }, - "required": [ - "clientEmail", - "privateKey" - ] - } - } - }, - "target": { - "type": "object", - "properties": { - "sftp": { - "type": "object", - "properties": { - "username": { - "type": "string", - "description": "UserName" - }, - "password": { - "type": "string", - "description": "Password" - } - } - }, - "cifs": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - }, - "s3": { - "type": "object", - "description": "S3 provider credentials", - "properties": { - "accessKey": { - "type": "string", - "description": "Access Key" - }, - "secretKey": { - "type": "string", - "description": "Secret Key" - } - }, - "required": [ - "accessKey", - "secretKey" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Credentials", - "properties": { - "storageAccountConnectionString": { - "type": "string", - "description": "Azure Blob Storage account Connection string ( for blob to blob copy should be SaS-Connection-String)" - } - } - }, - "box": { - "type": "object", - "properties": { - "clientSecret": { - "type": "string", - "description": "Client secret" - }, - "publicKeyId": { - "type": "string", - "description": "Public Key Id" - }, - "privateKey": { - "type": "string", - "description": "Private Key" - }, - "passphrase": { - "type": "string", - "description": "Passphrase" - } - }, - "required": [ - "clientSecret", - "publicKeyId", - "privateKey", - "passphrase" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "clientEmail": { - "type": "string", - "description": "Service Account email" - }, - "privateKey": { - "type": "string", - "description": "Private Key" - } - }, - "required": [ - "clientEmail", - "privateKey" - ] - } - } - } - } - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Relationship ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "202": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/relationships/{id}/tags": { - "put": { - "tags": [ - "Relationships" - ], - "description": "Edits the relationship tags.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "add": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "remove": { - "type": "array", - "items": { - "type": "string", - "description": "Tags key to delete" - } - } - } - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Relationship ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response" - } - } - } - }, - "/api/storages/{protocol}": { - "get": { - "tags": [ - "Storages" - ], - "description": "Retrieves the storage type.", - "parameters": [ - { - "schema": { - "enum": [ - "nfs", - "sftp", - "cifs", - "azure", - "azure_data_lake", - "s3", - "gcp", - "box", - "sgws", - "ibm", - "efs", - "cvs", - "anf", - "ontap", - "cvo", - "onprem", - "gdrive" - ], - "type": "string" - }, - "in": "query", - "name": "provider", - "required": false, - "description": "Provider" - }, - { - "schema": { - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ], - "type": "string" - }, - "in": "path", - "name": "protocol", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "The Relationship internal ID", - "type": "string" - }, - "host": { - "description": "The host ip address or storage account for Azure or projectId for GCP", - "type": "string" - }, - "lastSeen": { - "description": "The last seen timestamp of the last action on this NFS", - "type": "number" - } - }, - "required": [ - "id", - "host" - ] - } - } - } - } - } - } - } - }, - "/api/accounts/{accountId}/reports": { - "post": { - "tags": [ - "Reports" - ], - "description": "Creates a new report.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "endpoint": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "description": "Endpoint protocol", - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ] - }, - "cifs": { - "type": "object", - "description": "CIFS Details", - "properties": { - "host": { - "type": "string", - "description": "CIFS host" - }, - "share": { - "type": "string", - "description": "CIFS share" - }, - "provider": { - "type": "string", - "description": "CIFS type", - "enum": [ - "cifs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx" - ] - }, - "path": { - "type": "string", - "description": "CIFS path" - }, - "version": { - "type": "string", - "description": "Supported CIFS versions", - "enum": [ - "1.0", - "2.0", - "2.1", - "3.0", - "3.11" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "credentials": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - } - }, - "required": [ - "host", - "share", - "provider" - ] - }, - "nfs": { - "type": "object", - "description": "NFS Details", - "properties": { - "host": { - "type": "string", - "description": "NFS host" - }, - "export": { - "type": "string", - "description": "NFS export" - }, - "provider": { - "type": "string", - "description": "NFS type", - "enum": [ - "nfs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx", - "efs" - ] - }, - "path": { - "type": "string", - "description": "NFS path" - }, - "version": { - "type": "string", - "description": "Supported NFS versions", - "enum": [ - "3", - "4.0", - "4.1", - "4.2" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "accessPoint": { - "type": "string", - "description": "EFS access point" - } - }, - "required": [ - "host", - "export", - "provider" - ] - }, - "s3": { - "type": "object", - "description": "S3 details", - "properties": { - "host": { - "type": "string", - "description": "SGWS or IBM or ONTAP host" - }, - "port": { - "type": "integer", - "description": "SGWS or IBM or ONTAP port" - }, - "bucket": { - "type": "string", - "description": "Bucket" - }, - "prefix": { - "type": "string", - "description": "Prefix" - }, - "region": { - "type": "string", - "description": "Bucket region" - }, - "encryption": { - "type": "object", - "description": "S3 encryption", - "properties": { - "protocol": { - "type": "string", - "description": "Encryption type", - "enum": [ - "kms", - "aes256" - ], - "default": "aes256" - }, - "keyId": { - "type": "string", - "description": "Encryption key arn in case it is kms encryption" - } - } - }, - "privateLinkDns": { - "type": "string", - "description": "AWS S3 Private Link DNS" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "S3 Storage Class", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_IR", - "DEEP_ARCHIVE", - "IA" - ] - }, - "provider": { - "type": "string", - "description": "Object Storage Type", - "enum": [ - "s3", - "alibaba", - "sgws", - "ibm", - "ontap" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID - for storageGrid system" - }, - "glacier": { - "type": "object", - "description": "Glacier storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Expedited", - "enum": [ - "Expedited", - "Standard", - "Bulk" - ], - "description": "Glacier retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "deepArchive": { - "type": "object", - "description": "Deep Archive storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Standard", - "enum": [ - "Standard", - "Bulk" - ], - "description": "Deep Archive retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "local": { - "type": "object", - "description": "Local object details", - "properties": { - "path": { - "type": "string", - "description": "Local Path" - } - }, - "required": [ - "path" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Details", - "required": [ - "container", - "provider" - ], - "properties": { - "container": { - "type": "string", - "description": "Azure Blob Storage container name" - }, - "storageAccountName": { - "type": "string", - "description": "Azure Blob Storage account name" - }, - "prefix": { - "type": "string", - "description": "Container blob prefix" - }, - "path": { - "type": "string", - "description": "Container path, used in azure data lake storage" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "blobTier": { - "type": "string", - "enum": [ - "HOT", - "COOL", - "ARCHIVE", - "COLD" - ], - "default": "HOT", - "description": "Blob tier type" - }, - "provider": { - "type": "string", - "description": "Azure type", - "enum": [ - "azure", - "azure_data_lake" - ], - "default": "azure" - } - } - }, - "gcp": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "GCP Bucket" - }, - "prefix": { - "type": "string", - "description": "GCP Bucket prefix" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "GCP Storage Class", - "enum": [ - "STANDARD", - "NEARLINE", - "COLDLINE", - "ARCHIVE" - ], - "default": "STANDARD" - }, - "kmsKeyName": { - "type": "string", - "description": "GCP Kms name" - }, - "provider": { - "type": "string", - "description": "GCP Type", - "enum": [ - "gcp" - ], - "default": "gcp" - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "driveId": { - "type": "string", - "description": "Drive Id" - }, - "driveName": { - "type": "string", - "description": "Drive Name" - }, - "folderId": { - "type": "string", - "description": "Google Drive folderId" - }, - "path": { - "type": "string", - "description": "Folder path" - }, - "provider": { - "type": "string", - "description": "Google Drive Type", - "enum": [ - "gdrive" - ], - "default": "gdrive" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "subject": { - "type": "string", - "description": "subject - user email" - } - }, - "required": [ - "driveId", - "provider", - "subject" - ] - }, - "sftp": { - "type": "object", - "properties": { - "host": { - "type": "string", - "description": "SFTP host" - }, - "port": { - "type": "integer", - "description": "SFTP port number" - }, - "path": { - "type": "string", - "description": "Directory path" - }, - "rootDirectory": { - "type": "string", - "description": "Root Directory path" - }, - "provider": { - "type": "string", - "description": "SFTP Type", - "enum": [ - "sftp" - ], - "default": "sftp" - } - }, - "required": [ - "host", - "port", - "rootDirectory", - "provider" - ] - }, - "box": { - "type": "object", - "properties": { - "rootDirectory": { - "type": "string", - "description": "Root Directory" - }, - "path": { - "type": "string", - "description": "path" - }, - "folderId": { - "type": "string", - "description": "Folder ID" - }, - "clientId": { - "type": "string", - "description": "Client ID" - }, - "appName": { - "type": "string", - "description": "Box Application Name" - }, - "enterpriseId": { - "type": "string", - "description": "Enterprise Id" - }, - "provider": { - "type": "string", - "description": "Box Type", - "enum": [ - "box" - ], - "default": "box" - } - }, - "required": [ - "folderId", - "provider", - "clientId" - ] - } - } - } - }, - "required": [ - "endpoint" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "202": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The Report internal ID" - }, - "endpoint": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "description": "Endpoint protocol", - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ] - }, - "cifs": { - "type": "object", - "description": "CIFS Details", - "properties": { - "host": { - "type": "string", - "description": "CIFS host" - }, - "share": { - "type": "string", - "description": "CIFS share" - }, - "provider": { - "type": "string", - "description": "CIFS type", - "enum": [ - "cifs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx" - ] - }, - "path": { - "type": "string", - "description": "CIFS path" - }, - "version": { - "type": "string", - "description": "Supported CIFS versions", - "enum": [ - "1.0", - "2.0", - "2.1", - "3.0", - "3.11" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "credentials": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - } - }, - "required": [ - "host", - "share", - "provider" - ] - }, - "nfs": { - "type": "object", - "description": "NFS Details", - "properties": { - "host": { - "type": "string", - "description": "NFS host" - }, - "export": { - "type": "string", - "description": "NFS export" - }, - "provider": { - "type": "string", - "description": "NFS type", - "enum": [ - "nfs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx", - "efs" - ] - }, - "path": { - "type": "string", - "description": "NFS path" - }, - "version": { - "type": "string", - "description": "Supported NFS versions", - "enum": [ - "3", - "4.0", - "4.1", - "4.2" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "accessPoint": { - "type": "string", - "description": "EFS access point" - } - }, - "required": [ - "host", - "export", - "provider" - ] - }, - "s3": { - "type": "object", - "description": "S3 details", - "properties": { - "host": { - "type": "string", - "description": "SGWS or IBM or ONTAP host" - }, - "port": { - "type": "integer", - "description": "SGWS or IBM or ONTAP port" - }, - "bucket": { - "type": "string", - "description": "Bucket" - }, - "prefix": { - "type": "string", - "description": "Prefix" - }, - "region": { - "type": "string", - "description": "Bucket region" - }, - "encryption": { - "type": "object", - "description": "S3 encryption", - "properties": { - "protocol": { - "type": "string", - "description": "Encryption type", - "enum": [ - "kms", - "aes256" - ], - "default": "aes256" - }, - "keyId": { - "type": "string", - "description": "Encryption key arn in case it is kms encryption" - } - } - }, - "privateLinkDns": { - "type": "string", - "description": "AWS S3 Private Link DNS" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "S3 Storage Class", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_IR", - "DEEP_ARCHIVE", - "IA" - ] - }, - "provider": { - "type": "string", - "description": "Object Storage Type", - "enum": [ - "s3", - "alibaba", - "sgws", - "ibm", - "ontap" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID - for storageGrid system" - }, - "glacier": { - "type": "object", - "description": "Glacier storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Expedited", - "enum": [ - "Expedited", - "Standard", - "Bulk" - ], - "description": "Glacier retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "deepArchive": { - "type": "object", - "description": "Deep Archive storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Standard", - "enum": [ - "Standard", - "Bulk" - ], - "description": "Deep Archive retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "local": { - "type": "object", - "description": "Local object details", - "properties": { - "path": { - "type": "string", - "description": "Local Path" - } - }, - "required": [ - "path" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Details", - "required": [ - "container", - "provider" - ], - "properties": { - "container": { - "type": "string", - "description": "Azure Blob Storage container name" - }, - "storageAccountName": { - "type": "string", - "description": "Azure Blob Storage account name" - }, - "prefix": { - "type": "string", - "description": "Container blob prefix" - }, - "path": { - "type": "string", - "description": "Container path, used in azure data lake storage" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "blobTier": { - "type": "string", - "enum": [ - "HOT", - "COOL", - "ARCHIVE", - "COLD" - ], - "default": "HOT", - "description": "Blob tier type" - }, - "provider": { - "type": "string", - "description": "Azure type", - "enum": [ - "azure", - "azure_data_lake" - ], - "default": "azure" - } - } - }, - "gcp": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "GCP Bucket" - }, - "prefix": { - "type": "string", - "description": "GCP Bucket prefix" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "GCP Storage Class", - "enum": [ - "STANDARD", - "NEARLINE", - "COLDLINE", - "ARCHIVE" - ], - "default": "STANDARD" - }, - "kmsKeyName": { - "type": "string", - "description": "GCP Kms name" - }, - "provider": { - "type": "string", - "description": "GCP Type", - "enum": [ - "gcp" - ], - "default": "gcp" - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "driveId": { - "type": "string", - "description": "Drive Id" - }, - "driveName": { - "type": "string", - "description": "Drive Name" - }, - "folderId": { - "type": "string", - "description": "Google Drive folderId" - }, - "path": { - "type": "string", - "description": "Folder path" - }, - "provider": { - "type": "string", - "description": "Google Drive Type", - "enum": [ - "gdrive" - ], - "default": "gdrive" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "subject": { - "type": "string", - "description": "subject - user email" - } - }, - "required": [ - "driveId", - "provider", - "subject" - ] - }, - "sftp": { - "type": "object", - "properties": { - "host": { - "type": "string", - "description": "SFTP host" - }, - "port": { - "type": "integer", - "description": "SFTP port number" - }, - "path": { - "type": "string", - "description": "Directory path" - }, - "rootDirectory": { - "type": "string", - "description": "Root Directory path" - }, - "provider": { - "type": "string", - "description": "SFTP Type", - "enum": [ - "sftp" - ], - "default": "sftp" - } - }, - "required": [ - "host", - "port", - "rootDirectory", - "provider" - ] - }, - "box": { - "type": "object", - "properties": { - "rootDirectory": { - "type": "string", - "description": "Root Directory" - }, - "path": { - "type": "string", - "description": "path" - }, - "folderId": { - "type": "string", - "description": "Folder ID" - }, - "clientId": { - "type": "string", - "description": "Client ID" - }, - "appName": { - "type": "string", - "description": "Box Application Name" - }, - "enterpriseId": { - "type": "string", - "description": "Enterprise Id" - }, - "provider": { - "type": "string", - "description": "Box Type", - "enum": [ - "box" - ], - "default": "box" - } - }, - "required": [ - "folderId", - "provider", - "clientId" - ] - } - } - }, - "statistics": { - "type": "object", - "description": "Statistics of the given endpoint", - "additionalProperties": true, - "properties": { - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "errorCode": { - "type": "string", - "description": "Error Code" - }, - "counter": { - "type": "number", - "description": "How many times this error code appeared" - }, - "description": { - "type": "string", - "description": "Error code description" - } - } - } - }, - "totals": { - "type": "object", - "additionalProperties": true, - "properties": { - "directories": { - "type": "number", - "description": "Number of directories" - }, - "files": { - "type": "number", - "description": "Number of files" - }, - "others": { - "type": "number", - "description": "Number of others" - }, - "objects": { - "type": "number", - "description": "Number of objects" - }, - "emptyObjects": { - "type": "number", - "description": "Number of empty objects" - }, - "size": { - "type": "number", - "description": "Total size" - }, - "failed": { - "type": "number", - "description": "Total failed objects" - } - } - } - } - }, - "status": { - "type": "string", - "description": "Reporter status" - }, - "startTime": { - "type": "string", - "description": "Start time" - }, - "endTime": { - "type": "string", - "description": "End time" - }, - "duration": { - "type": "number", - "description": "Total execution time of the reported" - }, - "reason": { - "type": "string", - "description": "Failure reason" - } - }, - "required": [ - "id", - "endpoint", - "statistics", - "status", - "startTime", - "duration" - ] - } - } - } - } - } - }, - "get": { - "tags": [ - "Reports" - ], - "description": "Retrieves a list of all reports.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The Report internal ID" - }, - "endpoint": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "description": "Endpoint protocol", - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ] - }, - "cifs": { - "type": "object", - "description": "CIFS Details", - "properties": { - "host": { - "type": "string", - "description": "CIFS host" - }, - "share": { - "type": "string", - "description": "CIFS share" - }, - "provider": { - "type": "string", - "description": "CIFS type", - "enum": [ - "cifs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx" - ] - }, - "path": { - "type": "string", - "description": "CIFS path" - }, - "version": { - "type": "string", - "description": "Supported CIFS versions", - "enum": [ - "1.0", - "2.0", - "2.1", - "3.0", - "3.11" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "credentials": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - } - }, - "required": [ - "host", - "share", - "provider" - ] - }, - "nfs": { - "type": "object", - "description": "NFS Details", - "properties": { - "host": { - "type": "string", - "description": "NFS host" - }, - "export": { - "type": "string", - "description": "NFS export" - }, - "provider": { - "type": "string", - "description": "NFS type", - "enum": [ - "nfs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx", - "efs" - ] - }, - "path": { - "type": "string", - "description": "NFS path" - }, - "version": { - "type": "string", - "description": "Supported NFS versions", - "enum": [ - "3", - "4.0", - "4.1", - "4.2" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "accessPoint": { - "type": "string", - "description": "EFS access point" - } - }, - "required": [ - "host", - "export", - "provider" - ] - }, - "s3": { - "type": "object", - "description": "S3 details", - "properties": { - "host": { - "type": "string", - "description": "SGWS or IBM or ONTAP host" - }, - "port": { - "type": "integer", - "description": "SGWS or IBM or ONTAP port" - }, - "bucket": { - "type": "string", - "description": "Bucket" - }, - "prefix": { - "type": "string", - "description": "Prefix" - }, - "region": { - "type": "string", - "description": "Bucket region" - }, - "encryption": { - "type": "object", - "description": "S3 encryption", - "properties": { - "protocol": { - "type": "string", - "description": "Encryption type", - "enum": [ - "kms", - "aes256" - ], - "default": "aes256" - }, - "keyId": { - "type": "string", - "description": "Encryption key arn in case it is kms encryption" - } - } - }, - "privateLinkDns": { - "type": "string", - "description": "AWS S3 Private Link DNS" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "S3 Storage Class", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_IR", - "DEEP_ARCHIVE", - "IA" - ] - }, - "provider": { - "type": "string", - "description": "Object Storage Type", - "enum": [ - "s3", - "alibaba", - "sgws", - "ibm", - "ontap" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID - for storageGrid system" - }, - "glacier": { - "type": "object", - "description": "Glacier storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Expedited", - "enum": [ - "Expedited", - "Standard", - "Bulk" - ], - "description": "Glacier retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "deepArchive": { - "type": "object", - "description": "Deep Archive storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Standard", - "enum": [ - "Standard", - "Bulk" - ], - "description": "Deep Archive retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "local": { - "type": "object", - "description": "Local object details", - "properties": { - "path": { - "type": "string", - "description": "Local Path" - } - }, - "required": [ - "path" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Details", - "required": [ - "container", - "provider" - ], - "properties": { - "container": { - "type": "string", - "description": "Azure Blob Storage container name" - }, - "storageAccountName": { - "type": "string", - "description": "Azure Blob Storage account name" - }, - "prefix": { - "type": "string", - "description": "Container blob prefix" - }, - "path": { - "type": "string", - "description": "Container path, used in azure data lake storage" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "blobTier": { - "type": "string", - "enum": [ - "HOT", - "COOL", - "ARCHIVE", - "COLD" - ], - "default": "HOT", - "description": "Blob tier type" - }, - "provider": { - "type": "string", - "description": "Azure type", - "enum": [ - "azure", - "azure_data_lake" - ], - "default": "azure" - } - } - }, - "gcp": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "GCP Bucket" - }, - "prefix": { - "type": "string", - "description": "GCP Bucket prefix" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "GCP Storage Class", - "enum": [ - "STANDARD", - "NEARLINE", - "COLDLINE", - "ARCHIVE" - ], - "default": "STANDARD" - }, - "kmsKeyName": { - "type": "string", - "description": "GCP Kms name" - }, - "provider": { - "type": "string", - "description": "GCP Type", - "enum": [ - "gcp" - ], - "default": "gcp" - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "driveId": { - "type": "string", - "description": "Drive Id" - }, - "driveName": { - "type": "string", - "description": "Drive Name" - }, - "folderId": { - "type": "string", - "description": "Google Drive folderId" - }, - "path": { - "type": "string", - "description": "Folder path" - }, - "provider": { - "type": "string", - "description": "Google Drive Type", - "enum": [ - "gdrive" - ], - "default": "gdrive" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "subject": { - "type": "string", - "description": "subject - user email" - } - }, - "required": [ - "driveId", - "provider", - "subject" - ] - }, - "sftp": { - "type": "object", - "properties": { - "host": { - "type": "string", - "description": "SFTP host" - }, - "port": { - "type": "integer", - "description": "SFTP port number" - }, - "path": { - "type": "string", - "description": "Directory path" - }, - "rootDirectory": { - "type": "string", - "description": "Root Directory path" - }, - "provider": { - "type": "string", - "description": "SFTP Type", - "enum": [ - "sftp" - ], - "default": "sftp" - } - }, - "required": [ - "host", - "port", - "rootDirectory", - "provider" - ] - }, - "box": { - "type": "object", - "properties": { - "rootDirectory": { - "type": "string", - "description": "Root Directory" - }, - "path": { - "type": "string", - "description": "path" - }, - "folderId": { - "type": "string", - "description": "Folder ID" - }, - "clientId": { - "type": "string", - "description": "Client ID" - }, - "appName": { - "type": "string", - "description": "Box Application Name" - }, - "enterpriseId": { - "type": "string", - "description": "Enterprise Id" - }, - "provider": { - "type": "string", - "description": "Box Type", - "enum": [ - "box" - ], - "default": "box" - } - }, - "required": [ - "folderId", - "provider", - "clientId" - ] - } - } - }, - "statistics": { - "type": "object", - "description": "Statistics of the given endpoint", - "additionalProperties": true, - "properties": { - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "errorCode": { - "type": "string", - "description": "Error Code" - }, - "counter": { - "type": "number", - "description": "How many times this error code appeared" - }, - "description": { - "type": "string", - "description": "Error code description" - } - } - } - }, - "totals": { - "type": "object", - "additionalProperties": true, - "properties": { - "directories": { - "type": "number", - "description": "Number of directories" - }, - "files": { - "type": "number", - "description": "Number of files" - }, - "others": { - "type": "number", - "description": "Number of others" - }, - "objects": { - "type": "number", - "description": "Number of objects" - }, - "emptyObjects": { - "type": "number", - "description": "Number of empty objects" - }, - "size": { - "type": "number", - "description": "Total size" - }, - "failed": { - "type": "number", - "description": "Total failed objects" - } - } - } - } - }, - "status": { - "type": "string", - "description": "Reporter status" - }, - "startTime": { - "type": "string", - "description": "Start time" - }, - "endTime": { - "type": "string", - "description": "End time" - }, - "duration": { - "type": "number", - "description": "Total execution time of the reported" - }, - "reason": { - "type": "string", - "description": "Failure reason" - } - }, - "required": [ - "id", - "endpoint", - "statistics", - "status", - "startTime", - "duration" - ] - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Reports" - ], - "description": "Deletes the reports by a specified report ID.", - "parameters": [ - { - "schema": { - "type": "array" - }, - "in": "query", - "name": "reports", - "required": true, - "description": "Reports IDs to delete" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response" - } - } - } - }, - "/api/accounts/{accountId}/reports/end-points": { - "get": { - "tags": [ - "Reports" - ], - "description": "Retrieves a list of the reports endpoints.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "description": "Endpoint creation date" - }, - "endpoint": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "description": "Endpoint protocol", - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ] - }, - "cifs": { - "type": "object", - "description": "CIFS Details", - "properties": { - "host": { - "type": "string", - "description": "CIFS host" - }, - "share": { - "type": "string", - "description": "CIFS share" - }, - "provider": { - "type": "string", - "description": "CIFS type", - "enum": [ - "cifs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx" - ] - }, - "path": { - "type": "string", - "description": "CIFS path" - }, - "version": { - "type": "string", - "description": "Supported CIFS versions", - "enum": [ - "1.0", - "2.0", - "2.1", - "3.0", - "3.11" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "credentials": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - } - }, - "required": [ - "host", - "share", - "provider" - ] - }, - "nfs": { - "type": "object", - "description": "NFS Details", - "properties": { - "host": { - "type": "string", - "description": "NFS host" - }, - "export": { - "type": "string", - "description": "NFS export" - }, - "provider": { - "type": "string", - "description": "NFS type", - "enum": [ - "nfs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx", - "efs" - ] - }, - "path": { - "type": "string", - "description": "NFS path" - }, - "version": { - "type": "string", - "description": "Supported NFS versions", - "enum": [ - "3", - "4.0", - "4.1", - "4.2" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "accessPoint": { - "type": "string", - "description": "EFS access point" - } - }, - "required": [ - "host", - "export", - "provider" - ] - }, - "s3": { - "type": "object", - "description": "S3 details", - "properties": { - "host": { - "type": "string", - "description": "SGWS or IBM or ONTAP host" - }, - "port": { - "type": "integer", - "description": "SGWS or IBM or ONTAP port" - }, - "bucket": { - "type": "string", - "description": "Bucket" - }, - "prefix": { - "type": "string", - "description": "Prefix" - }, - "region": { - "type": "string", - "description": "Bucket region" - }, - "encryption": { - "type": "object", - "description": "S3 encryption", - "properties": { - "protocol": { - "type": "string", - "description": "Encryption type", - "enum": [ - "kms", - "aes256" - ], - "default": "aes256" - }, - "keyId": { - "type": "string", - "description": "Encryption key arn in case it is kms encryption" - } - } - }, - "privateLinkDns": { - "type": "string", - "description": "AWS S3 Private Link DNS" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "S3 Storage Class", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_IR", - "DEEP_ARCHIVE", - "IA" - ] - }, - "provider": { - "type": "string", - "description": "Object Storage Type", - "enum": [ - "s3", - "alibaba", - "sgws", - "ibm", - "ontap" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID - for storageGrid system" - }, - "glacier": { - "type": "object", - "description": "Glacier storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Expedited", - "enum": [ - "Expedited", - "Standard", - "Bulk" - ], - "description": "Glacier retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "deepArchive": { - "type": "object", - "description": "Deep Archive storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Standard", - "enum": [ - "Standard", - "Bulk" - ], - "description": "Deep Archive retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "local": { - "type": "object", - "description": "Local object details", - "properties": { - "path": { - "type": "string", - "description": "Local Path" - } - }, - "required": [ - "path" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Details", - "required": [ - "container", - "provider" - ], - "properties": { - "container": { - "type": "string", - "description": "Azure Blob Storage container name" - }, - "storageAccountName": { - "type": "string", - "description": "Azure Blob Storage account name" - }, - "prefix": { - "type": "string", - "description": "Container blob prefix" - }, - "path": { - "type": "string", - "description": "Container path, used in azure data lake storage" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "blobTier": { - "type": "string", - "enum": [ - "HOT", - "COOL", - "ARCHIVE", - "COLD" - ], - "default": "HOT", - "description": "Blob tier type" - }, - "provider": { - "type": "string", - "description": "Azure type", - "enum": [ - "azure", - "azure_data_lake" - ], - "default": "azure" - } - } - }, - "gcp": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "GCP Bucket" - }, - "prefix": { - "type": "string", - "description": "GCP Bucket prefix" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "GCP Storage Class", - "enum": [ - "STANDARD", - "NEARLINE", - "COLDLINE", - "ARCHIVE" - ], - "default": "STANDARD" - }, - "kmsKeyName": { - "type": "string", - "description": "GCP Kms name" - }, - "provider": { - "type": "string", - "description": "GCP Type", - "enum": [ - "gcp" - ], - "default": "gcp" - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "driveId": { - "type": "string", - "description": "Drive Id" - }, - "driveName": { - "type": "string", - "description": "Drive Name" - }, - "folderId": { - "type": "string", - "description": "Google Drive folderId" - }, - "path": { - "type": "string", - "description": "Folder path" - }, - "provider": { - "type": "string", - "description": "Google Drive Type", - "enum": [ - "gdrive" - ], - "default": "gdrive" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "subject": { - "type": "string", - "description": "subject - user email" - } - }, - "required": [ - "driveId", - "provider", - "subject" - ] - }, - "sftp": { - "type": "object", - "properties": { - "host": { - "type": "string", - "description": "SFTP host" - }, - "port": { - "type": "integer", - "description": "SFTP port number" - }, - "path": { - "type": "string", - "description": "Directory path" - }, - "rootDirectory": { - "type": "string", - "description": "Root Directory path" - }, - "provider": { - "type": "string", - "description": "SFTP Type", - "enum": [ - "sftp" - ], - "default": "sftp" - } - }, - "required": [ - "host", - "port", - "rootDirectory", - "provider" - ] - }, - "box": { - "type": "object", - "properties": { - "rootDirectory": { - "type": "string", - "description": "Root Directory" - }, - "path": { - "type": "string", - "description": "path" - }, - "folderId": { - "type": "string", - "description": "Folder ID" - }, - "clientId": { - "type": "string", - "description": "Client ID" - }, - "appName": { - "type": "string", - "description": "Box Application Name" - }, - "enterpriseId": { - "type": "string", - "description": "Enterprise Id" - }, - "provider": { - "type": "string", - "description": "Box Type", - "enum": [ - "box" - ], - "default": "box" - } - }, - "required": [ - "folderId", - "provider", - "clientId" - ] - } - } - }, - "reports": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Report Id" - }, - "status": { - "type": "string", - "description": "Reporter status" - }, - "statistics": { - "type": "object", - "description": "Statistics of the given endpoint", - "additionalProperties": true, - "properties": { - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "errorCode": { - "type": "string", - "description": "Error Code" - }, - "counter": { - "type": "number", - "description": "How many times this error code appeared" - }, - "description": { - "type": "string", - "description": "Error code description" - } - } - } - }, - "totals": { - "type": "object", - "additionalProperties": true, - "properties": { - "directories": { - "type": "number", - "description": "Number of directories" - }, - "files": { - "type": "number", - "description": "Number of files" - }, - "others": { - "type": "number", - "description": "Number of others" - }, - "objects": { - "type": "number", - "description": "Number of objects" - }, - "emptyObjects": { - "type": "number", - "description": "Number of empty objects" - }, - "size": { - "type": "number", - "description": "Total size" - }, - "failed": { - "type": "number", - "description": "Total failed objects" - } - } - } - } - }, - "startTime": { - "type": "string", - "description": "Start time" - }, - "endTime": { - "type": "string", - "description": "End time" - }, - "reason": { - "type": "string", - "description": "Failure reason" - }, - "duration": { - "type": "number", - "description": "Total execution time of the reported" - } - } - } - }, - "relationshipIds": { - "type": "array", - "description": "relationship ids related to the endpoint", - "items": { - "type": "string" - } - } - }, - "required": [ - "endpoint", - "reports" - ] - } - } - } - } - } - } - } - }, - "/api/accounts/{accountId}/reports/{id}": { - "get": { - "tags": [ - "Reports" - ], - "description": "Retrieves a report by a specified ID.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true, - "description": "NetApp tenancy account ID" - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "id", - "required": true, - "description": "Report ID" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The Report internal ID" - }, - "endpoint": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "description": "Endpoint protocol", - "enum": [ - "nfs", - "cifs", - "s3", - "local", - "azure", - "gcp", - "sftp", - "box", - "gdrive" - ] - }, - "cifs": { - "type": "object", - "description": "CIFS Details", - "properties": { - "host": { - "type": "string", - "description": "CIFS host" - }, - "share": { - "type": "string", - "description": "CIFS share" - }, - "provider": { - "type": "string", - "description": "CIFS type", - "enum": [ - "cifs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx" - ] - }, - "path": { - "type": "string", - "description": "CIFS path" - }, - "version": { - "type": "string", - "description": "Supported CIFS versions", - "enum": [ - "1.0", - "2.0", - "2.1", - "3.0", - "3.11" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "credentials": { - "type": "object", - "description": "CIFS credentials", - "properties": { - "username": { - "type": "string", - "description": "User name" - }, - "password": { - "type": "string", - "description": "password" - }, - "domain": { - "type": "string", - "description": "Domain" - } - }, - "required": [ - "username", - "password" - ] - } - }, - "required": [ - "host", - "share", - "provider" - ] - }, - "nfs": { - "type": "object", - "description": "NFS Details", - "properties": { - "host": { - "type": "string", - "description": "NFS host" - }, - "export": { - "type": "string", - "description": "NFS export" - }, - "provider": { - "type": "string", - "description": "NFS type", - "enum": [ - "nfs", - "anf", - "cvs", - "cvo", - "onprem", - "fsx", - "efs" - ] - }, - "path": { - "type": "string", - "description": "NFS path" - }, - "version": { - "type": "string", - "description": "Supported NFS versions", - "enum": [ - "3", - "4.0", - "4.1", - "4.2" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID" - }, - "accessPoint": { - "type": "string", - "description": "EFS access point" - } - }, - "required": [ - "host", - "export", - "provider" - ] - }, - "s3": { - "type": "object", - "description": "S3 details", - "properties": { - "host": { - "type": "string", - "description": "SGWS or IBM or ONTAP host" - }, - "port": { - "type": "integer", - "description": "SGWS or IBM or ONTAP port" - }, - "bucket": { - "type": "string", - "description": "Bucket" - }, - "prefix": { - "type": "string", - "description": "Prefix" - }, - "region": { - "type": "string", - "description": "Bucket region" - }, - "encryption": { - "type": "object", - "description": "S3 encryption", - "properties": { - "protocol": { - "type": "string", - "description": "Encryption type", - "enum": [ - "kms", - "aes256" - ], - "default": "aes256" - }, - "keyId": { - "type": "string", - "description": "Encryption key arn in case it is kms encryption" - } - } - }, - "privateLinkDns": { - "type": "string", - "description": "AWS S3 Private Link DNS" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "S3 Storage Class", - "enum": [ - "STANDARD", - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER", - "GLACIER_IR", - "DEEP_ARCHIVE", - "IA" - ] - }, - "provider": { - "type": "string", - "description": "Object Storage Type", - "enum": [ - "s3", - "alibaba", - "sgws", - "ibm", - "ontap" - ] - }, - "workingEnvironmentId": { - "type": "string", - "description": "Relevant system ID - for storageGrid system" - }, - "glacier": { - "type": "object", - "description": "Glacier storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Expedited", - "enum": [ - "Expedited", - "Standard", - "Bulk" - ], - "description": "Glacier retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - }, - "deepArchive": { - "type": "object", - "description": "Deep Archive storage class restore information (available only for s3 as source endpoint)", - "properties": { - "days": { - "type": "number", - "default": 1, - "description": "Lifetime of the active copy in days" - }, - "tier": { - "type": "string", - "default": "Standard", - "enum": [ - "Standard", - "Bulk" - ], - "description": "Deep Archive retrieval tier at which the restore will be processed" - } - }, - "required": [ - "days", - "tier" - ] - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "local": { - "type": "object", - "description": "Local object details", - "properties": { - "path": { - "type": "string", - "description": "Local Path" - } - }, - "required": [ - "path" - ] - }, - "azure": { - "type": "object", - "description": "Azure Blob Storage Details", - "required": [ - "container", - "provider" - ], - "properties": { - "container": { - "type": "string", - "description": "Azure Blob Storage container name" - }, - "storageAccountName": { - "type": "string", - "description": "Azure Blob Storage account name" - }, - "prefix": { - "type": "string", - "description": "Container blob prefix" - }, - "path": { - "type": "string", - "description": "Container path, used in azure data lake storage" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "blobTier": { - "type": "string", - "enum": [ - "HOT", - "COOL", - "ARCHIVE", - "COLD" - ], - "default": "HOT", - "description": "Blob tier type" - }, - "provider": { - "type": "string", - "description": "Azure type", - "enum": [ - "azure", - "azure_data_lake" - ], - "default": "azure" - } - } - }, - "gcp": { - "type": "object", - "properties": { - "bucket": { - "type": "string", - "description": "GCP Bucket" - }, - "prefix": { - "type": "string", - "description": "GCP Bucket prefix" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "storageClass": { - "type": "string", - "description": "GCP Storage Class", - "enum": [ - "STANDARD", - "NEARLINE", - "COLDLINE", - "ARCHIVE" - ], - "default": "STANDARD" - }, - "kmsKeyName": { - "type": "string", - "description": "GCP Kms name" - }, - "provider": { - "type": "string", - "description": "GCP Type", - "enum": [ - "gcp" - ], - "default": "gcp" - } - }, - "required": [ - "bucket", - "provider" - ] - }, - "gdrive": { - "type": "object", - "properties": { - "driveId": { - "type": "string", - "description": "Drive Id" - }, - "driveName": { - "type": "string", - "description": "Drive Name" - }, - "folderId": { - "type": "string", - "description": "Google Drive folderId" - }, - "path": { - "type": "string", - "description": "Folder path" - }, - "provider": { - "type": "string", - "description": "Google Drive Type", - "enum": [ - "gdrive" - ], - "default": "gdrive" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Tag Key" - }, - "value": { - "type": "string", - "description": "Tag Value" - } - } - } - }, - "subject": { - "type": "string", - "description": "subject - user email" - } - }, - "required": [ - "driveId", - "provider", - "subject" - ] - }, - "sftp": { - "type": "object", - "properties": { - "host": { - "type": "string", - "description": "SFTP host" - }, - "port": { - "type": "integer", - "description": "SFTP port number" - }, - "path": { - "type": "string", - "description": "Directory path" - }, - "rootDirectory": { - "type": "string", - "description": "Root Directory path" - }, - "provider": { - "type": "string", - "description": "SFTP Type", - "enum": [ - "sftp" - ], - "default": "sftp" - } - }, - "required": [ - "host", - "port", - "rootDirectory", - "provider" - ] - }, - "box": { - "type": "object", - "properties": { - "rootDirectory": { - "type": "string", - "description": "Root Directory" - }, - "path": { - "type": "string", - "description": "path" - }, - "folderId": { - "type": "string", - "description": "Folder ID" - }, - "clientId": { - "type": "string", - "description": "Client ID" - }, - "appName": { - "type": "string", - "description": "Box Application Name" - }, - "enterpriseId": { - "type": "string", - "description": "Enterprise Id" - }, - "provider": { - "type": "string", - "description": "Box Type", - "enum": [ - "box" - ], - "default": "box" - } - }, - "required": [ - "folderId", - "provider", - "clientId" - ] - } - } - }, - "statistics": { - "type": "object", - "description": "Statistics of the given endpoint", - "additionalProperties": true, - "properties": { - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "errorCode": { - "type": "string", - "description": "Error Code" - }, - "counter": { - "type": "number", - "description": "How many times this error code appeared" - }, - "description": { - "type": "string", - "description": "Error code description" - } - } - } - }, - "totals": { - "type": "object", - "additionalProperties": true, - "properties": { - "directories": { - "type": "number", - "description": "Number of directories" - }, - "files": { - "type": "number", - "description": "Number of files" - }, - "others": { - "type": "number", - "description": "Number of others" - }, - "objects": { - "type": "number", - "description": "Number of objects" - }, - "emptyObjects": { - "type": "number", - "description": "Number of empty objects" - }, - "size": { - "type": "number", - "description": "Total size" - }, - "failed": { - "type": "number", - "description": "Total failed objects" - } - } - } - } - }, - "status": { - "type": "string", - "description": "Reporter status" - }, - "startTime": { - "type": "string", - "description": "Start time" - }, - "endTime": { - "type": "string", - "description": "End time" - }, - "duration": { - "type": "number", - "description": "Total execution time of the reported" - }, - "reason": { - "type": "string", - "description": "Failure reason" - } - }, - "required": [ - "id", - "endpoint", - "statistics", - "status", - "startTime", - "duration" - ] - } - } - } - } - } - } - }, - "/api/timelines": { - "get": { - "tags": [ - "Timelines" - ], - "description": "Retrieves timelines.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "x-account-id", - "required": false, - "description": "NetApp Tenancy Account ID" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "Default Response" - } - } - } - } - }, - "servers": [ - { - "url": "http://localhost:80" - } - ], - "security": [ - { - "http": [ - "scheme:bearer", - "bearerFormat:JWT" - ] - } - ], - "tags": [ - { - "name": "Accounts", - "description": "
Overview\nThe accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations.\nThe following actions can be performed with the accounts endpoints:\n
    \n
  • Retrieve account statistics information
    • \n
  • Add a BYOL license
    • \n
  • Retrieve a list of NSS credentials associated with an account
    • \n
  • Retrieve license information of an account
    • \n
  • Update subscription information (using the /register API call)
    • \n
\n
" - }, - { - "name": "Data Brokers", - "description": "
Overview\nThe data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers.\nThe following actions can be performed with the data brokers endpoints:\n
    \n
  • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
    • \n
  • Delete a data broker
    • \n
  • Restart a data broker
    • \n
  • Change a data broker's proxy configuration
    • \n
  • Move a data broker between groups
    • \n
  • Retrieve data broker's local configuration
    • \n
\n

There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
\nThe deprecated operations are as follows:

\n
    \n
  • List S3 buckets
    • \n
  • List CIFS shares
    • \n
  • List NFS exports
    • \n
  • List Azure containers
    • \n
  • List NFS export folders
    • \n
  • List CIFS share folders
    • \n
  • List S3 buckets folders
    • \n
  • List StorageGRID buckets
    • \n
  • List StorageGRID bucket folders
    • \n
  • List IBM buckets
    • \n
  • List IBM bucket folders
    • \n
  • List ONTAP S3 buckets
    • \n
  • List ONTAP S3 bucket folders
    • \n
  • List KMS keys
    • \n
  • List S3 private endpoints
    • \n
  • List Google buckets
    • \n
  • List Google bucket folders
    • \n
\n
" - }, - { - "name": "Groups", - "description": "
Overview\nThe groups endpoints provide information about the data broker groups in an account and enable you to manage the groups.\nThe following actions can be performed with the data broker groups endpoints:\n
    \n
  • Retrieve data broker group information (information on the group configuration and each data broker in the group)
    • \n
  • Download data broker group logs (download logs from each data broker in the group)
    • \n
  • Change data broker group configuration - control the number of processes and concurrency in the data brokers
    • \n
  • Delete a data broker group
    • \n
  • Use the data broker group to perform various asynchronous operations such as:
    • \n
  • List S3 buckets
    • \n
  • List NFS exports
    • \n
  • List SMB shares
    • \n
  • List SFTP directories
    • \n
  • List AWS KMS keys
    • \n
  • List StorageGRID buckets
    • \n
  • List IBM buckets
    • \n
  • List ONTAP S3 buckets
    • \n
  • List Azure storage account containers
    • \n
  • List Google drives
    • \n
  • List S3 private links
    • \n
\n
" - }, - { - "name": "Messages", - "description": "
Overview\nThe messages endpoint sends user information, received by performing asynchronous operations, such as listing an S3 bucket, listing shares, and listing exports, to a client.\n

The API call process involves the following steps:

\n
    \n
  1. Execute the API endpoint initially without using the “last” query parameter. The API response will include an ID field value.
    2. \n
  2. Subsequently, execute the API endpoint using the ID field value obtained after performing Step 1.
    3. \n
\n
" - }, - { - "name": "Relationships", - "description": "
Overview\nThe relationships endpoints provide information about the sync relationships between source and target destinations in an account and enable you to perform various operations to manage the sync relationships.\nThe following actions can be performed with the relationships endpoints:\n
    \n
  • Retrieve sync relationship information (including statistics)
    • \n
  • Create a sync relationship
    • \n
  • Delete a sync relationship
    • \n
  • Change sync relationship settings
    • \n
  • Start a new sync on a relationship
    • \n
  • Stop a sync operation
    • \n
  • Update relationship endpoint credentials
    • \n
  • Update relationship tags
    • \n
  • Retrieve the identifier of the sync relationship (without all other properties)
    • \n
\n
" - }, - { - "name": "Reports", - "description": "
Overview\nThe report endpoints enable you to view reports of NetApp Console account such as the number of directories and files in an account, the distribution of file size, the depth and breadth of the directories, and more. You can also create or delete a report by using the report endpoints.\nThe following actions can be performed with the report endpoints:\n
    \n
  • Retrieve reports (including statistics of an account)
    • \n
  • Create a report
    • \n
  • Delete a report
    • \n
  • Abort a report
    • \n
\n
" - }, - { - "name": "Storages", - "description": "
Overview\nThe storages endpoints provide information about the different source and target locations.\nThis API category displays only the endpoints that are part of a sync relationship in an account.\n

You can retrieve the following information by using the storages API endpoints:

\n
    \n
  • NFS hosts IP addresses
    • \n
  • SMB hosts IP addresses
    • \n
  • Azure storage accounts
    • \n
  • SFTP hosts IP addresses
    • \n
  • IBM hosts IP addresses
    • \n
  • StorageGRID hosts IP addresses
    • \n
  • Azure NetApp Files IP addresses
    • \n
  • Cloud Volumes ONTAP, On-premises, FSx Data LIF IP addresses
    • \n
  • ONTAP S3 endpoint IP addresses
    • \n
  • Amazon Elastic File System IP addresses
    • \n
  • Box app names
    • \n
  • Google drive subjects
    • \n
\n
" - }, - { - "name": "Timelines", - "description": "
Overview\nThe timelines endpoints provide information about historic operations in an account (for example, create a relationship, sync relationships, and abort a relationship).\nThe timelines API endpoints are deprecated; use the Audit service API to view your historic account-related operations.\n
" - } - ] -} \ No newline at end of file diff --git a/copysync/data_brokers_overview.adoc b/copysync/data_brokers_overview.adoc new file mode 100644 index 00000000..4a36bcb4 --- /dev/null +++ b/copysync/data_brokers_overview.adoc @@ -0,0 +1,44 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/data_brokers_overview.html' +summary: 'Data brokers endpoints in the NetApp Copy and Sync REST API' +--- + += Data brokers endpoints in the NetApp Copy and Sync REST API + + + +The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. +The following actions can be performed with the data brokers endpoints: + +* Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more) +* Delete a data broker +* Restart a data broker +* Change a data broker's proxy configuration +* Move a data broker between groups +* Retrieve data broker's local configuration + +There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more. + +The deprecated operations are as follows: + +* List S3 buckets +* List CIFS shares +* List NFS exports +* List Azure containers +* List NFS export folders +* List CIFS share folders +* List S3 buckets folders +* List StorageGRID buckets +* List StorageGRID bucket folders +* List IBM buckets +* List IBM bucket folders +* List ONTAP S3 buckets +* List ONTAP S3 bucket folders +* List KMS keys +* List S3 private endpoints +* List Google buckets +* List Google bucket folders + + diff --git a/copysync/delete-api-accounts-groups-.adoc b/copysync/delete-api-accounts-groups-.adoc new file mode 100644 index 00000000..5d5f7cfb --- /dev/null +++ b/copysync/delete-api-accounts-groups-.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/delete-api-accounts-groups-.html' +summary: 'Delete a data broker group' +--- + += Delete a data broker group + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}`# + + + +Deletes a data broker group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/delete-api-accounts-licenses-v2-.adoc b/copysync/delete-api-accounts-licenses-v2-.adoc new file mode 100644 index 00000000..254be889 --- /dev/null +++ b/copysync/delete-api-accounts-licenses-v2-.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/delete-api-accounts-licenses-v2-.html' +summary: 'Delete a license serial number' +--- + += Delete a license serial number + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/api/accounts/{accountId}/licenses-v2/{serialNumber}`# + + + +Deletes a license serial number. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|serialNumber +|string +|path +|True +a|License Serial Number + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/delete-api-accounts-reports.adoc b/copysync/delete-api-accounts-reports.adoc new file mode 100644 index 00000000..b6143f75 --- /dev/null +++ b/copysync/delete-api-accounts-reports.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/delete-api-accounts-reports.html' +summary: 'Delete the reports by a specified report ID' +--- + += Delete the reports by a specified report ID + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/api/accounts/{accountId}/reports`# + + + +Deletes the reports by a specified report ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|reports +|array[] +|query +|True +a|Reports IDs to delete + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/delete-api-accounts.adoc b/copysync/delete-api-accounts.adoc new file mode 100644 index 00000000..89b75c19 --- /dev/null +++ b/copysync/delete-api-accounts.adoc @@ -0,0 +1,42 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/delete-api-accounts.html' +summary: 'Delete the current account' +--- + += Delete the current account + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/api/accounts`# + + + +Deletes the current account. WARNING: This action will delete the current account from the Copy and Sync API. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/delete-api-data-brokers-.adoc b/copysync/delete-api-data-brokers-.adoc new file mode 100644 index 00000000..cc92b0a6 --- /dev/null +++ b/copysync/delete-api-data-brokers-.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/delete-api-data-brokers-.html' +summary: 'Delete an existing NetApp data broker' +--- + += Delete an existing NetApp data broker + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/api/data-brokers/{id}`# + + + +Deletes an existing NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/delete-api-relationships-.adoc b/copysync/delete-api-relationships-.adoc new file mode 100644 index 00000000..16f8a389 --- /dev/null +++ b/copysync/delete-api-relationships-.adoc @@ -0,0 +1,52 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/delete-api-relationships-.html' +summary: 'Delete an existing relationship' +--- + += Delete an existing relationship + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/api/relationships/{id}`# + + + +Deletes an existing relationship. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|id +|string +|path +|True +a|Relationship ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/delete-api-v2-accounts-nss-credentials-v2-.adoc b/copysync/delete-api-v2-accounts-nss-credentials-v2-.adoc new file mode 100644 index 00000000..524169a0 --- /dev/null +++ b/copysync/delete-api-v2-accounts-nss-credentials-v2-.adoc @@ -0,0 +1,52 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/delete-api-v2-accounts-nss-credentials-v2-.html' +summary: 'Delete NetApp support site credentials' +--- + += Delete NetApp support site credentials + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/api/v2/accounts/{accountId}/nss-credentials/v2/{nssKeyId}`# + + + +Deletes the NetApp Support Site credentials. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|nssKeyId +|string +|path +|True +a|NSS key ID + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/delete-api-v2-accounts-relationships.adoc b/copysync/delete-api-v2-accounts-relationships.adoc new file mode 100644 index 00000000..778c95d7 --- /dev/null +++ b/copysync/delete-api-v2-accounts-relationships.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/delete-api-v2-accounts-relationships.html' +summary: 'Delete relationships' +--- + += Delete relationships + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/api/v2/accounts/{accountId}/relationships`# + + + +Deletes relationships. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|relationships +|array[] +|query +|True +a|Relationship IDs to delete + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 204, Default Response +``` + diff --git a/copysync/get-api-accounts-data-brokers-list-s3-private-links.adoc b/copysync/get-api-accounts-data-brokers-list-s3-private-links.adoc new file mode 100644 index 00000000..011218af --- /dev/null +++ b/copysync/get-api-accounts-data-brokers-list-s3-private-links.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-data-brokers-list-s3-private-links.html' +summary: 'Retrieve the S3 private links' +--- + += Retrieve the S3 private links + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/data-brokers/{id}/list-s3-private-links`# + + + +Retrieves the S3 private links. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|True +a|AWS region + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-bucket-name +|string +|header +|False +a|S3 bucket- for UI use + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-data-brokers-local-configuration.adoc b/copysync/get-api-accounts-data-brokers-local-configuration.adoc new file mode 100644 index 00000000..39117966 --- /dev/null +++ b/copysync/get-api-accounts-data-brokers-local-configuration.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-data-brokers-local-configuration.html' +summary: 'Retrieve the data broker local configuration' +--- + += Retrieve the data broker local configuration + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/data-brokers/{id}/local-configuration`# + + + +Retrieves the data broker local configuration. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Broker ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-alibaba-bucket-folders.adoc b/copysync/get-api-accounts-groups-list-alibaba-bucket-folders.adoc new file mode 100644 index 00000000..6b6e77da --- /dev/null +++ b/copysync/get-api-accounts-groups-list-alibaba-bucket-folders.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-alibaba-bucket-folders.html' +summary: 'Retrieve the Alibaba bucket folders' +--- + += Retrieve the Alibaba bucket folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-alibaba-bucket-folders`# + + + +Retrieves the Alibaba bucket folders from a data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|bucket +|string +|query +|True +a|Bucket + + +|prefix +|string +|query +|False +a|Path inside the container, to list folders in + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-alibaba-buckets.adoc b/copysync/get-api-accounts-groups-list-alibaba-buckets.adoc new file mode 100644 index 00000000..545dc7fd --- /dev/null +++ b/copysync/get-api-accounts-groups-list-alibaba-buckets.adoc @@ -0,0 +1,63 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-alibaba-buckets.html' +summary: 'Retrieve the Alibaba buckets' +--- + += Retrieve the Alibaba buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-alibaba-buckets`# + + + +Retrieves the Alibaba buckets accessible from a data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-aws-kms-keys.adoc b/copysync/get-api-accounts-groups-list-aws-kms-keys.adoc new file mode 100644 index 00000000..80a45e2f --- /dev/null +++ b/copysync/get-api-accounts-groups-list-aws-kms-keys.adoc @@ -0,0 +1,56 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-aws-kms-keys.html' +summary: 'Retrieve the AWS KMS keys' +--- + += Retrieve the AWS KMS keys + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-aws-kms-keys`# + + + +Retrieves the AWS KMS keys from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|bucket +|string +|query +|True +a|Bucket + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-azure-blob-storage-container-folders.adoc b/copysync/get-api-accounts-groups-list-azure-blob-storage-container-folders.adoc new file mode 100644 index 00000000..102aeb3d --- /dev/null +++ b/copysync/get-api-accounts-groups-list-azure-blob-storage-container-folders.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-azure-blob-storage-container-folders.html' +summary: 'Retrieve the Azure blob storage container folders' +--- + += Retrieve the Azure blob storage container folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-azure-blob-storage-container-folders`# + + + +Retrieves the Azure blob storage container folders. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|storageAccountName +|string +|query +|True +a|Azure storage account name + + +|container +|string +|query +|True +a|Container + + +|prefix +|string +|query +|False +a|Path inside the container, to list folders in + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|storage-account-connection-string +|string +|header +|True +a|Azure storage account connection-string + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-azure-blob-storage-containers.adoc b/copysync/get-api-accounts-groups-list-azure-blob-storage-containers.adoc new file mode 100644 index 00000000..1e34db1c --- /dev/null +++ b/copysync/get-api-accounts-groups-list-azure-blob-storage-containers.adoc @@ -0,0 +1,63 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-azure-blob-storage-containers.html' +summary: 'Retrieve the Azure blob storage containers' +--- + += Retrieve the Azure blob storage containers + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-azure-blob-storage-containers`# + + + +Retrieves the Azure blob storage containers. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|storageAccountName +|string +|query +|True +a|Azure storage account name + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|storage-account-connection-string +|string +|header +|True +a|Azure storage account connection-string + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-azure-datalake-storage-container-folders.adoc b/copysync/get-api-accounts-groups-list-azure-datalake-storage-container-folders.adoc new file mode 100644 index 00000000..519acfe8 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-azure-datalake-storage-container-folders.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-azure-datalake-storage-container-folders.html' +summary: 'Retrieve the Azure Data Lake Gen2 storage container folders' +--- + += Retrieve the Azure Data Lake Gen2 storage container folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-azure-dataLake-storage-container-folders`# + + + +Retrieves the Azure Data Lake Gen2 storage container folders. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|storageAccountName +|string +|query +|True +a|Azure storage account name + + +|container +|string +|query +|True +a|Container + + +|path +|string +|query +|False +a|Path inside the container, to list folders in + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|storage-account-connection-string +|string +|header +|True +a|Azure storage account connection-string + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-azure-datalake-storage-containers.adoc b/copysync/get-api-accounts-groups-list-azure-datalake-storage-containers.adoc new file mode 100644 index 00000000..3e6da229 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-azure-datalake-storage-containers.adoc @@ -0,0 +1,63 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-azure-datalake-storage-containers.html' +summary: 'Retrieve the Azure Data Lake Gen2 storage containers' +--- + += Retrieve the Azure Data Lake Gen2 storage containers + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-azure-dataLake-storage-containers`# + + + +Retrieves the Azure Data Lake Gen2 storage containers. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|storageAccountName +|string +|query +|True +a|Azure storage account name + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|storage-account-connection-string +|string +|header +|True +a|Azure storage account connection-string + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-box-folders.adoc b/copysync/get-api-accounts-groups-list-box-folders.adoc new file mode 100644 index 00000000..82ff0161 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-box-folders.adoc @@ -0,0 +1,112 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-box-folders.html' +summary: 'Retrieve the Box API server folders' +--- + += Retrieve the Box API server folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-box-folders`# + + + +Retrieves the Box API server folders from a NetApp data broker group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|clientId +|string +|query +|True +a|Box clientID + + +|enterpriseId +|string +|query +|True +a|Box enterpriseID + + +|folderId +|string +|query +|True +a|BOX parent folder ID + + +|folderName +|string +|query +|False +a|BOX parent folder name + + +|appName +|string +|query +|False +a|Box appName + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|client-secret +|string +|header +|True +a|Box clientSecret + + +|public-key-id +|string +|header +|True +a|Box publicKeyID + + +|private-key +|string +|header +|True +a|Box privateKey + + +|passphrase +|string +|header +|True +a|Box passphrase + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-box-root-folder.adoc b/copysync/get-api-accounts-groups-list-box-root-folder.adoc new file mode 100644 index 00000000..92ec7d7a --- /dev/null +++ b/copysync/get-api-accounts-groups-list-box-root-folder.adoc @@ -0,0 +1,98 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-box-root-folder.html' +summary: 'Retrieve the Box API root folder' +--- + += Retrieve the Box API root folder + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-box-root-folder`# + + + +Retrieves the Box API root folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|clientId +|string +|query +|True +a|Box clientID + + +|enterpriseId +|string +|query +|True +a|Box enterpriseID + + +|appName +|string +|query +|False +a|Box appName + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|client-secret +|string +|header +|True +a|Box clientSecret + + +|public-key-id +|string +|header +|True +a|Box publicKeyID + + +|private-key +|string +|header +|True +a|Box privateKey + + +|passphrase +|string +|header +|True +a|Box passphrase + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-cifs-share-folders.adoc b/copysync/get-api-accounts-groups-list-cifs-share-folders.adoc new file mode 100644 index 00000000..f387401c --- /dev/null +++ b/copysync/get-api-accounts-groups-list-cifs-share-folders.adoc @@ -0,0 +1,98 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-cifs-share-folders.html' +summary: 'Retrieve the CIFS server folders' +--- + += Retrieve the CIFS server folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-cifs-share-folders`# + + + +Retrieves the CIFS server folders from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|CIFS server hostname or IP + + +|version +|string +|query +|False +a|CIFS version + + +|path +|string +|query +|False +a|CIFS server share path + + +|share +|string +|query +|True +a|Cifs share + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|username +|string +|header +|True +a|CIFS server username + + +|password +|string +|header +|True +a|CIFS server password + + +|domain +|string +|header +|False +a|CIFS server domain + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-cifs-shares.adoc b/copysync/get-api-accounts-groups-list-cifs-shares.adoc new file mode 100644 index 00000000..1be6533c --- /dev/null +++ b/copysync/get-api-accounts-groups-list-cifs-shares.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-cifs-shares.html' +summary: 'Retrieve the CIFS shares' +--- + += Retrieve the CIFS shares + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-cifs-shares`# + + + +Retrieves the CIFS shares accessible from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|CIFS server hostname or IP + + +|version +|string +|query +|False +a|CIFS version + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|username +|string +|header +|True +a|CIFS server username + + +|password +|string +|header +|True +a|CIFS server password + + +|domain +|string +|header +|False +a|CIFS server domain + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-gcp-bucket-folders.adoc b/copysync/get-api-accounts-groups-list-gcp-bucket-folders.adoc new file mode 100644 index 00000000..58accf67 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-gcp-bucket-folders.adoc @@ -0,0 +1,63 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-gcp-bucket-folders.html' +summary: 'Retrieve the Google Cloud bucket folders' +--- + += Retrieve the Google Cloud bucket folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-gcp-bucket-folders`# + + + +Retrieves the Google Cloud bucket folders from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|bucket +|string +|query +|True +a|Bucket + + +|prefix +|string +|query +|False +a|Path inside the container, to list folders in + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-gcp-buckets.adoc b/copysync/get-api-accounts-groups-list-gcp-buckets.adoc new file mode 100644 index 00000000..23688702 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-gcp-buckets.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-gcp-buckets.html' +summary: 'Retrieve the Google Cloud buckets' +--- + += Retrieve the Google Cloud buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-gcp-buckets`# + + + +Retrieves the Google Cloud buckets accessible from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-gcp-kms-keys.adoc b/copysync/get-api-accounts-groups-list-gcp-kms-keys.adoc new file mode 100644 index 00000000..d7d67744 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-gcp-kms-keys.adoc @@ -0,0 +1,56 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-gcp-kms-keys.html' +summary: 'Retrieve the Google Cloud KMS keys' +--- + += Retrieve the Google Cloud KMS keys + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-gcp-kms-keys`# + + + +Retrieves the Google Cloud KMS keys accessible from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|bucket +|string +|query +|True +a|Bucket + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-google-drive-folders.adoc b/copysync/get-api-accounts-groups-list-google-drive-folders.adoc new file mode 100644 index 00000000..64990d7f --- /dev/null +++ b/copysync/get-api-accounts-groups-list-google-drive-folders.adoc @@ -0,0 +1,91 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-google-drive-folders.html' +summary: 'Retrieve the Google Drive folders' +--- + += Retrieve the Google Drive folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-google-drive-folders`# + + + +Retrieves the Google Drive folders. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|driveId +|string +|query +|True +a|Google Drive ID + + +|folderId +|string +|query +|False +a|Folder ID + + +|folderName +|string +|query +|False +a|Path inside the container, to list folders in + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|private-key +|string +|header +|True +a|Google Drive service account private key + + +|client-email +|string +|header +|True +a|Google Drive service account client email + + +|subject +|string +|header +|True +a|Google Drive user email + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-google-drives.adoc b/copysync/get-api-accounts-groups-list-google-drives.adoc new file mode 100644 index 00000000..9f5aedee --- /dev/null +++ b/copysync/get-api-accounts-groups-list-google-drives.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-google-drives.html' +summary: 'Retrieve the Google Drives' +--- + += Retrieve the Google Drives + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-google-drives`# + + + +Retrieves the Google drives objects. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|private-key +|string +|header +|True +a|Google Drive service account private key + + +|client-email +|string +|header +|True +a|Google Drive service account client email + + +|subject +|string +|header +|True +a|Google Drive user email + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-ibm-bucket-folders.adoc b/copysync/get-api-accounts-groups-list-ibm-bucket-folders.adoc new file mode 100644 index 00000000..9cfadee1 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-ibm-bucket-folders.adoc @@ -0,0 +1,91 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-ibm-bucket-folders.html' +summary: 'Retrieve the IBM bucket folders' +--- + += Retrieve the IBM bucket folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-ibm-bucket-folders`# + + + +Retrieves the IBM bucket folders from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|Server hostname or IP + + +|port +|number +|query +|False +a|Server port + + +|bucket +|string +|query +|True +a|Bucket + + +|prefix +|string +|query +|False +a|Prefix + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-ibm-buckets.adoc b/copysync/get-api-accounts-groups-list-ibm-buckets.adoc new file mode 100644 index 00000000..be2be713 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-ibm-buckets.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-ibm-buckets.html' +summary: 'Retrieve the IBM buckets' +--- + += Retrieve the IBM buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-ibm-buckets`# + + + +Retrieves the IBM buckets accessible from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|Server hostname or IP + + +|port +|number +|query +|True +a|Server port + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-nfs-export-folders.adoc b/copysync/get-api-accounts-groups-list-nfs-export-folders.adoc new file mode 100644 index 00000000..535c9c23 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-nfs-export-folders.adoc @@ -0,0 +1,91 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-nfs-export-folders.html' +summary: 'Retrieve the NFS server folders' +--- + += Retrieve the NFS server folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-nfs-export-folders`# + + + +Retrieves the NFS server folders from a data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|NFS server hostname or IP + + +|exportName +|string +|query +|True +a|NFS server export + + +|isEFS +|boolean +|query +|False +a|Indicates if the is target EFS + + +|version +|string +|query +|False +a|NFS version supported versions 3, 4.0, 4.1, 4.2 + + +|accessPoint +|string +|query +|False +a|EFS access point + + +|path +|string +|query +|False +a|NFS Export path + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-nfs-exports.adoc b/copysync/get-api-accounts-groups-list-nfs-exports.adoc new file mode 100644 index 00000000..fc556231 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-nfs-exports.adoc @@ -0,0 +1,63 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-nfs-exports.html' +summary: 'Retrieve the NFS server exports' +--- + += Retrieve the NFS server exports + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-nfs-exports`# + + + +Retrieves the NFS server exports from a data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|NFS server hostname or IP + + +|isEFS +|boolean +|query +|False +a|Indicates if the is target EFS + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-ontap-s3-bucket-folders.adoc b/copysync/get-api-accounts-groups-list-ontap-s3-bucket-folders.adoc new file mode 100644 index 00000000..51621573 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-ontap-s3-bucket-folders.adoc @@ -0,0 +1,91 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-ontap-s3-bucket-folders.html' +summary: 'Retrieve the ONTAP S3 bucket folders' +--- + += Retrieve the ONTAP S3 bucket folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-ontap-s3-bucket-folders`# + + + +Retrieves the ONTAP S3 bucket folders from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|ONTAP S3 hostname or IP + + +|port +|number +|query +|False +a|Server port + + +|bucket +|string +|query +|True +a|Bucket + + +|prefix +|string +|query +|False +a|Path inside the bucket, to list folders in + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-ontap-s3-buckets.adoc b/copysync/get-api-accounts-groups-list-ontap-s3-buckets.adoc new file mode 100644 index 00000000..bc11cd4a --- /dev/null +++ b/copysync/get-api-accounts-groups-list-ontap-s3-buckets.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-ontap-s3-buckets.html' +summary: 'Retrieve the ONTAP S3 buckets' +--- + += Retrieve the ONTAP S3 buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-ontap-s3-buckets`# + + + +Retrieves the ONTAP S3 buckets accessible from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|ONTAP S3 hostname or IP + + +|port +|number +|query +|False +a|Server port + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-s3-bucket-folders.adoc b/copysync/get-api-accounts-groups-list-s3-bucket-folders.adoc new file mode 100644 index 00000000..1b90c2a1 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-s3-bucket-folders.adoc @@ -0,0 +1,63 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-s3-bucket-folders.html' +summary: 'Retrieve the S3 bucket folders' +--- + += Retrieve the S3 bucket folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-s3-bucket-folders`# + + + +Retrieves the S3 bucket folders from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|bucket +|string +|query +|True +a|Bucket + + +|prefix +|string +|query +|False +a|Path inside the container, to list folders in + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-s3-buckets.adoc b/copysync/get-api-accounts-groups-list-s3-buckets.adoc new file mode 100644 index 00000000..7d5aa3e1 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-s3-buckets.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-s3-buckets.html' +summary: 'Retrieve the S3 buckets' +--- + += Retrieve the S3 buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-s3-buckets`# + + + +Retrieves the S3 buckets accessible from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-s3-private-links.adoc b/copysync/get-api-accounts-groups-list-s3-private-links.adoc new file mode 100644 index 00000000..adeccc49 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-s3-private-links.adoc @@ -0,0 +1,63 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-s3-private-links.html' +summary: 'Retrieve the S3 private links' +--- + += Retrieve the S3 private links + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-s3-private-links`# + + + +Retrieves the S3 private links. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|True +a|AWS region + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|x-bucket-name +|string +|header +|False +a|S3 bucket- for UI use + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-sftp-directories.adoc b/copysync/get-api-accounts-groups-list-sftp-directories.adoc new file mode 100644 index 00000000..17c82fa7 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-sftp-directories.adoc @@ -0,0 +1,91 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-sftp-directories.html' +summary: 'Retrieve the SFTP server folders' +--- + += Retrieve the SFTP server folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-sftp-directories`# + + + +Retrieves the SFTP server folders from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|SFTP server hostname or IP + + +|port +|number +|query +|True +a|SFTP server port + + +|rootDirectory +|string +|query +|True +a|SFTP server root directory path + + +|path +|string +|query +|False +a|SFTP server root directory path + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|username +|string +|header +|True +a|SFTP server username + + +|password +|string +|header +|True +a|SFTP server password + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-sftp-root-directory.adoc b/copysync/get-api-accounts-groups-list-sftp-root-directory.adoc new file mode 100644 index 00000000..61bb7eb3 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-sftp-root-directory.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-sftp-root-directory.html' +summary: 'Retrieve the SFTP root directory' +--- + += Retrieve the SFTP root directory + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-sftp-root-directory`# + + + +Retrieves the SFTP root directory. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|SFTP server hostname or IP + + +|port +|number +|query +|True +a|SFTP server port + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|username +|string +|header +|True +a|SFTP server username + + +|password +|string +|header +|True +a|SFTP server password + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-sgws-bucket-folders.adoc b/copysync/get-api-accounts-groups-list-sgws-bucket-folders.adoc new file mode 100644 index 00000000..61cd1c62 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-sgws-bucket-folders.adoc @@ -0,0 +1,91 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-sgws-bucket-folders.html' +summary: 'Retrieve the StorageGRID bucket folders' +--- + += Retrieve the StorageGRID bucket folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-sgws-bucket-folders`# + + + +Retrieves the StorageGRID bucket folders from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|Server hostname or IP + + +|port +|number +|query +|False +a|Server port + + +|bucket +|string +|query +|True +a|Bucket + + +|prefix +|string +|query +|False +a|Prefix + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-groups-list-sgws-buckets.adoc b/copysync/get-api-accounts-groups-list-sgws-buckets.adoc new file mode 100644 index 00000000..5de41379 --- /dev/null +++ b/copysync/get-api-accounts-groups-list-sgws-buckets.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-groups-list-sgws-buckets.html' +summary: 'Retrieve the StorageGRID buckets' +--- + += Retrieve the StorageGRID buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/list-sgws-buckets`# + + + +Retrieves the StorageGRID buckets accessible from a NetApp data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|Server hostname or IP + + +|port +|number +|query +|True +a|Server port + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-accounts-info.adoc b/copysync/get-api-accounts-info.adoc new file mode 100644 index 00000000..b70bee9e --- /dev/null +++ b/copysync/get-api-accounts-info.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-info.html' +summary: 'Retrieve the account information' +--- + += Retrieve the account information + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/info`# + + + +Retrieves the account information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|noCreate +|boolean +|query +|False +a|Don't create the requested account if it doesn't already exist + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|True +a|The logged in account's tenancy ID + + +|name +|string +|True +a|The logged in account's name as retrieved from the OAuth provider + + +|noCharge +|boolean +|True +a|Indicates whether all the relationships are Azure NetApp Files + + +|daysLeftForTrial +|number +|True +a|Days left for a free trial or (-1) if the trial has already expired + + +|subscriptionType +|string +|True +a|Subscription type + + +|subscriptionStatus +|string +|True +a|The account's AWS marketplace subscription status + + +|subscriptionProvider +|string +|True +a|SaaS subscription type + + +|=== + + diff --git a/copysync/get-api-accounts-license-settings.adoc b/copysync/get-api-accounts-license-settings.adoc new file mode 100644 index 00000000..b02b7a64 --- /dev/null +++ b/copysync/get-api-accounts-license-settings.adoc @@ -0,0 +1,83 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-license-settings.html' +summary: 'Retrieve license settings' +--- + += Retrieve license settings + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/license-settings`# + + + +Retrieves the license settings. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|freeTrial +|boolean +|True +a|If it is on free trial period + + +|existingRelationships +|number +|True +a|The number of the existing relationships + + +|reservedRelationships +|number +|True +a|The number of the BYOL relationships used + + +|totalReservedRelationships +|number +|True +a|The total number of the BYOL relationships available + + +|chargedRelationships +|number +|True +a|The number of the charged relationships + + +|=== + + diff --git a/copysync/get-api-accounts-licenses.adoc b/copysync/get-api-accounts-licenses.adoc new file mode 100644 index 00000000..121f3c3a --- /dev/null +++ b/copysync/get-api-accounts-licenses.adoc @@ -0,0 +1,110 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-licenses.html' +summary: 'Retrieve a list of all licenses' +--- + += Retrieve a list of all licenses + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/licenses`# + + + +Retrieves a list of all licenses. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenses +|array[link:#licenses[licenses]] +|True +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licenses": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#licenses] +[.api-collapsible-fifth-title] +licenses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serialNumber +|string +|True +a|The license's serial number + + +|reservedRelationships +|number +|True +a|The reserved relationships + + +|expirationDate +|number +|True +a|The license expiration date + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/copysync/get-api-accounts-relationships-end-points.adoc b/copysync/get-api-accounts-relationships-end-points.adoc new file mode 100644 index 00000000..872292e2 --- /dev/null +++ b/copysync/get-api-accounts-relationships-end-points.adoc @@ -0,0 +1,209 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-relationships-end-points.html' +summary: 'Retrieve the relationship endpoints' +--- + += Retrieve the relationship endpoints + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/relationships/end-points`# + + + +Retrieves the relationship endpoints. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|relationships +|array[link:#relationships[relationships]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "relationships": [ + { + "source": { + "id": "string", + "metadata": { + "bucket": "string", + "host": "string", + "container": "string", + "provider": "string" + } + }, + "target": { + "id": "string", + "metadata": { + "bucket": "string", + "host": "string", + "container": "string", + "provider": "string" + } + } + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#metadata] +[.api-collapsible-fifth-title] +metadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|bucket +|string +|False +a|Bucket name + + +|host +|string +|False +a|Host + + +|container +|string +|False +a|Container + + +|provider +|string +|False +a|Provider + + +|=== + + +[#source] +[.api-collapsible-fifth-title] +source + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Endpoint ID system ID or aws,azure,gcp,sgws,ibm + + +|metadata +|link:#metadata[metadata] +|False +a| + +|=== + + +[#target] +[.api-collapsible-fifth-title] +target + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Endpoint ID system ID or aws,azure,gcp,sgws,ibm + + +|metadata +|link:#metadata[metadata] +|False +a| + +|=== + + +[#relationships] +[.api-collapsible-fifth-title] +relationships + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|source +|link:#source[source] +|False +a| + +|target +|link:#target[target] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/copysync/get-api-accounts-relationships-stats.adoc b/copysync/get-api-accounts-relationships-stats.adoc new file mode 100644 index 00000000..47c969d6 --- /dev/null +++ b/copysync/get-api-accounts-relationships-stats.adoc @@ -0,0 +1,147 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-relationships-stats.html' +summary: 'Retrieve the logged-in accounts relationship status' +--- + += Retrieve the logged-in accounts relationship status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/relationships-stats`# + + + +Retrieves the logged-in account's relationship status. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|target +|string +|query +|False +a|Request for relationships with target Azure NetApp Files and source Cloud Volumes ONTAP stats + + +|sourceEdge +|string +|query +|False +a|Source Edge Cluster UUID + + +|targetEdge +|string +|query +|False +a|Target Edge Cluster UUID + + +|syncTarget +|string +|query +|False +a|Target sync type (edge or cloud) + + +|syncSource +|string +|query +|False +a|Source sync type (edge or cloud) + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalBytes +|number +|True +a|Total bytes copied according to requested flags + + +|numberOfRelationships +|number +|False +a|Total number of relationships according to the requested flags + + +|totalFiles +|number +|True +a|Total number of files copied according to requested flags + + +|bytesCopiedInTheLast30Days +|array[link:#bytesCopiedInTheLast30Days[bytesCopiedInTheLast30Days]] +|True +a|Array of bytes copied per day in the last 30 days + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#bytesCopiedInTheLast30Days] +[.api-collapsible-fifth-title] +bytesCopiedInTheLast30Days + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|date +|string +|True +a|date + + +|bytesCopied +|number +|True +a|Total bytes copied in a day + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/copysync/get-api-accounts-reports-.adoc b/copysync/get-api-accounts-reports-.adoc new file mode 100644 index 00000000..472e81b6 --- /dev/null +++ b/copysync/get-api-accounts-reports-.adoc @@ -0,0 +1,946 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-reports-.html' +summary: 'Retrieve a report by a specified ID' +--- + += Retrieve a report by a specified ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/reports/{id}`# + + + +Retrieves a report by a specified ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Report ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|The Report internal ID + + +|endpoint +|link:#endpoint[endpoint] +|True +a| + +|statistics +|link:#statistics[statistics] +|True +a|Statistics of the given endpoint + + +|status +|string +|True +a|Reporter status + + +|startTime +|string +|True +a|Start time + + +|endTime +|string +|False +a|End time + + +|duration +|number +|True +a|Total execution time of the reported + + +|reason +|string +|False +a|Failure reason + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#credentials] +[.api-collapsible-fifth-title] +credentials + +CIFS credentials + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|True +a|User name + + +|password +|string +|True +a|password + + +|domain +|string +|False +a|Domain + + +|=== + + +[#cifs] +[.api-collapsible-fifth-title] +cifs + +CIFS Details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|CIFS host + + +|share +|string +|True +a|CIFS share + + +|provider +|string +|True +a|CIFS type + + +|path +|string +|False +a|CIFS path + + +|version +|string +|False +a|Supported CIFS versions + + +|workingEnvironmentId +|string +|False +a|Relevant system ID + + +|credentials +|link:#credentials[credentials] +|False +a|CIFS credentials + + +|=== + + +[#nfs] +[.api-collapsible-fifth-title] +nfs + +NFS Details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|NFS host + + +|export +|string +|True +a|NFS export + + +|provider +|string +|True +a|NFS type + + +|path +|string +|False +a|NFS path + + +|version +|string +|False +a|Supported NFS versions + + +|workingEnvironmentId +|string +|False +a|Relevant system ID + + +|accessPoint +|string +|False +a|EFS access point + + +|=== + + +[#encryption] +[.api-collapsible-fifth-title] +encryption + +S3 encryption + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|protocol +|string +|False +a|Encryption type + + +|keyId +|string +|False +a|Encryption key arn in case it is kms encryption + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|False +a|Tag Key + + +|value +|string +|False +a|Tag Value + + +|=== + + +[#glacier] +[.api-collapsible-fifth-title] +glacier + +Glacier storage class restore information (available only for s3 as source endpoint) + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|days +|number +|True +a|Lifetime of the active copy in days + + +|tier +|string +|True +a|Glacier retrieval tier at which the restore will be processed + + +|=== + + +[#deepArchive] +[.api-collapsible-fifth-title] +deepArchive + +Deep Archive storage class restore information (available only for s3 as source endpoint) + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|days +|number +|True +a|Lifetime of the active copy in days + + +|tier +|string +|True +a|Deep Archive retrieval tier at which the restore will be processed + + +|=== + + +[#s3] +[.api-collapsible-fifth-title] +s3 + +S3 details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|False +a|SGWS or IBM or ONTAP host + + +|port +|integer +|False +a|SGWS or IBM or ONTAP port + + +|bucket +|string +|True +a|Bucket + + +|prefix +|string +|False +a|Prefix + + +|region +|string +|False +a|Bucket region + + +|encryption +|link:#encryption[encryption] +|False +a|S3 encryption + + +|privateLinkDns +|string +|False +a|AWS S3 Private Link DNS + + +|tags +|array[link:#tags[tags]] +|False +a| + +|storageClass +|string +|False +a|S3 Storage Class + + +|provider +|string +|True +a|Object Storage Type + + +|workingEnvironmentId +|string +|False +a|Relevant system ID - for storageGrid system + + +|glacier +|link:#glacier[glacier] +|False +a|Glacier storage class restore information (available only for s3 as source endpoint) + + +|deepArchive +|link:#deepArchive[deepArchive] +|False +a|Deep Archive storage class restore information (available only for s3 as source endpoint) + + +|=== + + +[#local] +[.api-collapsible-fifth-title] +local + +Local object details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|path +|string +|True +a|Local Path + + +|=== + + +[#azure] +[.api-collapsible-fifth-title] +azure + +Azure Blob Storage Details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|container +|string +|True +a|Azure Blob Storage container name + + +|storageAccountName +|string +|False +a|Azure Blob Storage account name + + +|prefix +|string +|False +a|Container blob prefix + + +|path +|string +|False +a|Container path, used in azure data lake storage + + +|tags +|array[link:#tags[tags]] +|False +a| + +|blobTier +|string +|False +a|Blob tier type + + +|provider +|string +|True +a|Azure type + + +|=== + + +[#gcp] +[.api-collapsible-fifth-title] +gcp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|bucket +|string +|True +a|GCP Bucket + + +|prefix +|string +|False +a|GCP Bucket prefix + + +|tags +|array[link:#tags[tags]] +|False +a| + +|storageClass +|string +|False +a|GCP Storage Class + + +|kmsKeyName +|string +|False +a|GCP Kms name + + +|provider +|string +|True +a|GCP Type + + +|=== + + +[#gdrive] +[.api-collapsible-fifth-title] +gdrive + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|driveId +|string +|True +a|Drive Id + + +|driveName +|string +|False +a|Drive Name + + +|folderId +|string +|False +a|Google Drive folderId + + +|path +|string +|False +a|Folder path + + +|provider +|string +|True +a|Google Drive Type + + +|tags +|array[link:#tags[tags]] +|False +a| + +|subject +|string +|True +a|subject - user email + + +|=== + + +[#sftp] +[.api-collapsible-fifth-title] +sftp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|SFTP host + + +|port +|integer +|True +a|SFTP port number + + +|path +|string +|False +a|Directory path + + +|rootDirectory +|string +|True +a|Root Directory path + + +|provider +|string +|True +a|SFTP Type + + +|=== + + +[#box] +[.api-collapsible-fifth-title] +box + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|rootDirectory +|string +|False +a|Root Directory + + +|path +|string +|False +a|path + + +|folderId +|string +|True +a|Folder ID + + +|clientId +|string +|True +a|Client ID + + +|appName +|string +|False +a|Box Application Name + + +|enterpriseId +|string +|False +a|Enterprise Id + + +|provider +|string +|True +a|Box Type + + +|=== + + +[#endpoint] +[.api-collapsible-fifth-title] +endpoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|protocol +|string +|False +a|Endpoint protocol + + +|cifs +|link:#cifs[cifs] +|False +a|CIFS Details + + +|nfs +|link:#nfs[nfs] +|False +a|NFS Details + + +|s3 +|link:#s3[s3] +|False +a|S3 details + + +|local +|link:#local[local] +|False +a|Local object details + + +|azure +|link:#azure[azure] +|False +a|Azure Blob Storage Details + + +|gcp +|link:#gcp[gcp] +|False +a| + +|gdrive +|link:#gdrive[gdrive] +|False +a| + +|sftp +|link:#sftp[sftp] +|False +a| + +|box +|link:#box[box] +|False +a| + +|=== + + +[#errors] +[.api-collapsible-fifth-title] +errors + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error Code + + +|counter +|number +|False +a|How many times this error code appeared + + +|description +|string +|False +a|Error code description + + +|=== + + +[#totals] +[.api-collapsible-fifth-title] +totals + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|directories +|number +|False +a|Number of directories + + +|files +|number +|False +a|Number of files + + +|others +|number +|False +a|Number of others + + +|objects +|number +|False +a|Number of objects + + +|emptyObjects +|number +|False +a|Number of empty objects + + +|size +|number +|False +a|Total size + + +|failed +|number +|False +a|Total failed objects + + +|=== + + +[#statistics] +[.api-collapsible-fifth-title] +statistics + +Statistics of the given endpoint + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errors +|array[link:#errors[errors]] +|False +a| + +|totals +|link:#totals[totals] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/copysync/get-api-accounts-reports-end-points.adoc b/copysync/get-api-accounts-reports-end-points.adoc new file mode 100644 index 00000000..dd214821 --- /dev/null +++ b/copysync/get-api-accounts-reports-end-points.adoc @@ -0,0 +1,42 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-reports-end-points.html' +summary: 'Retrieve a list of the reports endpoints' +--- + += Retrieve a list of the reports endpoints + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/reports/end-points`# + + + +Retrieves a list of the reports endpoints. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/get-api-accounts-reports.adoc b/copysync/get-api-accounts-reports.adoc new file mode 100644 index 00000000..2d671f14 --- /dev/null +++ b/copysync/get-api-accounts-reports.adoc @@ -0,0 +1,42 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts-reports.html' +summary: 'Retrieve a list of all reports' +--- + += Retrieve a list of all reports + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts/{accountId}/reports`# + + + +Retrieves a list of all reports. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/get-api-accounts.adoc b/copysync/get-api-accounts.adoc new file mode 100644 index 00000000..23c15a66 --- /dev/null +++ b/copysync/get-api-accounts.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-accounts.html' +summary: 'Retrieve the tenancy accounts' +--- + += Retrieve the tenancy accounts + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/accounts`# + + + +Retrieves the tenancy accounts. + + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-alibaba-bucket-folders.adoc b/copysync/get-api-data-brokers-list-alibaba-bucket-folders.adoc new file mode 100644 index 00000000..71b2e4c4 --- /dev/null +++ b/copysync/get-api-data-brokers-list-alibaba-bucket-folders.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-alibaba-bucket-folders.html' +summary: 'Retrieve the Alibaba bucket folders' +--- + += Retrieve the Alibaba bucket folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-alibaba-bucket-folders`# + + + +Retrieves the Alibaba bucket folders from a data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|bucket +|string +|query +|True +a|Bucket + + +|prefix +|string +|query +|False +a|Path inside the container, to list folders in + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-alibaba-buckets.adoc b/copysync/get-api-data-brokers-list-alibaba-buckets.adoc new file mode 100644 index 00000000..0e760d92 --- /dev/null +++ b/copysync/get-api-data-brokers-list-alibaba-buckets.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-alibaba-buckets.html' +summary: 'Retrieve the Alibaba buckets' +--- + += Retrieve the Alibaba buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-alibaba-buckets`# + + + +Retrieves the Alibaba buckets accessible from a data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-aws-kms-keys.adoc b/copysync/get-api-data-brokers-list-aws-kms-keys.adoc new file mode 100644 index 00000000..eec5b968 --- /dev/null +++ b/copysync/get-api-data-brokers-list-aws-kms-keys.adoc @@ -0,0 +1,59 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-aws-kms-keys.html' +summary: 'Retrieve the AWS KMS keys' +--- + += Retrieve the AWS KMS keys + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-aws-kms-keys`# + + + +Retrieves the AWS KMS keys from a NetApp data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|bucket +|string +|query +|True +a|AWS Bucket + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-azure-blob-storage-container-folders.adoc b/copysync/get-api-data-brokers-list-azure-blob-storage-container-folders.adoc new file mode 100644 index 00000000..c713aeab --- /dev/null +++ b/copysync/get-api-data-brokers-list-azure-blob-storage-container-folders.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-azure-blob-storage-container-folders.html' +summary: 'Retrieve the Azure blob storage container folders' +--- + += Retrieve the Azure blob storage container folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-azure-blob-storage-container-folders`# + + + +Retrieves the Azure blob storage container folders. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|storageAccountName +|string +|query +|True +a|Azure storage account name + + +|container +|string +|query +|True +a|Container + + +|prefix +|string +|query +|False +a|Path inside the container, to list folders in + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|storage-account-connection-string +|string +|header +|True +a|Azure storage account connection-string + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-azure-blob-storage-containers.adoc b/copysync/get-api-data-brokers-list-azure-blob-storage-containers.adoc new file mode 100644 index 00000000..fa729829 --- /dev/null +++ b/copysync/get-api-data-brokers-list-azure-blob-storage-containers.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-azure-blob-storage-containers.html' +summary: 'Retrieve the Azure blob storage containers' +--- + += Retrieve the Azure blob storage containers + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-azure-blob-storage-containers`# + + + +Retrieves the Azure blob storage containers. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|storageAccountName +|string +|query +|True +a|Azure storage account name + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|storage-account-connection-string +|string +|header +|True +a|Azure storage account connection-string + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-cifs-share-folders.adoc b/copysync/get-api-data-brokers-list-cifs-share-folders.adoc new file mode 100644 index 00000000..bef81c40 --- /dev/null +++ b/copysync/get-api-data-brokers-list-cifs-share-folders.adoc @@ -0,0 +1,101 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-cifs-share-folders.html' +summary: 'Retrieve the CIFS server folders' +--- + += Retrieve the CIFS server folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-cifs-share-folders`# + + + +Retrieves the CIFS server folders from a NetApp data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|CIFS server hostname or IP + + +|version +|string +|query +|False +a|CIFS version + + +|path +|string +|query +|False +a|CIFS server share path + + +|share +|string +|query +|True +a|Cifs share + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|username +|string +|header +|True +a|CIFS server username + + +|password +|string +|header +|True +a|CIFS server password + + +|domain +|string +|header +|False +a|CIFS server domain + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-cifs-shares.adoc b/copysync/get-api-data-brokers-list-cifs-shares.adoc new file mode 100644 index 00000000..2077fb36 --- /dev/null +++ b/copysync/get-api-data-brokers-list-cifs-shares.adoc @@ -0,0 +1,87 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-cifs-shares.html' +summary: 'Retrieve the CIFS shares' +--- + += Retrieve the CIFS shares + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-cifs-shares`# + + + +Retrieves the CIFS shares accessible from a NetApp data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|CIFS server hostname or IP + + +|version +|string +|query +|False +a|CIFS version + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|username +|string +|header +|True +a|CIFS server username + + +|password +|string +|header +|True +a|CIFS server password + + +|domain +|string +|header +|False +a|CIFS server domain + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-gcp-bucket-folders.adoc b/copysync/get-api-data-brokers-list-gcp-bucket-folders.adoc new file mode 100644 index 00000000..fc0643d9 --- /dev/null +++ b/copysync/get-api-data-brokers-list-gcp-bucket-folders.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-gcp-bucket-folders.html' +summary: 'Retrieve the Google Cloud bucket folders' +--- + += Retrieve the Google Cloud bucket folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-gcp-bucket-folders`# + + + +Retrieves the Google Cloud bucket folders from a NetApp data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|bucket +|string +|query +|True +a|Bucket + + +|prefix +|string +|query +|False +a|Path inside the container, to list folders in + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-gcp-buckets.adoc b/copysync/get-api-data-brokers-list-gcp-buckets.adoc new file mode 100644 index 00000000..aa5e5a83 --- /dev/null +++ b/copysync/get-api-data-brokers-list-gcp-buckets.adoc @@ -0,0 +1,52 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-gcp-buckets.html' +summary: 'Retrieve the Google Cloud buckets' +--- + += Retrieve the Google Cloud buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-gcp-buckets`# + + + +Retrieves the Google Cloud buckets accessible from a NetApp data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-ibm-bucket-folders.adoc b/copysync/get-api-data-brokers-list-ibm-bucket-folders.adoc new file mode 100644 index 00000000..ad7c49d5 --- /dev/null +++ b/copysync/get-api-data-brokers-list-ibm-bucket-folders.adoc @@ -0,0 +1,94 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-ibm-bucket-folders.html' +summary: 'Retrieve the IBM bucket folders' +--- + += Retrieve the IBM bucket folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-ibm-bucket-folders`# + + + +Retrieves the IBM bucket folders from a NetApp data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|Server hostname or IP + + +|port +|number +|query +|False +a|Server port + + +|bucket +|string +|query +|True +a|Bucket + + +|prefix +|string +|query +|False +a|Prefix + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-ibm-buckets.adoc b/copysync/get-api-data-brokers-list-ibm-buckets.adoc new file mode 100644 index 00000000..48e99687 --- /dev/null +++ b/copysync/get-api-data-brokers-list-ibm-buckets.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-ibm-buckets.html' +summary: 'Retrieve the IBM buckets' +--- + += Retrieve the IBM buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-ibm-buckets`# + + + +Retrieves the IBM buckets accessible from a NetApp data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|Server hostname or IP + + +|port +|number +|query +|True +a|Server port + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-nfs-export-folders.adoc b/copysync/get-api-data-brokers-list-nfs-export-folders.adoc new file mode 100644 index 00000000..7f816364 --- /dev/null +++ b/copysync/get-api-data-brokers-list-nfs-export-folders.adoc @@ -0,0 +1,94 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-nfs-export-folders.html' +summary: 'Retrieve the NFS server folders by ID' +--- + += Retrieve the NFS server folders by ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-nfs-export-folders`# + + + +Retrieves the NFS server folders from the data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|NFS server hostname or IP + + +|exportName +|string +|query +|True +a|NFS server export + + +|isEFS +|boolean +|query +|False +a|Indicates if the is target EFS + + +|version +|string +|query +|False +a|NFS version supported versions 3, 4.0, 4.1, 4.2 + + +|accessPoint +|string +|query +|False +a|EFS access point + + +|path +|string +|query +|False +a|NFS Export path + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-nfs-exports.adoc b/copysync/get-api-data-brokers-list-nfs-exports.adoc new file mode 100644 index 00000000..7a1ae7d8 --- /dev/null +++ b/copysync/get-api-data-brokers-list-nfs-exports.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-nfs-exports.html' +summary: 'Retrieve the NFS server folders' +--- + += Retrieve the NFS server folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-nfs-exports`# + + + +Retrieves the NFS server folders from a data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|NFS server hostname or IP + + +|isEFS +|boolean +|query +|False +a|Indicates if the is target EFS + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-ontap-s3-bucket-folders.adoc b/copysync/get-api-data-brokers-list-ontap-s3-bucket-folders.adoc new file mode 100644 index 00000000..13319fc2 --- /dev/null +++ b/copysync/get-api-data-brokers-list-ontap-s3-bucket-folders.adoc @@ -0,0 +1,94 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-ontap-s3-bucket-folders.html' +summary: 'Retrieve the ONTAP S3 bucket folders' +--- + += Retrieve the ONTAP S3 bucket folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-ontap-s3-bucket-folders`# + + + +Retrieves the ONTAP S3 bucket folders from a NetApp data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|ONTAP S3 hostname or IP + + +|port +|number +|query +|False +a|Server port + + +|bucket +|string +|query +|True +a|Bucket + + +|prefix +|string +|query +|False +a|Path inside the bucket, to list folders in + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-ontap-s3-buckets.adoc b/copysync/get-api-data-brokers-list-ontap-s3-buckets.adoc new file mode 100644 index 00000000..b52c1184 --- /dev/null +++ b/copysync/get-api-data-brokers-list-ontap-s3-buckets.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-ontap-s3-buckets.html' +summary: 'Retrieve the ONTAP S3 buckets' +--- + += Retrieve the ONTAP S3 buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-ontap-s3-buckets`# + + + +Retrieves the ONTAP S3 buckets accessible from a NetApp data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|ONTAP S3 hostname or IP + + +|port +|number +|query +|False +a|Server port + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-s3-bucket-folders.adoc b/copysync/get-api-data-brokers-list-s3-bucket-folders.adoc new file mode 100644 index 00000000..32523301 --- /dev/null +++ b/copysync/get-api-data-brokers-list-s3-bucket-folders.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-s3-bucket-folders.html' +summary: 'Retrieve the S3 bucket folders' +--- + += Retrieve the S3 bucket folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-s3-bucket-folders`# + + + +Retrieves the S3 bucket folders from a NetApp data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|bucket +|string +|query +|True +a|Bucket + + +|prefix +|string +|query +|False +a|Path inside the container, to list folders in + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-s3-buckets.adoc b/copysync/get-api-data-brokers-list-s3-buckets.adoc new file mode 100644 index 00000000..2e5ac495 --- /dev/null +++ b/copysync/get-api-data-brokers-list-s3-buckets.adoc @@ -0,0 +1,52 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-s3-buckets.html' +summary: 'Retrieve the S3 buckets' +--- + += Retrieve the S3 buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-s3-buckets`# + + + +Retrieves the S3 buckets accessible from a NetApp data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-sgws-bucket-folders.adoc b/copysync/get-api-data-brokers-list-sgws-bucket-folders.adoc new file mode 100644 index 00000000..003d4485 --- /dev/null +++ b/copysync/get-api-data-brokers-list-sgws-bucket-folders.adoc @@ -0,0 +1,94 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-sgws-bucket-folders.html' +summary: 'Retrieve the StorageGRID bucket folders' +--- + += Retrieve the StorageGRID bucket folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-sgws-bucket-folders`# + + + +Retrieves the StorageGRID bucket folders from a NetApp data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|Server hostname or IP + + +|port +|number +|query +|False +a|Server port + + +|bucket +|string +|query +|True +a|Bucket + + +|prefix +|string +|query +|False +a|Prefix + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers-list-sgws-buckets.adoc b/copysync/get-api-data-brokers-list-sgws-buckets.adoc new file mode 100644 index 00000000..87f990e1 --- /dev/null +++ b/copysync/get-api-data-brokers-list-sgws-buckets.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers-list-sgws-buckets.html' +summary: 'Retrieve the StorageGRID buckets' +--- + += Retrieve the StorageGRID buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers/{id}/list-sgws-buckets`# + + + +Retrieves the StorageGRID buckets accessible from a NetApp data broker. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|host +|string +|query +|True +a|Server hostname or IP + + +|port +|number +|query +|True +a|Server port + + +|id +|string +|path +|True +a|Data Broker ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|access-key +|string +|header +|True +a|StorageGRID server access-key + + +|secret-key +|string +|header +|True +a|StorageGRID server secret-key + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/get-api-data-brokers.adoc b/copysync/get-api-data-brokers.adoc new file mode 100644 index 00000000..530a824b --- /dev/null +++ b/copysync/get-api-data-brokers.adoc @@ -0,0 +1,42 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-data-brokers.html' +summary: 'Retrieve all the data brokers' +--- + += Retrieve all the data brokers + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/data-brokers`# + + + +Retrieves all the data brokers. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/get-api-groups.adoc b/copysync/get-api-groups.adoc new file mode 100644 index 00000000..7835bd54 --- /dev/null +++ b/copysync/get-api-groups.adoc @@ -0,0 +1,42 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-groups.html' +summary: 'Retrieve all groups' +--- + += Retrieve all groups + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/groups`# + + + +Retrieves all data broker groups. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/get-api-messages-client.adoc b/copysync/get-api-messages-client.adoc new file mode 100644 index 00000000..4412005a --- /dev/null +++ b/copysync/get-api-messages-client.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-messages-client.html' +summary: 'Retrieve the asynchronous messages' +--- + += Retrieve the asynchronous messages + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/messages/client`# + + + +Retrieves the asynchronous messages. This API endpoint refers to a long polling endpoint for asynchronous messages. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|last +|string +|query +|False +a|Last Received message ID + + +|x-account-id +|string +|header +|False +a|NetApp Tenancy Account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/get-api-relationships-v2-.adoc b/copysync/get-api-relationships-v2-.adoc new file mode 100644 index 00000000..4e30d14b --- /dev/null +++ b/copysync/get-api-relationships-v2-.adoc @@ -0,0 +1,1857 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-relationships-v2-.html' +summary: 'Retrieve a relationship' +--- + += Retrieve a relationship + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/relationships-v2/{id}`# + + + +Retrieves a relationship. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|id +|string +|path +|True +a|Relationship ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Relationship ID + + +|isCM +|string +|False +a|Was the relationship created through CloudManager + + +|dataBroker +|string +|False +a|Data Broker ID + + +|relationshipId +|string +|False +a|Relationship ID + + +|source +|link:#source[source] +|True +a| + +|target +|link:#target[target] +|True +a| + +|encryption +|link:#encryption[encryption] +|False +a| + +|group +|string +|False +a|Group ID + + +|settings +|link:#settings[settings] +|False +a| + +|activity +|link:#activity[activity] +|False +a| + +|createdAt +|number +|True +a|Relationship Creation time + + +|customHeaders +|link:#customHeaders[customHeaders] +|False +a|Custom headers for the relationship + + +|extraInformation +|link:#extraInformation[extraInformation] +|False +a| + +|tags +|array[link:#tags[tags]] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#credentials] +[.api-collapsible-fifth-title] +credentials + +CIFS credentials + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|True +a|User name + + +|password +|string +|True +a|password + + +|domain +|string +|False +a|Domain + + +|=== + + +[#cifs] +[.api-collapsible-fifth-title] +cifs + +CIFS Details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|CIFS host + + +|share +|string +|True +a|CIFS share + + +|provider +|string +|True +a|CIFS type + + +|path +|string +|False +a|CIFS path + + +|version +|string +|False +a|Supported CIFS versions + + +|workingEnvironmentId +|string +|False +a|Relevant system ID + + +|credentials +|link:#credentials[credentials] +|False +a|CIFS credentials + + +|=== + + +[#nfs] +[.api-collapsible-fifth-title] +nfs + +NFS Details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|NFS host + + +|export +|string +|True +a|NFS export + + +|provider +|string +|True +a|NFS type + + +|path +|string +|False +a|NFS path + + +|version +|string +|False +a|Supported NFS versions + + +|workingEnvironmentId +|string +|False +a|Relevant system ID + + +|accessPoint +|string +|False +a|EFS access point + + +|=== + + +[#encryption] +[.api-collapsible-fifth-title] +encryption + +S3 encryption + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|protocol +|string +|False +a|Encryption type + + +|keyId +|string +|False +a|Encryption key arn in case it is kms encryption + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|False +a|Tag Key + + +|value +|string +|False +a|Tag Value + + +|=== + + +[#glacier] +[.api-collapsible-fifth-title] +glacier + +Glacier storage class restore information (available only for s3 as source endpoint) + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|days +|number +|True +a|Lifetime of the active copy in days + + +|tier +|string +|True +a|Glacier retrieval tier at which the restore will be processed + + +|=== + + +[#deepArchive] +[.api-collapsible-fifth-title] +deepArchive + +Deep Archive storage class restore information (available only for s3 as source endpoint) + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|days +|number +|True +a|Lifetime of the active copy in days + + +|tier +|string +|True +a|Deep Archive retrieval tier at which the restore will be processed + + +|=== + + +[#s3] +[.api-collapsible-fifth-title] +s3 + +S3 details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|False +a|SGWS or IBM or ONTAP host + + +|port +|integer +|False +a|SGWS or IBM or ONTAP port + + +|bucket +|string +|True +a|Bucket + + +|prefix +|string +|False +a|Prefix + + +|region +|string +|False +a|Bucket region + + +|encryption +|link:#encryption[encryption] +|False +a|S3 encryption + + +|privateLinkDns +|string +|False +a|AWS S3 Private Link DNS + + +|tags +|array[link:#tags[tags]] +|False +a| + +|storageClass +|string +|False +a|S3 Storage Class + + +|provider +|string +|True +a|Object Storage Type + + +|workingEnvironmentId +|string +|False +a|Relevant system ID - for storageGrid system + + +|glacier +|link:#glacier[glacier] +|False +a|Glacier storage class restore information (available only for s3 as source endpoint) + + +|deepArchive +|link:#deepArchive[deepArchive] +|False +a|Deep Archive storage class restore information (available only for s3 as source endpoint) + + +|=== + + +[#local] +[.api-collapsible-fifth-title] +local + +Local object details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|path +|string +|True +a|Local Path + + +|=== + + +[#azure] +[.api-collapsible-fifth-title] +azure + +Azure Blob Storage Details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|container +|string +|True +a|Azure Blob Storage container name + + +|storageAccountName +|string +|False +a|Azure Blob Storage account name + + +|prefix +|string +|False +a|Container blob prefix + + +|path +|string +|False +a|Container path, used in azure data lake storage + + +|tags +|array[link:#tags[tags]] +|False +a| + +|blobTier +|string +|False +a|Blob tier type + + +|provider +|string +|True +a|Azure type + + +|=== + + +[#gcp] +[.api-collapsible-fifth-title] +gcp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|bucket +|string +|True +a|GCP Bucket + + +|prefix +|string +|False +a|GCP Bucket prefix + + +|tags +|array[link:#tags[tags]] +|False +a| + +|storageClass +|string +|False +a|GCP Storage Class + + +|kmsKeyName +|string +|False +a|GCP Kms name + + +|provider +|string +|True +a|GCP Type + + +|=== + + +[#gdrive] +[.api-collapsible-fifth-title] +gdrive + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|driveId +|string +|True +a|Drive Id + + +|driveName +|string +|False +a|Drive Name + + +|folderId +|string +|False +a|Google Drive folderId + + +|path +|string +|False +a|Folder path + + +|provider +|string +|True +a|Google Drive Type + + +|tags +|array[link:#tags[tags]] +|False +a| + +|subject +|string +|True +a|subject - user email + + +|=== + + +[#sftp] +[.api-collapsible-fifth-title] +sftp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|SFTP host + + +|port +|integer +|True +a|SFTP port number + + +|path +|string +|False +a|Directory path + + +|rootDirectory +|string +|True +a|Root Directory path + + +|provider +|string +|True +a|SFTP Type + + +|=== + + +[#box] +[.api-collapsible-fifth-title] +box + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|rootDirectory +|string +|False +a|Root Directory + + +|path +|string +|False +a|path + + +|folderId +|string +|True +a|Folder ID + + +|clientId +|string +|True +a|Client ID + + +|appName +|string +|False +a|Box Application Name + + +|enterpriseId +|string +|False +a|Enterprise Id + + +|provider +|string +|True +a|Box Type + + +|=== + + +[#source] +[.api-collapsible-fifth-title] +source + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|protocol +|string +|False +a|Endpoint protocol + + +|cifs +|link:#cifs[cifs] +|False +a|CIFS Details + + +|nfs +|link:#nfs[nfs] +|False +a|NFS Details + + +|s3 +|link:#s3[s3] +|False +a|S3 details + + +|local +|link:#local[local] +|False +a|Local object details + + +|azure +|link:#azure[azure] +|False +a|Azure Blob Storage Details + + +|gcp +|link:#gcp[gcp] +|False +a| + +|gdrive +|link:#gdrive[gdrive] +|False +a| + +|sftp +|link:#sftp[sftp] +|False +a| + +|box +|link:#box[box] +|False +a| + +|=== + + +[#target] +[.api-collapsible-fifth-title] +target + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|protocol +|string +|False +a|Endpoint protocol + + +|cifs +|link:#cifs[cifs] +|False +a|CIFS Details + + +|nfs +|link:#nfs[nfs] +|False +a|NFS Details + + +|s3 +|link:#s3[s3] +|False +a|S3 details + + +|local +|link:#local[local] +|False +a|Local object details + + +|azure +|link:#azure[azure] +|False +a|Azure Blob Storage Details + + +|gcp +|link:#gcp[gcp] +|False +a| + +|gdrive +|link:#gdrive[gdrive] +|False +a| + +|sftp +|link:#sftp[sftp] +|False +a| + +|box +|link:#box[box] +|False +a| + +|=== + + +[#initiator] +[.api-collapsible-fifth-title] +initiator + +Initiator details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dataBrokerId +|string +|False +a|Data Broker Id + + +|groupId +|string +|False +a|Group Id + + +|encryptionType +|string +|False +a|Data Broker network location - if initiator is src, listener must be trg + + +|=== + + +[#listener] +[.api-collapsible-fifth-title] +listener + +Listener details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dataBrokerId +|string +|False +a|Data Broker Id + + +|groupId +|string +|False +a|Group Id + + +|encryptionType +|string +|False +a|Data Broker network location - if initiator is src, listener must be trg + + +|=== + + +[#encryption] +[.api-collapsible-fifth-title] +encryption + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiator +|link:#initiator[initiator] +|False +a|Initiator details + + +|listener +|link:#listener[listener] +|False +a|Listener details + + +|=== + + +[#fileTypes] +[.api-collapsible-fifth-title] +fileTypes + +The file types that is included in the relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|files +|boolean +|False +a|Include files + + +|directories +|boolean +|False +a|Include directories + + +|symlinks +|boolean +|False +a|Include symbolic links + + +|hardlinks +|boolean +|False +a|include hard links + + +|=== + + +[#compareBy] +[.api-collapsible-fifth-title] +compareBy + +The file attributes that should be compared + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uid +|boolean +|False +a|uid ( relevant when source or target is file system ) + + +|gid +|boolean +|False +a|gid ( relevant when source or target is file system ) + + +|mtime +|boolean +|False +a|mtime + + +|mode +|boolean +|False +a|mode + + +|=== + + +[#copyProperties] +[.api-collapsible-fifth-title] +copyProperties + +The object properties that should be copied + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|metadata +|boolean +|False +a|copy metadata ( cloud to cloud ) + + +|tags +|boolean +|False +a|copy tags ( cloud to cloud only S3 compatible ) + + +|=== + + +[#files] +[.api-collapsible-fifth-title] +files + +Settings related to files. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|excludeExtensions +|array[string] +|False +a|Excluded extensions array (For example - [".log", ".tar.gz"]) + + +|excludeByRegex +|array[string] +|False +a|Excluded files by regex (For example - ".txt." will exclude the files file.doc.txt.gz) + + +|minSize +|integer +|False +a|Minimum file size (in bytes). Only files of equal or larger size will be transferred by the relationship + + +|maxSize +|integer +|False +a|Maximum file size (in bytes). Only files of equal or smaller size will be transferred by the relationship + + +|minDate +|string +|False +a|Data broker will sync files that were last modified after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21' + + +|maxDate +|["null", "string"] +|False +a|Data broker will sync files that were last modified before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date + + +|minCreationDate +|string +|False +a|Data broker will sync files that were created after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21' + + +|maxCreationDate +|["null", "string"] +|False +a|Data broker will sync files that were created before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date + + +|=== + + +[#directories] +[.api-collapsible-fifth-title] +directories + +Settings related to directories. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|excludeNames +|array[string] +|False +a|Excluded directories names array (For example - ["dir1"]) + + +|excludeByRegex +|array[string] +|False +a|Excluded directories names by regex (For example - "._tmp._." will exclude the directories with names that include tmp ) + + +|=== + + +[#schedule] +[.api-collapsible-fifth-title] +schedule + +Sync schedule settings. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|syncInDays +|integer +|False +a|Days interval for sync scheduler + + +|syncInHours +|integer +|False +a| + +|syncInMinutes +|integer +|False +a| + +|isEnabled +|boolean +|False +a|Activate automatic scheduler + + +|nextTime +|string +|False +a|The first time the relationship should run + + +|syncWhenCreated +|boolean +|False +a|Start the sync upon creation + + +|=== + + +[#cm] +[.api-collapsible-fifth-title] +cm + +NetApp Console notifications + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|done +|boolean +|False +a|Should send notification about DONE status + + +|failed +|boolean +|False +a|Should send notification about FAILED status + + +|aborted +|boolean +|False +a|Should send notification about ABORTED status + + +|running_continuously +|boolean +|False +a|Should send notification about RUNNING_CONTINUOUSLY status + + +|=== + + +[#notifications] +[.api-collapsible-fifth-title] +notifications + +Notifications settings. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cm +|link:#cm[cm] +|False +a|NetApp Console notifications + + +|=== + + +[#scheduleAbort] +[.api-collapsible-fifth-title] +scheduleAbort + +Schedule abort settings. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|abortInDays +|integer +|False +a|Days interval for abort scheduler + + +|abortInHours +|integer +|False +a|Hours interval for abort scheduler + + +|abortInMinutes +|integer +|False +a|Minutes interval for abort scheduler + + +|isEnabled +|boolean +|False +a|Activate automatic scheduler abort + + +|=== + + +[#settings] +[.api-collapsible-fifth-title] +settings + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|gracePeriod +|number +|True +a|Grace period time ( seconds ) + + +|deleteOnSource +|boolean +|True +a|Enable delete on source + + +|deleteOnTarget +|boolean +|True +a|Enable delete on target + + +|objectTagging +|boolean +|True +a|Use S3 tagging to store object metadata + + +|retries +|integer +|True +a|Number of retries + + +|copyAcl +|boolean +|False +a|Enable ACL copy + + +|copyData +|boolean +|True +a|Copy data only + + +|continuousSync +|boolean +|False +a|Listen to object notifications + + +|fileTypes +|link:#fileTypes[fileTypes] +|True +a|The file types that is included in the relationship + + +|compareBy +|link:#compareBy[compareBy] +|True +a|The file attributes that should be compared + + +|copyProperties +|link:#copyProperties[copyProperties] +|False +a|The object properties that should be copied + + +|files +|link:#files[files] +|True +a|Settings related to files. + + +|directories +|link:#directories[directories] +|True +a|Settings related to directories. + + +|schedule +|link:#schedule[schedule] +|True +a|Sync schedule settings. + + +|notifications +|link:#notifications[notifications] +|False +a|Notifications settings. + + +|scheduleAbort +|link:#scheduleAbort[scheduleAbort] +|True +a|Schedule abort settings. + + +|=== + + +[#topFiveMostCommonRelationshipErrors] +[.api-collapsible-fifth-title] +topFiveMostCommonRelationshipErrors + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|step +|string +|False +a|Sync step that failed - TRANSFER or SCAN + + +|errorCode +|string +|False +a|Error code + + +|counter +|number +|False +a|Number of errors + + +|description +|string +|False +a|Error description + + +|=== + + +[#errors] +[.api-collapsible-fifth-title] +errors + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dataBrokerId +|string +|False +a|Data Broker with initialized error + + +|reason +|string +|False +a|Error + + +|=== + + +[#activity] +[.api-collapsible-fifth-title] +activity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|syncType +|string +|False +a|field for UI - to indicate if we copy only acl or copy also data + + +|status +|string +|False +a|Relationship status + + +|type +|string +|False +a|Relationship phase - Initial copy or sync + + +|bytesMarkedForCopy +|number +|False +a|Bytes marked for copy + + +|filesMarkedForCopy +|number +|False +a|Files marked for copy + + +|dirsMarkedForCopy +|number +|False +a|Directories marked for copy + + +|filesCopied +|number +|False +a|Files copied + + +|bytesCopied +|number +|False +a|Bytes copied + + +|dirsCopied +|number +|False +a|Directories copied + + +|filesFailed +|number +|False +a|files failed to copy + + +|bytesFailed +|number +|False +a|Bytes failed to copy + + +|dirsFailed +|number +|False +a|Directories failed to copy + + +|filesMarkedForRemove +|number +|False +a|Files marked for remove + + +|bytesMarkedForRemove +|number +|False +a|Byes marked for remove + + +|dirsMarkedForRemove +|number +|False +a|Directories marked for remove + + +|filesRemoved +|number +|False +a|Files removed + + +|bytesRemoved +|number +|False +a|Bytes removed + + +|dirsRemoved +|number +|False +a|Directories removed + + +|bytesRemovedFailed +|number +|False +a|Bytes failed to remove + + +|filesRemovedFailed +|number +|False +a|Filed failed to remove + + +|filesMarkedForIgnore +|number +|False +a|Files marked for ignore + + +|dirsScanned +|number +|False +a|Directories scanned + + +|filesScanned +|number +|False +a|Files scanned + + +|bytesScanned +|number +|False +a|Bytes scanned + + +|dirsFailedToScan +|number +|False +a|Directories failed to scan + + +|timeEstimation +|number +|False +a|Time estimation until the end of the sync + + +|progress +|number +|False +a|Relationship progress + + +|endTime +|string +|False +a|End time + + +|startTime +|string +|False +a|Start time + + +|executionTime +|number +|False +a|Execution time + + +|failureMessage +|string +|False +a|Failure message + + +|lastMessageTime +|string +|False +a|Last message time + + +|topFiveMostCommonRelationshipErrors +|array[link:#topFiveMostCommonRelationshipErrors[topFiveMostCommonRelationshipErrors]] +|False +a| + +|errors +|array[link:#errors[errors]] +|False +a| + +|=== + + +[#customHeaders] +[.api-collapsible-fifth-title] +customHeaders + +Custom headers for the relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|x-netapp-external-request-id-src +|string +|False +a|Source request ID header + + +|x-netapp-external-request-id-trg +|string +|False +a|Target request ID header + + +|x-source-edge +|string +|False +a|Edge cluster UUID + + +|x-target-edge +|string +|False +a|Edge cluster UUID + + +|x-sync-source +|string +|False +a|Is source Edge + + +|x-sync-target +|string +|False +a|is target Edge + + +|=== + + +[#extraInformation] +[.api-collapsible-fifth-title] +extraInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dataSenseQueryUid +|string +|False +a|Data sense query uid + + +|connectorId +|string +|False +a|Console agent ID ( for data sense query ) + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/copysync/get-api-relationships-v2.adoc b/copysync/get-api-relationships-v2.adoc new file mode 100644 index 00000000..b5b954cc --- /dev/null +++ b/copysync/get-api-relationships-v2.adoc @@ -0,0 +1,42 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-relationships-v2.html' +summary: 'Retrieve all relationships' +--- + += Retrieve all relationships + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/relationships-v2`# + + + +Retrieves all relationships. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/get-api-storages-.adoc b/copysync/get-api-storages-.adoc new file mode 100644 index 00000000..77322bc6 --- /dev/null +++ b/copysync/get-api-storages-.adoc @@ -0,0 +1,55 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-storages-.html' +summary: 'Retrieve the storage type' +--- + += Retrieve the storage type + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/storages/{protocol}`# + + + +Retrieves the storage type. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|provider +|string +|query +|False +a|Provider + + +|protocol +|string +|path +|True +a| + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/get-api-timelines.adoc b/copysync/get-api-timelines.adoc new file mode 100644 index 00000000..c6489c08 --- /dev/null +++ b/copysync/get-api-timelines.adoc @@ -0,0 +1,45 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-timelines.html' +summary: 'Retrieve timelines' +--- + += Retrieve timelines + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/timelines`# + + + +Retrieves timelines. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-account-id +|string +|header +|False +a|NetApp Tenancy Account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/get-api-v2-accounts-nss-credentials.adoc b/copysync/get-api-v2-accounts-nss-credentials.adoc new file mode 100644 index 00000000..7fe415dd --- /dev/null +++ b/copysync/get-api-v2-accounts-nss-credentials.adoc @@ -0,0 +1,42 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/get-api-v2-accounts-nss-credentials.html' +summary: 'Retrieve NetApp support site credentials' +--- + += Retrieve NetApp support site credentials + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/api/v2/accounts/{accountId}/nss-credentials`# + + + +Retrieves the NetApp Support Site credentials. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/groups_overview.adoc b/copysync/groups_overview.adoc new file mode 100644 index 00000000..e9d7c5f5 --- /dev/null +++ b/copysync/groups_overview.adoc @@ -0,0 +1,33 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/groups_overview.html' +summary: 'Groups endpoints in the NetApp Copy and Sync REST API' +--- + += Groups endpoints in the NetApp Copy and Sync REST API + + + +The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. +The following actions can be performed with the data broker groups endpoints: + +* Retrieve data broker group information (information on the group configuration and each data broker in the group) +* Download data broker group logs (download logs from each data broker in the group) +* Change data broker group configuration - control the number of processes and concurrency in the data brokers +* Delete a data broker group +* Use the data broker group to perform various asynchronous operations such as: +* List S3 buckets +* List NFS exports +* List SMB shares +* List SFTP directories +* List AWS KMS keys +* List StorageGRID buckets +* List IBM buckets +* List ONTAP S3 buckets +* List Azure storage account containers +* List Google drives +* List S3 private links + + diff --git a/copysync/messages_overview.adoc b/copysync/messages_overview.adoc new file mode 100644 index 00000000..3ca930c0 --- /dev/null +++ b/copysync/messages_overview.adoc @@ -0,0 +1,18 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/messages_overview.html' +summary: 'Messages endpoints in the NetApp Copy and Sync REST API' +--- + += Messages endpoints in the NetApp Copy and Sync REST API + + + +The messages endpoint sends user information, received by performing asynchronous operations, such as listing an S3 bucket, listing shares, and listing exports, to a client. + +The API call process involves the following steps: + + + diff --git a/copysync/overview.adoc b/copysync/overview.adoc new file mode 100644 index 00000000..70e17865 --- /dev/null +++ b/copysync/overview.adoc @@ -0,0 +1,227 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/overview.html' +summary: 'NetApp Copy and Sync REST API' +--- + += NetApp Copy and Sync REST API + + + +The NetApp Copy and Sync service offers a simple, secure, and automated way to migrate your data to any location in the cloud or on your premises. The service enables you to convert and move data stored in any object store including NFS or SMB servers, Amazon Simple Storage Service (S3), Google Drive, Box, and more. When using this service, you can create a sync relationship to copy data from any source to any destination target. + + + +The service exposes an associated REST API which you can programmatically use to administer the Copy and Sync API resources. There are eight categories of endpoints defined within the NetApp Copy and Sync REST API: + +* Accounts +* Messages +* Data Brokers +* Groups +* Relationships +* Storages +* Reports +* Timelines (deprecated) + +See the https://docs.netapp.com/us-en/data-services-copy-sync/api-sync.html[NetApp Copy and Sync APIs] to get started. + + + +**Note:** Before using the API reference documentation, review the https://docs.netapp.com/us-en/console-automation/platform/overview.html[Get started] section for the NetApp Console APIs. For more information about the security tokens and identifiers you'll need when using the API, review the https://docs.netapp.com/us-en/console-automation/platform/get_identifiers.html[Common workflows and tasks] section. + + +== REST implementation + +=== HTTP methods + +|=== +| Method | Description + +| `POST` +| Create a resource + +| `GET` +| Retrieve a resource instance or collection + +| `PUT` +| Update specific properties of an existing resource instance + +| `DELETE` +| Remove an existing resource +|=== + +=== Request headers + +|=== +| Request Header | Description + +| `authorization` +| Required. Contains a JWT token (user) + +| `x-account-id` +| Contains the tenancy account ID and can be included depending on the API call + +| `username` +| Contains SMB or SFTP username when calling the APIs related to SMB + +| `password` +| Contains SMB or SFTP password when calling the APIs related to SMB + +| `domain` +| Contains SMB domain when calling the APIs related to SMB + +| `access-key` +| Contains an AWS access key when calling the APIs related to StorageGRID, IBM, or ONTAP S3 + +| `secret-key` +| Contains an AWS access key when calling the APIs related to StorageGRID, IBM, or ONTAP S3 + +| `storage-account-connection-string` +| Contains an Azure storage account connection string when calling the APIs related to Azure storage accounts + +| `x-bucket-name` +| Contains a bucket name when calling the AWS list S3 private links API + +| `private-key` +| Contains a Google drive private key when calling the Google drive APIs + +| `client-email` +| Contains a Google drive client email when calling the Google drive APIs + +| `subject` +| Contains a Google drive subject when calling the Google drive APIs + +| `client-secret` +| Contains a Box client secret when calling the Box APIs + +| `public-key-id` +| Contains a Box public key ID when calling the Box APIs + +| `private-key` +| Contains a Box private key ID when calling the Box APIs + +| `passphrase` +| Contains a Box passphrase ID when calling the Box APIs + +| `x-netapp-external-request-id-src` +| Contains an ID to use when accessing the external vault + +| `x-netapp-external-request-id-trg` +| Contains an ID to use when accessing the external vault +|=== + +=== Query parameters + +A list of all the possible query parameters available for each service component is provided in the table below. This is a summary by component, however not every query parameter can be used with each endpoint in a specific component. See the detailed descriptions of the individual API calls for more details. + +|=== +| Component | Query Parameter + +| Accounts +| noCreate (optional) + +target (required) + + + +| Messages +| last (optional) + + + +| Data Brokers +| host (required) + +version(optional + +path(optional) + +isEFS(optional) + +exportName(required) + +accessPoint(optional) + +bucket(required) + +prefix(optional) + +port(optional) + +storageAccountName(required) + +container(required) + +region(required) + + + +| Groups +| host (required) + +port(optional) + +rootDirectory(required) + +version(optional) + +path(optional) + +isEFS(optional) + +exportName(required) + +accessPoint(optional) + +bucket(required) + +prefix(optional) + +port(required/optional) + +storageAccountName(required) + +container(required) + +driveId(required) + +folderId(optional or required) + +folderName(optional) + +clientId(required) + +enterpriseId(required) + +appName(optional) + +region(required) + + + +| Relationships +| relationships (required) + + + +| Storages +| provider (optional) + + + +| Reports +| reports (required) + + +|=== + +=== Response headers + +This API uses the standard HTTP response headers common with all NetApp Console APIs. See https://docs.netapp.com/us-en/cloud-manager-automation/platform/http_details.html#response-headers[REST implementation] for more information. + +=== HTTP status codes + +|=== +| HTTP Status Code | Description + +| `200` +| OK: Returned for successful operation completion + +| `400` +| Bad Request: Returned if the input is malformed and could not be parsed + +| `401` +| Unauthorized: Returned if user authentication failed or the token has expired + +| `403` +| Forbidden: Returned for authorization errors depending on the resource and token + +| `404` +| Not Found: Returned if the requested resource could not be found + +| `500` +| Processing Error: Returned if an error occurs on the server while processing the API call +|=== + +''' + +== Error handling + +The following processes are involved with error handling and processing: + +* The error is logged for supportability. +* The error is also returned to the API caller on synchronous operations. +* In case of asynchronous operations, the error will be returned on the GET /messages API. +== cURL examples + +The following example retrieves relationships for a specific account: + +`+curl -X GET https://api.cloudsync.netapp.com/api/relationships-v2 -H "accept: application/json" -H "authorization: " -H "x-account-id:"+` + +The following example retrieves reports for a specific account: + +`+curl -X GET https://api.cloudsync.netapp.com/api/accounts//reports -H "accept: application/json" -H "authorization: "+` + +{blank} + + + + + diff --git a/copysync/post-api-accounts-reports.adoc b/copysync/post-api-accounts-reports.adoc new file mode 100644 index 00000000..e14d77b3 --- /dev/null +++ b/copysync/post-api-accounts-reports.adoc @@ -0,0 +1,1064 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/post-api-accounts-reports.html' +summary: 'Create a new report' +--- + += Create a new report + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/api/accounts/{accountId}/reports`# + + + +Creates a new report. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|endpoint +|link:#endpoint[endpoint] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "endpoint": { + "protocol": "string", + "cifs": { + "host": "string", + "share": "string", + "provider": "string", + "path": "string", + "version": "string", + "workingEnvironmentId": "string", + "credentials": { + "username": "string", + "password": "string", + "domain": "string" + } + }, + "nfs": { + "host": "string", + "export": "string", + "provider": "string", + "path": "string", + "version": "string", + "workingEnvironmentId": "string", + "accessPoint": "string" + }, + "s3": { + "host": "string", + "bucket": "string", + "prefix": "string", + "region": "string", + "encryption": { + "protocol": "string", + "keyId": "string" + }, + "privateLinkDns": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ], + "storageClass": "string", + "provider": "string", + "workingEnvironmentId": "string" + }, + "local": { + "path": "string" + }, + "azure": { + "container": "string", + "storageAccountName": "string", + "prefix": "string", + "path": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ], + "blobTier": "string", + "provider": "string" + }, + "gcp": { + "bucket": "string", + "prefix": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ], + "storageClass": "string", + "kmsKeyName": "string", + "provider": "string" + }, + "gdrive": { + "driveId": "string", + "driveName": "string", + "folderId": "string", + "path": "string", + "provider": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ], + "subject": "string" + }, + "box": { + "rootDirectory": "string", + "path": "string", + "folderId": "string", + "clientId": "string", + "appName": "string", + "enterpriseId": "string", + "provider": "string" + } + } +} +==== + +== Response + +``` +Status: 202, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|The Report internal ID + + +|endpoint +|link:#endpoint[endpoint] +|True +a| + +|statistics +|link:#statistics[statistics] +|True +a|Statistics of the given endpoint + + +|status +|string +|True +a|Reporter status + + +|startTime +|string +|True +a|Start time + + +|endTime +|string +|False +a|End time + + +|duration +|number +|True +a|Total execution time of the reported + + +|reason +|string +|False +a|Failure reason + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#credentials] +[.api-collapsible-fifth-title] +credentials + +CIFS credentials + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|True +a|User name + + +|password +|string +|True +a|password + + +|domain +|string +|False +a|Domain + + +|=== + + +[#cifs] +[.api-collapsible-fifth-title] +cifs + +CIFS Details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|CIFS host + + +|share +|string +|True +a|CIFS share + + +|provider +|string +|True +a|CIFS type + + +|path +|string +|False +a|CIFS path + + +|version +|string +|False +a|Supported CIFS versions + + +|workingEnvironmentId +|string +|False +a|Relevant system ID + + +|credentials +|link:#credentials[credentials] +|False +a|CIFS credentials + + +|=== + + +[#nfs] +[.api-collapsible-fifth-title] +nfs + +NFS Details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|NFS host + + +|export +|string +|True +a|NFS export + + +|provider +|string +|True +a|NFS type + + +|path +|string +|False +a|NFS path + + +|version +|string +|False +a|Supported NFS versions + + +|workingEnvironmentId +|string +|False +a|Relevant system ID + + +|accessPoint +|string +|False +a|EFS access point + + +|=== + + +[#encryption] +[.api-collapsible-fifth-title] +encryption + +S3 encryption + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|protocol +|string +|False +a|Encryption type + + +|keyId +|string +|False +a|Encryption key arn in case it is kms encryption + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|False +a|Tag Key + + +|value +|string +|False +a|Tag Value + + +|=== + + +[#glacier] +[.api-collapsible-fifth-title] +glacier + +Glacier storage class restore information (available only for s3 as source endpoint) + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|days +|number +|True +a|Lifetime of the active copy in days + + +|tier +|string +|True +a|Glacier retrieval tier at which the restore will be processed + + +|=== + + +[#deepArchive] +[.api-collapsible-fifth-title] +deepArchive + +Deep Archive storage class restore information (available only for s3 as source endpoint) + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|days +|number +|True +a|Lifetime of the active copy in days + + +|tier +|string +|True +a|Deep Archive retrieval tier at which the restore will be processed + + +|=== + + +[#s3] +[.api-collapsible-fifth-title] +s3 + +S3 details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|False +a|SGWS or IBM or ONTAP host + + +|port +|integer +|False +a|SGWS or IBM or ONTAP port + + +|bucket +|string +|True +a|Bucket + + +|prefix +|string +|False +a|Prefix + + +|region +|string +|False +a|Bucket region + + +|encryption +|link:#encryption[encryption] +|False +a|S3 encryption + + +|privateLinkDns +|string +|False +a|AWS S3 Private Link DNS + + +|tags +|array[link:#tags[tags]] +|False +a| + +|storageClass +|string +|False +a|S3 Storage Class + + +|provider +|string +|True +a|Object Storage Type + + +|workingEnvironmentId +|string +|False +a|Relevant system ID - for storageGrid system + + +|glacier +|link:#glacier[glacier] +|False +a|Glacier storage class restore information (available only for s3 as source endpoint) + + +|deepArchive +|link:#deepArchive[deepArchive] +|False +a|Deep Archive storage class restore information (available only for s3 as source endpoint) + + +|=== + + +[#local] +[.api-collapsible-fifth-title] +local + +Local object details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|path +|string +|True +a|Local Path + + +|=== + + +[#azure] +[.api-collapsible-fifth-title] +azure + +Azure Blob Storage Details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|container +|string +|True +a|Azure Blob Storage container name + + +|storageAccountName +|string +|False +a|Azure Blob Storage account name + + +|prefix +|string +|False +a|Container blob prefix + + +|path +|string +|False +a|Container path, used in azure data lake storage + + +|tags +|array[link:#tags[tags]] +|False +a| + +|blobTier +|string +|False +a|Blob tier type + + +|provider +|string +|True +a|Azure type + + +|=== + + +[#gcp] +[.api-collapsible-fifth-title] +gcp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|bucket +|string +|True +a|GCP Bucket + + +|prefix +|string +|False +a|GCP Bucket prefix + + +|tags +|array[link:#tags[tags]] +|False +a| + +|storageClass +|string +|False +a|GCP Storage Class + + +|kmsKeyName +|string +|False +a|GCP Kms name + + +|provider +|string +|True +a|GCP Type + + +|=== + + +[#gdrive] +[.api-collapsible-fifth-title] +gdrive + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|driveId +|string +|True +a|Drive Id + + +|driveName +|string +|False +a|Drive Name + + +|folderId +|string +|False +a|Google Drive folderId + + +|path +|string +|False +a|Folder path + + +|provider +|string +|True +a|Google Drive Type + + +|tags +|array[link:#tags[tags]] +|False +a| + +|subject +|string +|True +a|subject - user email + + +|=== + + +[#sftp] +[.api-collapsible-fifth-title] +sftp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|SFTP host + + +|port +|integer +|True +a|SFTP port number + + +|path +|string +|False +a|Directory path + + +|rootDirectory +|string +|True +a|Root Directory path + + +|provider +|string +|True +a|SFTP Type + + +|=== + + +[#box] +[.api-collapsible-fifth-title] +box + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|rootDirectory +|string +|False +a|Root Directory + + +|path +|string +|False +a|path + + +|folderId +|string +|True +a|Folder ID + + +|clientId +|string +|True +a|Client ID + + +|appName +|string +|False +a|Box Application Name + + +|enterpriseId +|string +|False +a|Enterprise Id + + +|provider +|string +|True +a|Box Type + + +|=== + + +[#endpoint] +[.api-collapsible-fifth-title] +endpoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|protocol +|string +|False +a|Endpoint protocol + + +|cifs +|link:#cifs[cifs] +|False +a|CIFS Details + + +|nfs +|link:#nfs[nfs] +|False +a|NFS Details + + +|s3 +|link:#s3[s3] +|False +a|S3 details + + +|local +|link:#local[local] +|False +a|Local object details + + +|azure +|link:#azure[azure] +|False +a|Azure Blob Storage Details + + +|gcp +|link:#gcp[gcp] +|False +a| + +|gdrive +|link:#gdrive[gdrive] +|False +a| + +|sftp +|link:#sftp[sftp] +|False +a| + +|box +|link:#box[box] +|False +a| + +|=== + + +[#errors] +[.api-collapsible-fifth-title] +errors + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error Code + + +|counter +|number +|False +a|How many times this error code appeared + + +|description +|string +|False +a|Error code description + + +|=== + + +[#totals] +[.api-collapsible-fifth-title] +totals + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|directories +|number +|False +a|Number of directories + + +|files +|number +|False +a|Number of files + + +|others +|number +|False +a|Number of others + + +|objects +|number +|False +a|Number of objects + + +|emptyObjects +|number +|False +a|Number of empty objects + + +|size +|number +|False +a|Total size + + +|failed +|number +|False +a|Total failed objects + + +|=== + + +[#statistics] +[.api-collapsible-fifth-title] +statistics + +Statistics of the given endpoint + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errors +|array[link:#errors[errors]] +|False +a| + +|totals +|link:#totals[totals] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/copysync/post-api-data-brokers.adoc b/copysync/post-api-data-brokers.adoc new file mode 100644 index 00000000..3eb0df3b --- /dev/null +++ b/copysync/post-api-data-brokers.adoc @@ -0,0 +1,175 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/post-api-data-brokers.html' +summary: 'Create a new installer for the NetApp data broker instance' +--- + += Create a new installer for the NetApp data broker instance + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/api/data-brokers`# + + + +Creates a new installer for the NetApp data broker instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|groupId +|string +|False +a| + +|port +|number +|False +a| + +|certificate +|string +|False +a|For Listener data broker - if the user wants his own certificate + + +|privateKey +|string +|False +a|For Listener data broker - if the user wants his own certificate + + +|serverName +|string +|False +a|For Listener data broker - if the user wants his own certificate + + +|type +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "groupId": "string", + "certificate": "string", + "privateKey": "string", + "serverName": "string", + "type": "string" +} +==== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Data Broker ID + + +|groupId +|string +|True +a|Data Broker group ID + + +|type +|string +|True +a|Data Broker type + + +|latestVersion +|string +|False +a|Data Broker latest version available + + +|fileLink +|string +|True +a|Data Broker installer or template link + + +|name +|string +|True +a|Data Broker name + + +|template +|["string", "object"] +|False +a|Data Broker template - relevant for GCP/AZURE/AWS + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "string", + "groupId": "string", + "type": "string", + "latestVersion": "string", + "fileLink": "string", + "name": "string" +} +==== + diff --git a/copysync/post-api-relationships-v2.adoc b/copysync/post-api-relationships-v2.adoc new file mode 100644 index 00000000..a79ee9a8 --- /dev/null +++ b/copysync/post-api-relationships-v2.adoc @@ -0,0 +1,3769 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/post-api-relationships-v2.html' +summary: 'Create a new relationship' +--- + += Create a new relationship + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/api/relationships-v2`# + + + +Creates a new relationship. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|x-netapp-external-request-id-src +|string +|header +|False +a|Source request ID header + + +|x-netapp-external-request-id-trg +|string +|header +|False +a|Target request ID header + + +|x-source-edge +|string +|header +|False +a|Edge cluster UUID + + +|x-target-edge +|string +|header +|False +a|Edge cluster UUID + + +|x-sync-source +|string +|header +|False +a|Is source Edge + + +|x-sync-target +|string +|header +|False +a|is target Edge + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dataBrokerId +|string +|False +a|Data Broker ID - this is deprecated - use `groupId` instead + + +|groupId +|string +|False +a|Data broker group ID + + +|source +|link:#source[source] +|True +a| + +|sourceCredentials +|link:#sourceCredentials[sourceCredentials] +|False +a| + +|target +|link:#target[target] +|True +a| + +|targetCredentials +|link:#targetCredentials[targetCredentials] +|False +a| + +|encryption +|link:#encryption[encryption] +|False +a| + +|group +|link:#group[group] +|False +a| + +|settings +|link:#settings[settings] +|False +a| + +|activity +|link:#activity[activity] +|False +a| + +|createdAt +|number +|False +a|Relationship Creation time + + +|customHeaders +|link:#customHeaders[customHeaders] +|False +a|Custom headers for the relationship + + +|extraInformation +|link:#extraInformation[extraInformation] +|False +a| + +|tags +|array[link:#tags[tags]] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dataBrokerId": "string", + "groupId": "string", + "source": { + "protocol": "string", + "cifs": { + "host": "string", + "share": "string", + "provider": "string", + "path": "string", + "version": "string", + "workingEnvironmentId": "string", + "credentials": { + "username": "string", + "password": "string", + "domain": "string" + } + }, + "nfs": { + "host": "string", + "export": "string", + "provider": "string", + "path": "string", + "version": "string", + "workingEnvironmentId": "string", + "accessPoint": "string" + }, + "s3": { + "host": "string", + "bucket": "string", + "prefix": "string", + "region": "string", + "encryption": { + "protocol": "string", + "keyId": "string" + }, + "privateLinkDns": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ], + "storageClass": "string", + "provider": "string", + "workingEnvironmentId": "string", + "credentials": { + "accessKey": "string", + "secretKey": "string" + } + }, + "local": { + "path": "string" + }, + "azure": { + "container": "string", + "storageAccountName": "string", + "prefix": "string", + "path": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ], + "blobTier": "string", + "provider": "string", + "credentials": { + "storageAccountConnectionString": "string" + } + }, + "gcp": { + "bucket": "string", + "prefix": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ], + "storageClass": "string", + "kmsKeyName": "string", + "provider": "string" + }, + "box": { + "rootDirectory": "string", + "path": "string", + "folderId": "string", + "clientId": "string", + "appName": "string", + "enterpriseId": "string", + "provider": "string", + "credentials": { + "clientSecret": "string", + "publicKeyId": "string", + "privateKey": "string", + "passphrase": "string" + } + }, + "gdrive": { + "driveId": "string", + "driveName": "string", + "folderId": "string", + "path": "string", + "provider": "string", + "subject": "string", + "credentials": { + "clientEmail": "string", + "privateKey": "string" + }, + "tags": [ + { + "key": "string", + "value": "string" + } + ] + } + }, + "sourceCredentials": { + "sftp": { + "username": "string", + "password": "string" + }, + "cifs": { + "username": "string", + "password": "string", + "domain": "string" + }, + "s3": { + "accessKey": "string", + "secretKey": "string" + }, + "azure": { + "storageAccountConnectionString": "string" + }, + "box": { + "clientSecret": "string", + "publicKeyId": "string", + "privateKey": "string", + "passphrase": "string" + }, + "gdrive": { + "clientEmail": "string", + "privateKey": "string" + } + }, + "target": { + "protocol": "string", + "cifs": { + "host": "string", + "share": "string", + "provider": "string", + "path": "string", + "version": "string", + "workingEnvironmentId": "string", + "credentials": { + "username": "string", + "password": "string", + "domain": "string" + } + }, + "nfs": { + "host": "string", + "export": "string", + "provider": "string", + "path": "string", + "version": "string", + "workingEnvironmentId": "string", + "accessPoint": "string" + }, + "s3": { + "host": "string", + "bucket": "string", + "prefix": "string", + "region": "string", + "encryption": { + "protocol": "string", + "keyId": "string" + }, + "privateLinkDns": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ], + "storageClass": "string", + "provider": "string", + "workingEnvironmentId": "string", + "credentials": { + "accessKey": "string", + "secretKey": "string" + } + }, + "local": { + "path": "string" + }, + "azure": { + "container": "string", + "storageAccountName": "string", + "prefix": "string", + "path": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ], + "blobTier": "string", + "provider": "string", + "credentials": { + "storageAccountConnectionString": "string" + } + }, + "gcp": { + "bucket": "string", + "prefix": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ], + "storageClass": "string", + "kmsKeyName": "string", + "provider": "string" + }, + "box": { + "rootDirectory": "string", + "path": "string", + "folderId": "string", + "clientId": "string", + "appName": "string", + "enterpriseId": "string", + "provider": "string", + "credentials": { + "clientSecret": "string", + "publicKeyId": "string", + "privateKey": "string", + "passphrase": "string" + } + }, + "gdrive": { + "driveId": "string", + "driveName": "string", + "folderId": "string", + "path": "string", + "provider": "string", + "subject": "string", + "credentials": { + "clientEmail": "string", + "privateKey": "string" + }, + "tags": [ + { + "key": "string", + "value": "string" + } + ] + } + }, + "targetCredentials": { + "sftp": { + "username": "string", + "password": "string" + }, + "cifs": { + "username": "string", + "password": "string", + "domain": "string" + }, + "s3": { + "accessKey": "string", + "secretKey": "string" + }, + "azure": { + "storageAccountConnectionString": "string" + }, + "box": { + "clientSecret": "string", + "publicKeyId": "string", + "privateKey": "string", + "passphrase": "string" + }, + "gdrive": { + "clientEmail": "string", + "privateKey": "string" + } + }, + "group": { + "id": "string", + "name": "string", + "dataBrokers": [ + { + "id": "string", + "type": "string", + "name": "string", + "status": "string", + "message": "string", + "fileLink": "string", + "latestVersion": "string", + "encryptionType": "string", + "groupId": "string", + "placement": { + "instanceId": "string", + "hostname": "string", + "privateIp": "string", + "region": "string", + "availabilityZone": "string", + "vpcId": "string", + "vpcCidrBlock": "string", + "subnetId": "string", + "subnetCidrBlock": "string", + "version": "string", + "awsAccountId": "string", + "vault": "string", + "node": "string", + "cpu": "string", + "processMaxMem": "string", + "osTotalMem": "string", + "release": "string", + "os": "string", + "distribution": "string", + "resourceGroupName": "string", + "zone": "string", + "serviceAccount": "string", + "gcpProjectId": "string", + "platform": "string", + "proxy": "string" + } + } + ], + "createdAt": "string" + }, + "settings": { + "files": { + "excludeExtensions": [ + "string" + ], + "excludeByRegex": [ + "string" + ], + "minDate": "string", + "minCreationDate": "string" + }, + "directories": { + "excludeNames": [ + "string" + ], + "excludeByRegex": [ + "string" + ] + }, + "schedule": { + "nextTime": "string" + } + }, + "activity": { + "syncType": "string", + "status": "string", + "type": "string", + "endTime": "string", + "startTime": "string", + "failureMessage": "string", + "lastMessageTime": "string", + "topFiveMostCommonRelationshipErrors": [ + { + "step": "string", + "errorCode": "string", + "description": "string" + } + ], + "errors": [ + { + "dataBrokerId": "string", + "reason": "string" + } + ] + }, + "customHeaders": { + "x-netapp-external-request-id-src": "string", + "x-netapp-external-request-id-trg": "string", + "x-source-edge": "string", + "x-target-edge": "string", + "x-sync-source": "string", + "x-sync-target": "string" + }, + "extraInformation": { + "dataSenseQueryUid": "string", + "connectorId": "string" + }, + "tags": [ + { + "key": "string", + "value": "string" + } + ] +} +==== + +== Response + +``` +Status: 202, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Relationship ID + + +|isCM +|string +|False +a|Was the relationship created through CloudManager + + +|dataBroker +|string +|False +a|Data Broker ID + + +|relationshipId +|string +|False +a|Relationship ID + + +|source +|link:#source[source] +|True +a| + +|target +|link:#target[target] +|True +a| + +|encryption +|link:#encryption[encryption] +|False +a| + +|group +|string +|False +a|Group ID + + +|settings +|link:#settings[settings] +|False +a| + +|activity +|link:#activity[activity] +|False +a| + +|createdAt +|number +|True +a|Relationship Creation time + + +|customHeaders +|link:#customHeaders[customHeaders] +|False +a|Custom headers for the relationship + + +|extraInformation +|link:#extraInformation[extraInformation] +|False +a| + +|tags +|array[link:#tags[tags]] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#credentials] +[.api-collapsible-fifth-title] +credentials + +CIFS credentials + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|True +a|User name + + +|password +|string +|True +a|password + + +|domain +|string +|False +a|Domain + + +|=== + + +[#cifs] +[.api-collapsible-fifth-title] +cifs + +CIFS Details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|CIFS host + + +|share +|string +|True +a|CIFS share + + +|provider +|string +|True +a|CIFS type + + +|path +|string +|False +a|CIFS path + + +|version +|string +|False +a|Supported CIFS versions + + +|workingEnvironmentId +|string +|False +a|Relevant system ID + + +|credentials +|link:#credentials[credentials] +|False +a|CIFS credentials + + +|=== + + +[#nfs] +[.api-collapsible-fifth-title] +nfs + +NFS Details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|NFS host + + +|export +|string +|True +a|NFS export + + +|provider +|string +|True +a|NFS type + + +|path +|string +|False +a|NFS path + + +|version +|string +|False +a|Supported NFS versions + + +|workingEnvironmentId +|string +|False +a|Relevant system ID + + +|accessPoint +|string +|False +a|EFS access point + + +|=== + + +[#encryption] +[.api-collapsible-fifth-title] +encryption + +S3 encryption + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|protocol +|string +|False +a|Encryption type + + +|keyId +|string +|False +a|Encryption key arn in case it is kms encryption + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|False +a|Tag Key + + +|value +|string +|False +a|Tag Value + + +|=== + + +[#glacier] +[.api-collapsible-fifth-title] +glacier + +Glacier storage class restore information (available only for s3 as source endpoint) + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|days +|number +|True +a|Lifetime of the active copy in days + + +|tier +|string +|True +a|Glacier retrieval tier at which the restore will be processed + + +|=== + + +[#deepArchive] +[.api-collapsible-fifth-title] +deepArchive + +Deep Archive storage class restore information (available only for s3 as source endpoint) + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|days +|number +|True +a|Lifetime of the active copy in days + + +|tier +|string +|True +a|Deep Archive retrieval tier at which the restore will be processed + + +|=== + + +[#credentials] +[.api-collapsible-fifth-title] +credentials + +S3 provider credentials + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accessKey +|string +|True +a|Access Key + + +|secretKey +|string +|True +a|Secret Key + + +|=== + + +[#s3] +[.api-collapsible-fifth-title] +s3 + +S3 details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|False +a|SGWS or IBM or ONTAP host + + +|port +|integer +|False +a|SGWS or IBM or ONTAP port + + +|bucket +|string +|True +a|Bucket + + +|prefix +|string +|False +a|Prefix + + +|region +|string +|False +a|Bucket region + + +|encryption +|link:#encryption[encryption] +|False +a|S3 encryption + + +|privateLinkDns +|string +|False +a|AWS S3 Private Link DNS + + +|tags +|array[link:#tags[tags]] +|False +a| + +|storageClass +|string +|False +a|S3 Storage Class + + +|provider +|string +|True +a|Object Storage Type + + +|workingEnvironmentId +|string +|False +a|Relevant system ID - for storageGrid system + + +|glacier +|link:#glacier[glacier] +|False +a|Glacier storage class restore information (available only for s3 as source endpoint) + + +|deepArchive +|link:#deepArchive[deepArchive] +|False +a|Deep Archive storage class restore information (available only for s3 as source endpoint) + + +|credentials +|link:#credentials[credentials] +|False +a|S3 provider credentials + + +|=== + + +[#local] +[.api-collapsible-fifth-title] +local + +Local object details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|path +|string +|True +a|Local Path + + +|=== + + +[#credentials] +[.api-collapsible-fifth-title] +credentials + +Azure Blob Storage Credentials + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storageAccountConnectionString +|string +|False +a|Azure Blob Storage account Connection string ( for blob to blob copy should be SaS-Connection-String) + + +|=== + + +[#azure] +[.api-collapsible-fifth-title] +azure + +Azure Blob Storage Details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|container +|string +|True +a|Azure Blob Storage container name + + +|storageAccountName +|string +|False +a|Azure Blob Storage account name + + +|prefix +|string +|False +a|Container blob prefix + + +|path +|string +|False +a|Container path, used in azure data lake storage + + +|tags +|array[link:#tags[tags]] +|False +a| + +|blobTier +|string +|False +a|Blob tier type + + +|provider +|string +|True +a|Azure type + + +|credentials +|link:#credentials[credentials] +|False +a|Azure Blob Storage Credentials + + +|=== + + +[#gcp] +[.api-collapsible-fifth-title] +gcp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|bucket +|string +|True +a|GCP Bucket + + +|prefix +|string +|False +a|GCP Bucket prefix + + +|tags +|array[link:#tags[tags]] +|False +a| + +|storageClass +|string +|False +a|GCP Storage Class + + +|kmsKeyName +|string +|False +a|GCP Kms name + + +|provider +|string +|True +a|GCP Type + + +|=== + + +[#credentials] +[.api-collapsible-fifth-title] +credentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|False +a|UserName + + +|password +|string +|False +a|Password + + +|=== + + +[#sftp] +[.api-collapsible-fifth-title] +sftp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|SFTP host + + +|port +|integer +|True +a|SFTP port number + + +|path +|string +|False +a|Directory path + + +|rootDirectory +|string +|True +a|Root Directory path + + +|provider +|string +|True +a|SFTP Type + + +|credentials +|link:#credentials[credentials] +|True +a| + +|=== + + +[#credentials] +[.api-collapsible-fifth-title] +credentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clientSecret +|string +|True +a|Client secret + + +|publicKeyId +|string +|True +a|Public Key Id + + +|privateKey +|string +|True +a|Private Key + + +|passphrase +|string +|True +a|Passphrase + + +|=== + + +[#box] +[.api-collapsible-fifth-title] +box + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|rootDirectory +|string +|False +a|Root Directory + + +|path +|string +|False +a|path + + +|folderId +|string +|True +a|Folder ID + + +|clientId +|string +|True +a|Client ID + + +|appName +|string +|False +a|Box Application Name + + +|enterpriseId +|string +|True +a|Enterprise Id + + +|provider +|string +|True +a|Box Type + + +|credentials +|link:#credentials[credentials] +|True +a| + +|=== + + +[#credentials] +[.api-collapsible-fifth-title] +credentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clientEmail +|string +|True +a|Service Account email + + +|privateKey +|string +|True +a|Private Key + + +|=== + + +[#gdrive] +[.api-collapsible-fifth-title] +gdrive + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|driveId +|string +|True +a|Drive Id + + +|driveName +|string +|False +a|Drive Name + + +|folderId +|string +|False +a|Google Drive folderId - Relevant in case of Download + + +|path +|string +|False +a|Folder path - full path ( not including driveId ) + + +|provider +|string +|True +a|Google Drive Type + + +|subject +|string +|True +a|subject - user email + + +|credentials +|link:#credentials[credentials] +|True +a| + +|tags +|array[link:#tags[tags]] +|False +a| + +|=== + + +[#source] +[.api-collapsible-fifth-title] +source + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|protocol +|string +|False +a|Endpoint protocol + + +|cifs +|link:#cifs[cifs] +|False +a|CIFS Details + + +|nfs +|link:#nfs[nfs] +|False +a|NFS Details + + +|s3 +|link:#s3[s3] +|False +a|S3 details + + +|local +|link:#local[local] +|False +a|Local object details + + +|azure +|link:#azure[azure] +|False +a|Azure Blob Storage Details + + +|gcp +|link:#gcp[gcp] +|False +a| + +|sftp +|link:#sftp[sftp] +|False +a| + +|box +|link:#box[box] +|False +a| + +|gdrive +|link:#gdrive[gdrive] +|False +a| + +|=== + + +[#sftp] +[.api-collapsible-fifth-title] +sftp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|False +a|UserName + + +|password +|string +|False +a|Password + + +|=== + + +[#cifs] +[.api-collapsible-fifth-title] +cifs + +CIFS credentials + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|True +a|User name + + +|password +|string +|True +a|password + + +|domain +|string +|False +a|Domain + + +|=== + + +[#s3] +[.api-collapsible-fifth-title] +s3 + +S3 provider credentials + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accessKey +|string +|True +a|Access Key + + +|secretKey +|string +|True +a|Secret Key + + +|=== + + +[#azure] +[.api-collapsible-fifth-title] +azure + +Azure Blob Storage Credentials + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storageAccountConnectionString +|string +|False +a|Azure Blob Storage account Connection string ( for blob to blob copy should be SaS-Connection-String) + + +|=== + + +[#box] +[.api-collapsible-fifth-title] +box + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clientSecret +|string +|True +a|Client secret + + +|publicKeyId +|string +|True +a|Public Key Id + + +|privateKey +|string +|True +a|Private Key + + +|passphrase +|string +|True +a|Passphrase + + +|=== + + +[#gdrive] +[.api-collapsible-fifth-title] +gdrive + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clientEmail +|string +|True +a|Service Account email + + +|privateKey +|string +|True +a|Private Key + + +|=== + + +[#sourceCredentials] +[.api-collapsible-fifth-title] +sourceCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sftp +|link:#sftp[sftp] +|False +a| + +|cifs +|link:#cifs[cifs] +|False +a|CIFS credentials + + +|s3 +|link:#s3[s3] +|False +a|S3 provider credentials + + +|azure +|link:#azure[azure] +|False +a|Azure Blob Storage Credentials + + +|box +|link:#box[box] +|False +a| + +|gdrive +|link:#gdrive[gdrive] +|False +a| + +|=== + + +[#target] +[.api-collapsible-fifth-title] +target + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|protocol +|string +|False +a|Endpoint protocol + + +|cifs +|link:#cifs[cifs] +|False +a|CIFS Details + + +|nfs +|link:#nfs[nfs] +|False +a|NFS Details + + +|s3 +|link:#s3[s3] +|False +a|S3 details + + +|local +|link:#local[local] +|False +a|Local object details + + +|azure +|link:#azure[azure] +|False +a|Azure Blob Storage Details + + +|gcp +|link:#gcp[gcp] +|False +a| + +|sftp +|link:#sftp[sftp] +|False +a| + +|box +|link:#box[box] +|False +a| + +|gdrive +|link:#gdrive[gdrive] +|False +a| + +|=== + + +[#targetCredentials] +[.api-collapsible-fifth-title] +targetCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sftp +|link:#sftp[sftp] +|False +a| + +|cifs +|link:#cifs[cifs] +|False +a|CIFS credentials + + +|s3 +|link:#s3[s3] +|False +a|S3 provider credentials + + +|azure +|link:#azure[azure] +|False +a|Azure Blob Storage Credentials + + +|box +|link:#box[box] +|False +a| + +|gdrive +|link:#gdrive[gdrive] +|False +a| + +|=== + + +[#initiator] +[.api-collapsible-fifth-title] +initiator + +Initiator details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dataBrokerId +|string +|False +a|Data Broker Id + + +|groupId +|string +|False +a|Group Id + + +|encryptionType +|string +|False +a|Data Broker network location - if initiator is src, listener must be trg + + +|=== + + +[#listener] +[.api-collapsible-fifth-title] +listener + +Listener details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dataBrokerId +|string +|False +a|Data Broker Id + + +|groupId +|string +|False +a|Group Id + + +|encryptionType +|string +|False +a|Data Broker network location - if initiator is src, listener must be trg + + +|=== + + +[#encryption] +[.api-collapsible-fifth-title] +encryption + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiator +|link:#initiator[initiator] +|False +a|Initiator details + + +|listener +|link:#listener[listener] +|False +a|Listener details + + +|=== + + +[#scanner] +[.api-collapsible-fifth-title] +scanner + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|processes +|number +|False +a|Scanner processes number + + +|processesLimit +|number +|False +a|Scanner processes limit number + + +|concurrency +|number +|False +a|How many tasks in parallel each scanner process handles + + +|=== + + +[#transferrer] +[.api-collapsible-fifth-title] +transferrer + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|processes +|number +|False +a|Transferrer processes number + + +|processesLimit +|number +|False +a|Scanner processes limit number + + +|concurrency +|number +|False +a|How many tasks in parallel each transferrer process handles + + +|=== + + +[#placement] +[.api-collapsible-fifth-title] +placement + +Data Broker placement information + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceId +|string +|False +a|Data Broker instance ID + + +|hostname +|string +|False +a|Data Broker host name + + +|privateIp +|string +|False +a|Data Broker private IP address + + +|region +|string +|False +a|Data Broker AWS Region + + +|availabilityZone +|string +|False +a|Data Broker AWS Subnet Availability Zone + + +|vpcId +|string +|False +a|Data Broker AWS VPC ID + + +|vpcCidrBlock +|string +|False +a|Data Broker AWS VPC CIDR block + + +|subnetId +|string +|False +a|Data Broker AWS Subnet ID + + +|subnetCidrBlock +|string +|False +a|Data Broker AWS Subnet CIDR block + + +|version +|string +|False +a|Data Broker version + + +|awsAccountId +|string +|False +a|AWS account ID in which the data broker was created + + +|vault +|string +|False +a|Vault version + + +|node +|string +|False +a|Node version + + +|canUpdateNodeVersion +|boolean +|False +a|Indicates if advanced node version is compatible with this distribution + + +|cpu +|string +|False +a|Data Broker number of cpus + + +|processMaxMem +|string +|False +a|Data Broker Max Memory for process + + +|osTotalMem +|string +|False +a|Data Broker Total memory + + +|release +|string +|False +a|Data Broker image release + + +|os +|string +|False +a|Data Broker OS + + +|distribution +|string +|False +a|Data Broker distribution + + +|resourceGroupName +|string +|False +a|Azure Data Broker resource group + + +|zone +|string +|False +a|Azure Data Broker zone + + +|serviceAccount +|string +|False +a|GCP Data Broker service account + + +|gcpProjectId +|string +|False +a|GCP project ID + + +|scanner +|link:#scanner[scanner] +|False +a| + +|transferrer +|link:#transferrer[transferrer] +|False +a| + +|platform +|string +|False +a|Data broker platform + + +|cpus +|number +|False +a|Number of Cpus + + +|proxy +|string +|False +a|Proxy string + + +|canUpdateProxy +|boolean +|False +a|Allow to change proxy configuration + + +|=== + + +[#dataBrokers] +[.api-collapsible-fifth-title] +dataBrokers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Data Broker ID + + +|type +|string +|False +a| + +|name +|string +|True +a|Data Broker Name + + +|status +|string +|False +a|'COMPLETE' for online data broker or 'FAILED' otherwise. Only available after the data broker has contacted the service for the first time + + +|message +|string +|False +a|The error message in case the data broker is in 'FAILED' status + + +|fileLink +|string +|False +a|The link to the Data Broker Cloud Formation template or installer + + +|transferRate +|number +|False +a|The Data broker current transfer rate + + +|lastPing +|integer +|False +a|The last time the Data Broker services did contact this service (EPOCH TIME) + + +|port +|integer +|False +a|In case this is a NetApp 'listener' Data Broker, this is the port that data broker listens on + + +|latestVersion +|string +|False +a|Latest Data Broker version available + + +|encryptionType +|string +|False +a|Data Broker Encryption type - in case it is part of nfs encrypted relationship + + +|groupId +|string +|False +a|Data Broker Group ID + + +|placement +|link:#placement[placement] +|False +a|Data Broker placement information + + +|=== + + +[#group] +[.api-collapsible-fifth-title] +group + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Group Id + + +|name +|string +|True +a|Group Name + + +|dataBrokers +|array[link:#dataBrokers[dataBrokers]] +|True +a|Data Brokers attached to the group + + +|createdAt +|string +|True +a|Group creation time + + +|=== + + +[#fileTypes] +[.api-collapsible-fifth-title] +fileTypes + +The file types that is included in the relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|files +|boolean +|False +a|Include files + + +|directories +|boolean +|False +a|Include directories + + +|symlinks +|boolean +|False +a|Include symbolic links + + +|hardlinks +|boolean +|False +a|include hard links + + +|=== + + +[#compareBy] +[.api-collapsible-fifth-title] +compareBy + +The file attributes that should be compared + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uid +|boolean +|False +a|uid ( relevant when source or target is file system ) + + +|gid +|boolean +|False +a|gid ( relevant when source or target is file system ) + + +|mtime +|boolean +|False +a|mtime + + +|mode +|boolean +|False +a|mode + + +|=== + + +[#copyProperties] +[.api-collapsible-fifth-title] +copyProperties + +The object properties that should be copied + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|metadata +|boolean +|False +a|copy metadata ( cloud to cloud ) + + +|tags +|boolean +|False +a|copy tags ( cloud to cloud only S3 compatible ) + + +|=== + + +[#files] +[.api-collapsible-fifth-title] +files + +Settings related to files. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|excludeExtensions +|array[string] +|False +a|Excluded extensions array (For example - [".log", ".tar.gz"]) + + +|excludeByRegex +|array[string] +|False +a|Excluded files by regex (For example - ".txt." will exclude the files file.doc.txt.gz) + + +|minSize +|integer +|False +a|Minimum file size (in bytes). Only files of equal or larger size will be transferred by the relationship + + +|maxSize +|integer +|False +a|Maximum file size (in bytes). Only files of equal or smaller size will be transferred by the relationship + + +|minDate +|string +|False +a|Data broker will sync files that were last modified after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21' + + +|maxDate +|["null", "string"] +|False +a|Data broker will sync files that were last modified before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date + + +|minCreationDate +|string +|False +a|Data broker will sync files that were created after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21' + + +|maxCreationDate +|["null", "string"] +|False +a|Data broker will sync files that were created before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date + + +|=== + + +[#directories] +[.api-collapsible-fifth-title] +directories + +Settings related to directories. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|excludeNames +|array[string] +|False +a|Excluded directories names array (For example - ["dir1"]) + + +|excludeByRegex +|array[string] +|False +a|Excluded directories names by regex (For example - "._tmp._." will exclude the directories with names that include tmp ) + + +|=== + + +[#schedule] +[.api-collapsible-fifth-title] +schedule + +Sync schedule settings. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|syncInDays +|integer +|False +a|Days interval for sync scheduler + + +|syncInHours +|integer +|False +a| + +|syncInMinutes +|integer +|False +a| + +|isEnabled +|boolean +|False +a|Activate automatic scheduler + + +|nextTime +|string +|False +a|The first time the relationship should run + + +|syncWhenCreated +|boolean +|False +a|Start the sync upon creation + + +|=== + + +[#cm] +[.api-collapsible-fifth-title] +cm + +NetApp Console notifications + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|done +|boolean +|False +a|Should send notification about DONE status + + +|failed +|boolean +|False +a|Should send notification about FAILED status + + +|aborted +|boolean +|False +a|Should send notification about ABORTED status + + +|running_continuously +|boolean +|False +a|Should send notification about RUNNING_CONTINUOUSLY status + + +|=== + + +[#notifications] +[.api-collapsible-fifth-title] +notifications + +Notifications settings. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cm +|link:#cm[cm] +|False +a|NetApp Console notifications + + +|=== + + +[#scheduleAbort] +[.api-collapsible-fifth-title] +scheduleAbort + +Schedule abort settings. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|abortInDays +|integer +|False +a|Days interval for abort scheduler + + +|abortInHours +|integer +|False +a|Hours interval for abort scheduler + + +|abortInMinutes +|integer +|False +a|Minutes interval for abort scheduler + + +|isEnabled +|boolean +|False +a|Activate automatic scheduler abort + + +|=== + + +[#settings] +[.api-collapsible-fifth-title] +settings + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|gracePeriod +|number +|False +a|Grace period time ( seconds ) + + +|deleteOnSource +|boolean +|False +a|Enable delete on source + + +|deleteOnTarget +|boolean +|False +a|Enable delete on target + + +|objectTagging +|boolean +|False +a|Use S3 tagging to store object metadata + + +|retries +|integer +|False +a|Number of retries + + +|copyAcl +|boolean +|False +a|Enable ACL copy + + +|copyData +|boolean +|False +a|Copy data only + + +|continuousSync +|boolean +|False +a|Listen to object notifications + + +|fileTypes +|link:#fileTypes[fileTypes] +|False +a|The file types that is included in the relationship + + +|compareBy +|link:#compareBy[compareBy] +|False +a|The file attributes that should be compared + + +|copyProperties +|link:#copyProperties[copyProperties] +|False +a|The object properties that should be copied + + +|files +|link:#files[files] +|False +a|Settings related to files. + + +|directories +|link:#directories[directories] +|False +a|Settings related to directories. + + +|schedule +|link:#schedule[schedule] +|False +a|Sync schedule settings. + + +|notifications +|link:#notifications[notifications] +|False +a|Notifications settings. + + +|scheduleAbort +|link:#scheduleAbort[scheduleAbort] +|False +a|Schedule abort settings. + + +|=== + + +[#topFiveMostCommonRelationshipErrors] +[.api-collapsible-fifth-title] +topFiveMostCommonRelationshipErrors + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|step +|string +|False +a|Sync step that failed - TRANSFER or SCAN + + +|errorCode +|string +|False +a|Error code + + +|counter +|number +|False +a|Number of errors + + +|description +|string +|False +a|Error description + + +|=== + + +[#errors] +[.api-collapsible-fifth-title] +errors + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dataBrokerId +|string +|False +a|Data Broker with initialized error + + +|reason +|string +|False +a|Error + + +|=== + + +[#activity] +[.api-collapsible-fifth-title] +activity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|syncType +|string +|False +a|field for UI - to indicate if we copy only acl or copy also data + + +|status +|string +|False +a|Relationship status + + +|type +|string +|False +a|Relationship phase - Initial copy or sync + + +|bytesMarkedForCopy +|number +|False +a|Bytes marked for copy + + +|filesMarkedForCopy +|number +|False +a|Files marked for copy + + +|dirsMarkedForCopy +|number +|False +a|Directories marked for copy + + +|filesCopied +|number +|False +a|Files copied + + +|bytesCopied +|number +|False +a|Bytes copied + + +|dirsCopied +|number +|False +a|Directories copied + + +|filesFailed +|number +|False +a|files failed to copy + + +|bytesFailed +|number +|False +a|Bytes failed to copy + + +|dirsFailed +|number +|False +a|Directories failed to copy + + +|filesMarkedForRemove +|number +|False +a|Files marked for remove + + +|bytesMarkedForRemove +|number +|False +a|Byes marked for remove + + +|dirsMarkedForRemove +|number +|False +a|Directories marked for remove + + +|filesRemoved +|number +|False +a|Files removed + + +|bytesRemoved +|number +|False +a|Bytes removed + + +|dirsRemoved +|number +|False +a|Directories removed + + +|bytesRemovedFailed +|number +|False +a|Bytes failed to remove + + +|filesRemovedFailed +|number +|False +a|Filed failed to remove + + +|filesMarkedForIgnore +|number +|False +a|Files marked for ignore + + +|dirsScanned +|number +|False +a|Directories scanned + + +|filesScanned +|number +|False +a|Files scanned + + +|bytesScanned +|number +|False +a|Bytes scanned + + +|dirsFailedToScan +|number +|False +a|Directories failed to scan + + +|timeEstimation +|number +|False +a|Time estimation until the end of the sync + + +|progress +|number +|False +a|Relationship progress + + +|endTime +|string +|False +a|End time + + +|startTime +|string +|False +a|Start time + + +|executionTime +|number +|False +a|Execution time + + +|failureMessage +|string +|False +a|Failure message + + +|lastMessageTime +|string +|False +a|Last message time + + +|topFiveMostCommonRelationshipErrors +|array[link:#topFiveMostCommonRelationshipErrors[topFiveMostCommonRelationshipErrors]] +|False +a| + +|errors +|array[link:#errors[errors]] +|False +a| + +|=== + + +[#customHeaders] +[.api-collapsible-fifth-title] +customHeaders + +Custom headers for the relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|x-netapp-external-request-id-src +|string +|False +a|Source request ID header + + +|x-netapp-external-request-id-trg +|string +|False +a|Target request ID header + + +|x-source-edge +|string +|False +a|Edge cluster UUID + + +|x-target-edge +|string +|False +a|Edge cluster UUID + + +|x-sync-source +|string +|False +a|Is source Edge + + +|x-sync-target +|string +|False +a|is target Edge + + +|=== + + +[#extraInformation] +[.api-collapsible-fifth-title] +extraInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dataSenseQueryUid +|string +|False +a|Data sense query uid + + +|connectorId +|string +|False +a|Console agent ID ( for data sense query ) + + +|=== + + +[#s3] +[.api-collapsible-fifth-title] +s3 + +S3 details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|False +a|SGWS or IBM or ONTAP host + + +|port +|integer +|False +a|SGWS or IBM or ONTAP port + + +|bucket +|string +|True +a|Bucket + + +|prefix +|string +|False +a|Prefix + + +|region +|string +|False +a|Bucket region + + +|encryption +|link:#encryption[encryption] +|False +a|S3 encryption + + +|privateLinkDns +|string +|False +a|AWS S3 Private Link DNS + + +|tags +|array[link:#tags[tags]] +|False +a| + +|storageClass +|string +|False +a|S3 Storage Class + + +|provider +|string +|True +a|Object Storage Type + + +|workingEnvironmentId +|string +|False +a|Relevant system ID - for storageGrid system + + +|glacier +|link:#glacier[glacier] +|False +a|Glacier storage class restore information (available only for s3 as source endpoint) + + +|deepArchive +|link:#deepArchive[deepArchive] +|False +a|Deep Archive storage class restore information (available only for s3 as source endpoint) + + +|=== + + +[#azure] +[.api-collapsible-fifth-title] +azure + +Azure Blob Storage Details + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|container +|string +|True +a|Azure Blob Storage container name + + +|storageAccountName +|string +|False +a|Azure Blob Storage account name + + +|prefix +|string +|False +a|Container blob prefix + + +|path +|string +|False +a|Container path, used in azure data lake storage + + +|tags +|array[link:#tags[tags]] +|False +a| + +|blobTier +|string +|False +a|Blob tier type + + +|provider +|string +|True +a|Azure type + + +|=== + + +[#gdrive] +[.api-collapsible-fifth-title] +gdrive + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|driveId +|string +|True +a|Drive Id + + +|driveName +|string +|False +a|Drive Name + + +|folderId +|string +|False +a|Google Drive folderId + + +|path +|string +|False +a|Folder path + + +|provider +|string +|True +a|Google Drive Type + + +|tags +|array[link:#tags[tags]] +|False +a| + +|subject +|string +|True +a|subject - user email + + +|=== + + +[#sftp] +[.api-collapsible-fifth-title] +sftp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|SFTP host + + +|port +|integer +|True +a|SFTP port number + + +|path +|string +|False +a|Directory path + + +|rootDirectory +|string +|True +a|Root Directory path + + +|provider +|string +|True +a|SFTP Type + + +|=== + + +[#box] +[.api-collapsible-fifth-title] +box + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|rootDirectory +|string +|False +a|Root Directory + + +|path +|string +|False +a|path + + +|folderId +|string +|True +a|Folder ID + + +|clientId +|string +|True +a|Client ID + + +|appName +|string +|False +a|Box Application Name + + +|enterpriseId +|string +|False +a|Enterprise Id + + +|provider +|string +|True +a|Box Type + + +|=== + + +[#source] +[.api-collapsible-fifth-title] +source + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|protocol +|string +|False +a|Endpoint protocol + + +|cifs +|link:#cifs[cifs] +|False +a|CIFS Details + + +|nfs +|link:#nfs[nfs] +|False +a|NFS Details + + +|s3 +|link:#s3[s3] +|False +a|S3 details + + +|local +|link:#local[local] +|False +a|Local object details + + +|azure +|link:#azure[azure] +|False +a|Azure Blob Storage Details + + +|gcp +|link:#gcp[gcp] +|False +a| + +|gdrive +|link:#gdrive[gdrive] +|False +a| + +|sftp +|link:#sftp[sftp] +|False +a| + +|box +|link:#box[box] +|False +a| + +|=== + + +[#target] +[.api-collapsible-fifth-title] +target + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|protocol +|string +|False +a|Endpoint protocol + + +|cifs +|link:#cifs[cifs] +|False +a|CIFS Details + + +|nfs +|link:#nfs[nfs] +|False +a|NFS Details + + +|s3 +|link:#s3[s3] +|False +a|S3 details + + +|local +|link:#local[local] +|False +a|Local object details + + +|azure +|link:#azure[azure] +|False +a|Azure Blob Storage Details + + +|gcp +|link:#gcp[gcp] +|False +a| + +|gdrive +|link:#gdrive[gdrive] +|False +a| + +|sftp +|link:#sftp[sftp] +|False +a| + +|box +|link:#box[box] +|False +a| + +|=== + + +[#settings] +[.api-collapsible-fifth-title] +settings + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|gracePeriod +|number +|True +a|Grace period time ( seconds ) + + +|deleteOnSource +|boolean +|True +a|Enable delete on source + + +|deleteOnTarget +|boolean +|True +a|Enable delete on target + + +|objectTagging +|boolean +|True +a|Use S3 tagging to store object metadata + + +|retries +|integer +|True +a|Number of retries + + +|copyAcl +|boolean +|False +a|Enable ACL copy + + +|copyData +|boolean +|True +a|Copy data only + + +|continuousSync +|boolean +|False +a|Listen to object notifications + + +|fileTypes +|link:#fileTypes[fileTypes] +|True +a|The file types that is included in the relationship + + +|compareBy +|link:#compareBy[compareBy] +|True +a|The file attributes that should be compared + + +|copyProperties +|link:#copyProperties[copyProperties] +|False +a|The object properties that should be copied + + +|files +|link:#files[files] +|True +a|Settings related to files. + + +|directories +|link:#directories[directories] +|True +a|Settings related to directories. + + +|schedule +|link:#schedule[schedule] +|True +a|Sync schedule settings. + + +|notifications +|link:#notifications[notifications] +|False +a|Notifications settings. + + +|scheduleAbort +|link:#scheduleAbort[scheduleAbort] +|True +a|Schedule abort settings. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/copysync/put-api-accounts-data-brokers-move.adoc b/copysync/put-api-accounts-data-brokers-move.adoc new file mode 100644 index 00000000..625540fb --- /dev/null +++ b/copysync/put-api-accounts-data-brokers-move.adoc @@ -0,0 +1,85 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/put-api-accounts-data-brokers-move.html' +summary: 'Move the data broker between groups' +--- + += Move the data broker between groups + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/api/accounts/{accountId}/data-brokers/{id}/move`# + + + +Moves the data broker between groups. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Broker ID + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|targetGroupId +|string +|False +a|Target Group ID + + +|targetGroupName +|string +|False +a|Target Group Name - use in case you want to move to a new group + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "targetGroupId": "string", + "targetGroupName": "string" +} +==== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/put-api-accounts-data-brokers-proxy.adoc b/copysync/put-api-accounts-data-brokers-proxy.adoc new file mode 100644 index 00000000..83659053 --- /dev/null +++ b/copysync/put-api-accounts-data-brokers-proxy.adoc @@ -0,0 +1,99 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/put-api-accounts-data-brokers-proxy.html' +summary: 'Update the proxy configuration for a data broker' +--- + += Update the proxy configuration for a data broker + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/api/accounts/{accountId}/data-brokers/{id}/proxy`# + + + +Updates the proxy configuration for a data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Broker ID + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|host +|string +|True +a|Proxy host + + +|port +|string +|True +a|Proxy port + + +|userName +|string +|False +a|Proxy userName + + +|password +|string +|False +a|Proxy password + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "host": "string", + "port": "string", + "userName": "string", + "password": "string" +} +==== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/put-api-accounts-data-brokers-restart.adoc b/copysync/put-api-accounts-data-brokers-restart.adoc new file mode 100644 index 00000000..19f43402 --- /dev/null +++ b/copysync/put-api-accounts-data-brokers-restart.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/put-api-accounts-data-brokers-restart.html' +summary: 'Restart a data broker' +--- + += Restart a data broker + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/api/accounts/{accountId}/data-brokers/{id}/restart`# + + + +Restarts a data broker. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Broker ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/put-api-accounts-groups-settings.adoc b/copysync/put-api-accounts-groups-settings.adoc new file mode 100644 index 00000000..5440d3ff --- /dev/null +++ b/copysync/put-api-accounts-groups-settings.adoc @@ -0,0 +1,586 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/put-api-accounts-groups-settings.html' +summary: 'Modify the group settings' +--- + += Modify the group settings + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/api/accounts/{accountId}/groups/{id}/settings`# + + + +Modifies the data broker group settings. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|id +|string +|path +|True +a|Data Brokers Group ID + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Group Name + + +|scanner +|link:#scanner[scanner] +|False +a| + +|transferrer +|link:#transferrer[transferrer] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string" +} +==== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Group ID + + +|name +|string +|True +a|Group Name + + +|dataBrokers +|array[link:#dataBrokers[dataBrokers]] +|True +a| + +|configuration +|link:#configuration[configuration] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "string", + "name": "string", + "dataBrokers": [ + { + "id": "string", + "type": "string", + "name": "string", + "status": "string", + "message": "string", + "fileLink": "string", + "latestVersion": "string", + "encryptionType": "string", + "groupId": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#scanner] +[.api-collapsible-fifth-title] +scanner + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|concurrency +|number +|False +a|Concurrency - Number of tasks running in parallel + + +|processesLimit +|number +|False +a|Processes Limit - Number of concurrent processes + + +|=== + + +[#transferrer] +[.api-collapsible-fifth-title] +transferrer + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|concurrency +|number +|False +a|Concurrency - Number of tasks running in parallel + + +|processesLimit +|number +|False +a|Processes Limit - Number of concurrent processes + + +|=== + + +[#scanner] +[.api-collapsible-fifth-title] +scanner + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|processes +|number +|True +a|Transferrer processes number + + +|processesLimit +|number +|False +a|Scanner processes limit number + + +|concurrency +|number +|True +a|How many tasks in parallel each transferrer process handles + + +|=== + + +[#transferrer] +[.api-collapsible-fifth-title] +transferrer + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|processes +|number +|True +a|Transferrer processes number + + +|processesLimit +|number +|False +a|Scanner processes limit number + + +|concurrency +|number +|True +a|How many tasks in parallel each transferrer process handles + + +|=== + + +[#placement] +[.api-collapsible-fifth-title] +placement + +Data Broker placement information + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceId +|string +|False +a|Data Broker instance ID + + +|hostname +|string +|True +a|Data Broker host name + + +|privateIp +|string +|False +a|Data Broker private IP address + + +|publicIp +|string +|False +a|Data Broker public ip IP address + + +|region +|string +|False +a|Data Broker Region + + +|availabilityZone +|string +|False +a|Data Broker Subnet Availability Zone + + +|vpcId +|string +|False +a|Data Broker AWS VPC ID + + +|vpcCidrBlock +|string +|False +a|Data Broker AWS VPC CIDR block + + +|subnetId +|string +|False +a|Data Broker AWS Subnet ID + + +|subnetCidrBlock +|string +|False +a|Data Broker AWS Subnet CIDR block + + +|version +|string +|True +a|Data Broker version + + +|awsAccountId +|string +|False +a|AWS account ID in which the data broker was created + + +|vault +|string +|False +a|Vault version + + +|node +|string +|True +a|Node version + + +|canUpdateNodeVersion +|boolean +|False +a|Indicates if advanced node version is compatible with this distribution + + +|cpu +|string +|False +a|Data Broker number of CPUs + + +|processMaxMem +|string +|True +a|Data Broker Maximum Memory for process + + +|osTotalMem +|string +|True +a|Data Broker Total memory + + +|release +|string +|True +a|Data Broker image release + + +|os +|string +|True +a|Data Broker OS + + +|distribution +|string +|False +a|Data Broker distribution + + +|resourceGroupName +|string +|False +a|Azure Data Broker resource group + + +|zone +|string +|False +a|Azure Data Broker zone + + +|serviceAccount +|string +|False +a|GCP Data Broker service account + + +|gcpProjectId +|string +|False +a|GCP project ID + + +|scanner +|link:#scanner[scanner] +|False +a| + +|transferrer +|link:#transferrer[transferrer] +|False +a| + +|platform +|string +|True +a|Data broker platform + + +|cpus +|number +|True +a|Number of CPUs + + +|proxy +|string +|False +a|Proxy string + + +|canUpdateProxy +|boolean +|False +a|Allow to change proxy configuration + + +|=== + + +[#dataBrokers] +[.api-collapsible-fifth-title] +dataBrokers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Data Broker ID + + +|type +|string +|True +a|Data Broker Type + + +|name +|string +|True +a|Data Broker Name + + +|status +|string +|False +a|'COMPLETE' for an online data broker or 'FAILED' otherwise. Only available after the data broker has contacted the service for the first time + + +|message +|string +|False +a|The error message if the data broker has a 'FAILED' status + + +|fileLink +|string +|False +a|The link to the Data Broker Cloud Formation template or installer + + +|transferRate +|number +|False +a|The Data broker current transfer rate + + +|lastPing +|number +|False +a|The last time the Data Broker services did contact this service (EPOCH TIME) + + +|port +|number +|False +a|If this is a NetApp 'listener' Data Broker, this is the port that data broker listens on + + +|latestVersion +|string +|False +a|Latest Data Broker version available + + +|encryptionType +|string +|False +a|Data Broker Encryption type - in case it is part of nfs encrypted relationship + + +|groupId +|string +|False +a|Data Broker Group Id + + +|placement +|link:#placement[placement] +|False +a|Data Broker placement information + + +|=== + + +[#configuration] +[.api-collapsible-fifth-title] +configuration + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanner +|link:#scanner[scanner] +|False +a| + +|transferrer +|link:#transferrer[transferrer] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/copysync/put-api-accounts-licenses-v2.adoc b/copysync/put-api-accounts-licenses-v2.adoc new file mode 100644 index 00000000..5c4268ff --- /dev/null +++ b/copysync/put-api-accounts-licenses-v2.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/put-api-accounts-licenses-v2.html' +summary: 'Add a license' +--- + += Add a license + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/api/accounts/{accountId}/licenses-v2`# + + + +Adds a license. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serialNumber +|string +|True +a|Serial number for license + + +|nssKeyId +|string +|True +a|NSS Key ID + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serialNumber": "string", + "nssKeyId": "string" +} +==== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serialNumber +|string +|True +a|The license's serial number + + +|reservedRelationships +|number +|True +a|The reserved relationships + + +|expirationDate +|number +|True +a|The license expiration date + + +|=== + + diff --git a/copysync/put-api-accounts-register.adoc b/copysync/put-api-accounts-register.adoc new file mode 100644 index 00000000..f5ed43eb --- /dev/null +++ b/copysync/put-api-accounts-register.adoc @@ -0,0 +1,78 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/put-api-accounts-register.html' +summary: 'Register an account to a marketplace' +--- + += Register an account to a marketplace + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/api/accounts/register`# + + + +Registers an account to a marketplace. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mpProvider +|string +|True +a|Customer subscription provider received from the marketplace + + +|mpCustomerToken +|string +|True +a|Customer subscription token received from the marketplace + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "mpProvider": "string", + "mpCustomerToken": "string" +} +==== + +== Response + +``` +Status: 200, Default Response +``` + diff --git a/copysync/put-api-accounts-relationships-credentials.adoc b/copysync/put-api-accounts-relationships-credentials.adoc new file mode 100644 index 00000000..4ba4d69a --- /dev/null +++ b/copysync/put-api-accounts-relationships-credentials.adoc @@ -0,0 +1,417 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/put-api-accounts-relationships-credentials.html' +summary: 'Modify the source or target credentials' +--- + += Modify the source or target credentials + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/api/accounts/{accountId}/relationships/{id}/credentials`# + + + +Modifies the source or target credentials. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|id +|string +|path +|True +a|Relationship ID + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|source +|link:#source[source] +|False +a| + +|target +|link:#target[target] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "source": { + "sftp": { + "username": "string", + "password": "string" + }, + "cifs": { + "username": "string", + "password": "string", + "domain": "string" + }, + "s3": { + "accessKey": "string", + "secretKey": "string" + }, + "azure": { + "storageAccountConnectionString": "string" + }, + "box": { + "clientSecret": "string", + "publicKeyId": "string", + "privateKey": "string", + "passphrase": "string" + }, + "gdrive": { + "clientEmail": "string", + "privateKey": "string" + } + }, + "target": { + "sftp": { + "username": "string", + "password": "string" + }, + "cifs": { + "username": "string", + "password": "string", + "domain": "string" + }, + "s3": { + "accessKey": "string", + "secretKey": "string" + }, + "azure": { + "storageAccountConnectionString": "string" + }, + "box": { + "clientSecret": "string", + "publicKeyId": "string", + "privateKey": "string", + "passphrase": "string" + }, + "gdrive": { + "clientEmail": "string", + "privateKey": "string" + } + } +} +==== + +== Response + +``` +Status: 202, Default Response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#sftp] +[.api-collapsible-fifth-title] +sftp + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|False +a|UserName + + +|password +|string +|False +a|Password + + +|=== + + +[#cifs] +[.api-collapsible-fifth-title] +cifs + +CIFS credentials + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|True +a|User name + + +|password +|string +|True +a|password + + +|domain +|string +|False +a|Domain + + +|=== + + +[#s3] +[.api-collapsible-fifth-title] +s3 + +S3 provider credentials + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accessKey +|string +|True +a|Access Key + + +|secretKey +|string +|True +a|Secret Key + + +|=== + + +[#azure] +[.api-collapsible-fifth-title] +azure + +Azure Blob Storage Credentials + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|storageAccountConnectionString +|string +|False +a|Azure Blob Storage account Connection string ( for blob to blob copy should be SaS-Connection-String) + + +|=== + + +[#box] +[.api-collapsible-fifth-title] +box + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clientSecret +|string +|True +a|Client secret + + +|publicKeyId +|string +|True +a|Public Key Id + + +|privateKey +|string +|True +a|Private Key + + +|passphrase +|string +|True +a|Passphrase + + +|=== + + +[#gdrive] +[.api-collapsible-fifth-title] +gdrive + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clientEmail +|string +|True +a|Service Account email + + +|privateKey +|string +|True +a|Private Key + + +|=== + + +[#source] +[.api-collapsible-fifth-title] +source + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sftp +|link:#sftp[sftp] +|False +a| + +|cifs +|link:#cifs[cifs] +|False +a|CIFS credentials + + +|s3 +|link:#s3[s3] +|False +a|S3 provider credentials + + +|azure +|link:#azure[azure] +|False +a|Azure Blob Storage Credentials + + +|box +|link:#box[box] +|False +a| + +|gdrive +|link:#gdrive[gdrive] +|False +a| + +|=== + + +[#target] +[.api-collapsible-fifth-title] +target + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sftp +|link:#sftp[sftp] +|False +a| + +|cifs +|link:#cifs[cifs] +|False +a|CIFS credentials + + +|s3 +|link:#s3[s3] +|False +a|S3 provider credentials + + +|azure +|link:#azure[azure] +|False +a|Azure Blob Storage Credentials + + +|box +|link:#box[box] +|False +a| + +|gdrive +|link:#gdrive[gdrive] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/copysync/put-api-accounts-relationships-tags.adoc b/copysync/put-api-accounts-relationships-tags.adoc new file mode 100644 index 00000000..f705a143 --- /dev/null +++ b/copysync/put-api-accounts-relationships-tags.adoc @@ -0,0 +1,125 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/put-api-accounts-relationships-tags.html' +summary: 'Edit the relationship tags' +--- + += Edit the relationship tags + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/api/accounts/{accountId}/relationships/{id}/tags`# + + + +Edits the relationship tags. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|id +|string +|path +|True +a|Relationship ID + + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|add +|array[link:#add[add]] +|False +a| + +|remove +|array[string] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "add": [ + { + "key": "string", + "value": "string" + } + ], + "remove": [ + "string" + ] +} +==== + +== Response + +``` +Status: 200, Default Response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#add] +[.api-collapsible-fifth-title] +add + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|False +a|Tag Key + + +|value +|string +|False +a|Tag Value + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/copysync/put-api-groups-download-data-brokers-logs.adoc b/copysync/put-api-groups-download-data-brokers-logs.adoc new file mode 100644 index 00000000..1f3ccfd7 --- /dev/null +++ b/copysync/put-api-groups-download-data-brokers-logs.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/put-api-groups-download-data-brokers-logs.html' +summary: 'Download the data broker group logs' +--- + += Download the data broker group logs + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/api/groups/{id}/download-data-brokers-logs`# + + + +Downloads the data broker group logs. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|id +|string +|path +|True +a|Data Broker Group ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/put-api-relationships-abort.adoc b/copysync/put-api-relationships-abort.adoc new file mode 100644 index 00000000..f67b3965 --- /dev/null +++ b/copysync/put-api-relationships-abort.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/put-api-relationships-abort.html' +summary: 'Stop the relationship data sync' +--- + += Stop the relationship data sync + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/api/relationships/{id}/abort`# + + + +Stops a relationship data sync. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|id +|string +|path +|True +a|Relationship ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/put-api-relationships-sync.adoc b/copysync/put-api-relationships-sync.adoc new file mode 100644 index 00000000..cc025411 --- /dev/null +++ b/copysync/put-api-relationships-sync.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/put-api-relationships-sync.html' +summary: 'Initiate a relationship data sync' +--- + += Initiate a relationship data sync + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/api/relationships/{id}/sync`# + + + +Initiates a relationship data sync. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|id +|string +|path +|True +a|Relationship ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Response + +``` +Status: 202, Default Response +``` + diff --git a/copysync/put-api-relationships-v2-.adoc b/copysync/put-api-relationships-v2-.adoc new file mode 100644 index 00000000..ac2ff07a --- /dev/null +++ b/copysync/put-api-relationships-v2-.adoc @@ -0,0 +1,665 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/put-api-relationships-v2-.html' +summary: 'Update the settings for a relationship' +--- + += Update the settings for a relationship + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/api/relationships-v2/{id}`# + + + +Updates the settings for a relationship. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|id +|string +|path +|True +a|Relationship ID + + +|x-account-id +|string +|header +|True +a|NetApp tenancy account ID + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|gracePeriod +|number +|False +a|Grace period time ( seconds ) + + +|deleteOnSource +|boolean +|False +a|Enable delete on source + + +|deleteOnTarget +|boolean +|False +a|Enable delete on target + + +|objectTagging +|boolean +|False +a|Use S3 tagging to store object metadata + + +|retries +|integer +|False +a|Number of retries + + +|copyAcl +|boolean +|False +a|Enable ACL copy + + +|copyData +|boolean +|False +a|Copy data only + + +|continuousSync +|boolean +|False +a|Listen to object notifications + + +|fileTypes +|link:#fileTypes[fileTypes] +|False +a|The file types that is included in the relationship + + +|compareBy +|link:#compareBy[compareBy] +|False +a|The file attributes that should be compared + + +|copyProperties +|link:#copyProperties[copyProperties] +|False +a|The object properties that should be copied + + +|files +|link:#files[files] +|False +a|Settings related to files. + + +|directories +|link:#directories[directories] +|False +a|Settings related to directories. + + +|schedule +|link:#schedule[schedule] +|False +a|Sync schedule settings. + + +|notifications +|link:#notifications[notifications] +|False +a|Notifications settings. + + +|scheduleAbort +|link:#scheduleAbort[scheduleAbort] +|False +a|Schedule abort settings. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "files": { + "excludeExtensions": [ + "string" + ], + "excludeByRegex": [ + "string" + ], + "minDate": "string", + "minCreationDate": "string" + }, + "directories": { + "excludeNames": [ + "string" + ], + "excludeByRegex": [ + "string" + ] + }, + "schedule": { + "nextTime": "string" + } +} +==== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|gracePeriod +|number +|True +a|Grace period time ( seconds ) + + +|deleteOnSource +|boolean +|True +a|Enable delete on source + + +|deleteOnTarget +|boolean +|True +a|Enable delete on target + + +|objectTagging +|boolean +|True +a|Use S3 tagging to store object metadata + + +|retries +|integer +|True +a|Number of retries + + +|copyAcl +|boolean +|False +a|Enable ACL copy + + +|copyData +|boolean +|True +a|Copy data only + + +|continuousSync +|boolean +|False +a|Listen to object notifications + + +|fileTypes +|link:#fileTypes[fileTypes] +|True +a|The file types that is included in the relationship + + +|compareBy +|link:#compareBy[compareBy] +|True +a|The file attributes that should be compared + + +|copyProperties +|link:#copyProperties[copyProperties] +|False +a|The object properties that should be copied + + +|files +|link:#files[files] +|True +a|Settings related to files. + + +|directories +|link:#directories[directories] +|True +a|Settings related to directories. + + +|schedule +|link:#schedule[schedule] +|True +a|Sync schedule settings. + + +|notifications +|link:#notifications[notifications] +|False +a|Notifications settings. + + +|scheduleAbort +|link:#scheduleAbort[scheduleAbort] +|True +a|Schedule abort settings. + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#fileTypes] +[.api-collapsible-fifth-title] +fileTypes + +The file types that is included in the relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|files +|boolean +|False +a|Include files + + +|directories +|boolean +|False +a|Include directories + + +|symlinks +|boolean +|False +a|Include symbolic links + + +|hardlinks +|boolean +|False +a|include hard links + + +|=== + + +[#compareBy] +[.api-collapsible-fifth-title] +compareBy + +The file attributes that should be compared + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uid +|boolean +|False +a|uid ( relevant when source or target is file system ) + + +|gid +|boolean +|False +a|gid ( relevant when source or target is file system ) + + +|mtime +|boolean +|False +a|mtime + + +|mode +|boolean +|False +a|mode + + +|=== + + +[#copyProperties] +[.api-collapsible-fifth-title] +copyProperties + +The object properties that should be copied + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|metadata +|boolean +|False +a|copy metadata ( cloud to cloud ) + + +|tags +|boolean +|False +a|copy tags ( cloud to cloud only S3 compatible ) + + +|=== + + +[#files] +[.api-collapsible-fifth-title] +files + +Settings related to files. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|excludeExtensions +|array[string] +|False +a|Excluded extensions array (For example - [".log", ".tar.gz"]) + + +|excludeByRegex +|array[string] +|False +a|Excluded files by regex (For example - ".txt." will exclude the files file.doc.txt.gz) + + +|minSize +|integer +|False +a|Minimum file size (in bytes). Only files of equal or larger size will be transferred by the relationship + + +|maxSize +|integer +|False +a|Maximum file size (in bytes). Only files of equal or smaller size will be transferred by the relationship + + +|minDate +|string +|False +a|Data broker will sync files that were last modified after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21' + + +|maxDate +|["null", "string"] +|False +a|Data broker will sync files that were last modified before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date + + +|minCreationDate +|string +|False +a|Data broker will sync files that were created after this date. The date must be an ISO 8601 valid date. For example - '2012-02-21' + + +|maxCreationDate +|["null", "string"] +|False +a|Data broker will sync files that were created before this date. Insert 'null' to sync all future files. The date must be an ISO 8601 valid date + + +|=== + + +[#directories] +[.api-collapsible-fifth-title] +directories + +Settings related to directories. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|excludeNames +|array[string] +|False +a|Excluded directories names array (For example - ["dir1"]) + + +|excludeByRegex +|array[string] +|False +a|Excluded directories names by regex (For example - "._tmp._." will exclude the directories with names that include tmp ) + + +|=== + + +[#schedule] +[.api-collapsible-fifth-title] +schedule + +Sync schedule settings. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|syncInDays +|integer +|False +a|Days interval for sync scheduler + + +|syncInHours +|integer +|False +a| + +|syncInMinutes +|integer +|False +a| + +|isEnabled +|boolean +|False +a|Activate automatic scheduler + + +|nextTime +|string +|False +a|The first time the relationship should run + + +|syncWhenCreated +|boolean +|False +a|Start the sync upon creation + + +|=== + + +[#cm] +[.api-collapsible-fifth-title] +cm + +NetApp Console notifications + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|done +|boolean +|False +a|Should send notification about DONE status + + +|failed +|boolean +|False +a|Should send notification about FAILED status + + +|aborted +|boolean +|False +a|Should send notification about ABORTED status + + +|running_continuously +|boolean +|False +a|Should send notification about RUNNING_CONTINUOUSLY status + + +|=== + + +[#notifications] +[.api-collapsible-fifth-title] +notifications + +Notifications settings. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cm +|link:#cm[cm] +|False +a|NetApp Console notifications + + +|=== + + +[#scheduleAbort] +[.api-collapsible-fifth-title] +scheduleAbort + +Schedule abort settings. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|abortInDays +|integer +|False +a|Days interval for abort scheduler + + +|abortInHours +|integer +|False +a|Hours interval for abort scheduler + + +|abortInMinutes +|integer +|False +a|Minutes interval for abort scheduler + + +|isEnabled +|boolean +|False +a|Activate automatic scheduler abort + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/copysync/put-api-v2-accounts-nss-credentials.adoc b/copysync/put-api-v2-accounts-nss-credentials.adoc new file mode 100644 index 00000000..1547d7c4 --- /dev/null +++ b/copysync/put-api-v2-accounts-nss-credentials.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/put-api-v2-accounts-nss-credentials.html' +summary: 'Add NetApp support site credentials' +--- + += Add NetApp support site credentials + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/api/v2/accounts/{accountId}/nss-credentials`# + + + +Adds the NetApp Support Site credentials. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a|NetApp tenancy account ID + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nssUsername +|string +|True +a|NSS user + + +|nssPassword +|string +|True +a|NSS password + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nssUsername": "string", + "nssPassword": "string" +} +==== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nssKeyId +|string +|True +a|NSS key ID + + +|username +|string +|True +a|NSS username + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nssKeyId": "string", + "username": "string" +} +==== + diff --git a/copysync/relationships_overview.adoc b/copysync/relationships_overview.adoc new file mode 100644 index 00000000..4d08842a --- /dev/null +++ b/copysync/relationships_overview.adoc @@ -0,0 +1,26 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/relationships_overview.html' +summary: 'Relationships endpoints in the NetApp Copy and Sync REST API' +--- + += Relationships endpoints in the NetApp Copy and Sync REST API + + + +The relationships endpoints provide information about the sync relationships between source and target destinations in an account and enable you to perform various operations to manage the sync relationships. +The following actions can be performed with the relationships endpoints: + +* Retrieve sync relationship information (including statistics) +* Create a sync relationship +* Delete a sync relationship +* Change sync relationship settings +* Start a new sync on a relationship +* Stop a sync operation +* Update relationship endpoint credentials +* Update relationship tags +* Retrieve the identifier of the sync relationship (without all other properties) + + diff --git a/copysync/reports_overview.adoc b/copysync/reports_overview.adoc new file mode 100644 index 00000000..e08d1451 --- /dev/null +++ b/copysync/reports_overview.adoc @@ -0,0 +1,21 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/reports_overview.html' +summary: 'Reports endpoints in the NetApp Copy and Sync REST API' +--- + += Reports endpoints in the NetApp Copy and Sync REST API + + + +The report endpoints enable you to view reports of NetApp Console account such as the number of directories and files in an account, the distribution of file size, the depth and breadth of the directories, and more. You can also create or delete a report by using the report endpoints. +The following actions can be performed with the report endpoints: + +* Retrieve reports (including statistics of an account) +* Create a report +* Delete a report +* Abort a report + + diff --git a/copysync/sidebar.yml b/copysync/sidebar.yml deleted file mode 100644 index 1b1160f6..00000000 --- a/copysync/sidebar.yml +++ /dev/null @@ -1,3 +0,0 @@ -section: copysync -title: Copy and Sync -generate: copysync diff --git a/copysync/storages_overview.adoc b/copysync/storages_overview.adoc new file mode 100644 index 00000000..665b4b21 --- /dev/null +++ b/copysync/storages_overview.adoc @@ -0,0 +1,31 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/storages_overview.html' +summary: 'Storages endpoints in the NetApp Copy and Sync REST API' +--- + += Storages endpoints in the NetApp Copy and Sync REST API + + + +The storages endpoints provide information about the different source and target locations. +This API category displays only the endpoints that are part of a sync relationship in an account. + +You can retrieve the following information by using the storages API endpoints: + +* NFS hosts IP addresses +* SMB hosts IP addresses +* Azure storage accounts +* SFTP hosts IP addresses +* IBM hosts IP addresses +* StorageGRID hosts IP addresses +* Azure NetApp Files IP addresses +* Cloud Volumes ONTAP, On-premises, FSx Data LIF IP addresses +* ONTAP S3 endpoint IP addresses +* Amazon Elastic File System IP addresses +* Box app names +* Google drive subjects + + diff --git a/copysync/timelines_overview.adoc b/copysync/timelines_overview.adoc new file mode 100644 index 00000000..8728bb56 --- /dev/null +++ b/copysync/timelines_overview.adoc @@ -0,0 +1,16 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'copysync/timelines_overview.html' +summary: 'Timelines endpoints in the NetApp Copy and Sync REST API' +--- + += Timelines endpoints in the NetApp Copy and Sync REST API + + + +The timelines endpoints provide information about historic operations in an account (for example, create a relationship, sync relationships, and abort a relationship). +The timelines API endpoints are deprecated; use the https://docs.netapp.com/us-en/console-automation/audit/overview.html[Audit service API] to view your historic account-related operations. + + diff --git a/credential/aws_overview.adoc b/credential/aws_overview.adoc new file mode 100644 index 00000000..208384a3 --- /dev/null +++ b/credential/aws_overview.adoc @@ -0,0 +1,21 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/aws_overview.html' +summary: 'AWS endpoints in the Credentials REST API for the NetApp Console' +--- + += AWS endpoints in the Credentials REST API for the NetApp Console + + + +The AWS endpoints manage Amazon Resource Name (ARN) credentials. + +You can perform the following actions with the AWS endpoints: + +* Create ARN credentials +* Update ARN credentials +* Retrieve ARN credentials + + diff --git a/credential/azure_overview.adoc b/credential/azure_overview.adoc new file mode 100644 index 00000000..22a8eb60 --- /dev/null +++ b/credential/azure_overview.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/azure_overview.html' +summary: 'Azure endpoints in the Credentials REST API for the NetApp Console' +--- + += Azure endpoints in the Credentials REST API for the NetApp Console + + + +The Azure endpoints manage and encrypt Microsoft Azure service principal credentials. + +You can perform the following actions with the Azure endpoints: + +* Create service principal credentials +* Update service principal credentials +* Retrieve service principal credentials +* Generate a token from a credentials ID +* Generate a token from Azure credentials + + diff --git a/credential/credential-x-doc.json b/credential/credential-x-doc.json deleted file mode 100644 index 897d8184..00000000 --- a/credential/credential-x-doc.json +++ /dev/null @@ -1,153 +0,0 @@ -{ - "overview": "Credentials REST API for the NetApp Console", - "permalink": "overview.html", - "paths": { - "/health": { - "get": { - "x-doc": { - "title": "", - "category": "Health", - "filename": "get-health.html", - "explorer": false - } - } - }, - "/accounts/{accountPublicId}/azure/service-principal": { - "post": { - "x-doc": { - "title": "Add service principal credentials", - "category": "Azure", - "filename": "post-accounts-azure-service-principal.html", - "explorer": false - } - } - }, - "/accounts/{accountPublicId}/azure/service-principal/{credentialsId}": { - "patch": { - "x-doc": { - "title": "Update service principal credentials", - "category": "Azure", - "filename": "patch-accounts-azure-service-principal-.html", - "explorer": false - } - }, - "get": { - "x-doc": { - "title": "Retrieve credentials by ID", - "category": "Azure", - "filename": "get-accounts-azure-service-principal-.html", - "explorer": false - } - } - }, - "/accounts/{accountPublicId}/azure/service-principal/{credentialsId}/generate-token": { - "get": { - "x-doc": { - "title": "Generate token from ID", - "category": "Azure", - "filename": "get-accounts-azure-service-principal-generate-token.html", - "explorer": false - } - } - }, - "/azure/generate-token": { - "post": { - "x-doc": { - "title": "Generate Azure token", - "category": "Azure", - "filename": "post-azure-generate-token.html", - "explorer": false - } - } - }, - "/accounts/{accountPublicId}/credentials": { - "post": { - "x-doc": { - "title": "Add generic credentials", - "category": "Generic", - "filename": "post-accounts-credentials.html", - "explorer": false - } - }, - "get": { - "x-doc": { - "title": "Retrieve credentials by type", - "category": "Generic", - "filename": "get-accounts-credentials.html", - "explorer": false - } - } - }, - "/accounts/{accountPublicId}/credentials/{credentialsId}": { - "patch": { - "x-doc": { - "title": "Update generic credentials", - "category": "Generic", - "filename": "patch-accounts-credentials-.html", - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete credentials", - "category": "Generic", - "filename": "delete-accounts-credentials-.html", - "explorer": false - } - }, - "get": { - "x-doc": { - "title": "Retrieve credentials by ID", - "category": "Generic", - "filename": "get-accounts-credentials-.html", - "explorer": false - } - } - }, - "/accounts/{accountPublicId}/aws/assume-role": { - "post": { - "x-doc": { - "title": "Create credentials", - "category": "AWS", - "filename": "post-accounts-aws-assume-role.html", - "explorer": false - } - } - }, - "/accounts/{accountPublicId}/aws/assume-role/{credentialsId}": { - "patch": { - "x-doc": { - "title": "Update credentials", - "category": "AWS", - "filename": "patch-accounts-aws-assume-role-.html", - "explorer": false - } - }, - "get": { - "x-doc": { - "title": "Retrieve credentials using the ID", - "category": "AWS", - "filename": "get-accounts-aws-assume-role-.html", - "explorer": false - } - } - } - }, - "categories": [ - { - "id": "generic", - "title": "Generic endpoints in the Credentials REST API for the NetApp Console", - "permalink": "generic_overview.html" - }, - { - "id": "aws", - "title": "AWS endpoints in the Credentials REST API for the NetApp Console", - "permalink": "aws_overview.html" - }, - { - "id": "azure", - "title": "Azure endpoints in the Credentials REST API for the NetApp Console", - "permalink": "azure_overview.html" - } - ] -} \ No newline at end of file diff --git a/credential/credential.json b/credential/credential.json deleted file mode 100644 index 49907532..00000000 --- a/credential/credential.json +++ /dev/null @@ -1,1077 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "Credentials service API", - "description": "
Overview\n

The Credentials service is a NetApp Console service that provides a secure way to manage and encrypt credentials and sensitive data. The consumers of the service are both external users and internal services with the "credentials:internal" scope.

\n

The service manages three types of credentials:

\n
    \n
  • Generic
    • \n
  • AWS Amazon Resource Name (AWS ARN)
    • \n
  • Azure (Azure service principal)
    • \n
\n

In addition to the generic credentials, which can be any type of data, the service also provides dedicated endpoints for the following scenarios:

\n
    \n
  • \n

    ARN credentials are considered best practice for managing third-party permissions. The Credentials service manages customer ARNs and can provide temporary credentials for users or other services.
    \nARN credentials are not considered sensitive, so ARN data is not encrypted in a MongoDB database.

    \n

    When creating ARN credentials, the service automatically provides the credentials as type "aws_assume_role".
    \nFor more information, see AWS ARN Documentation.

    \n
    • \n
  • \n

    Azure service principal credentials manage and encrypt the service principal data (which is considered sensitive) and can provide a temporary token for users or internal services.

    \n

    When creating Azure service principal credentials, the service automatically provides the credentials as type "azure_service_principal".
    \nFor more information, see Azure Service Principal Documentation.

    \n
    • \n
\n

Note: Before using the API reference documentation, review the Get started section for the NetApp Console APIs.
\nFor more information about the security tokens and identifiers you’ll need when using the API, review the Common workflows and tasks section.

\n
\n
\n
\nREST implementation\n

HTTP methods

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MethodDescription
POSTCreate an object instance
GETRetrieve an object instance or collection
PUTUpdate an existing object's specified properties
DELETERemove an existing object
\n

Request headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Request HeaderDescription
AuthorizationRequired. Contains a JWT access token
x-simulatorUsed to determine whether credentials are simulated
\n

Query parameters

\n

You can use query parameters with endpoints in the following components:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Query ParameterDescription
credentialsTypeUsed for fetching a list of credentials by a specific credentials type
isGovUsed to determine whether the service principal is located in the AWS GovCloud (US) location
getDecryptedUsed to determine whether decrypted credentials are returned
\n

Response headers

\n

This API uses the standard HTTP response headers common with all NetApp Console service APIs. See REST implementation for more information.

\n

HTTP status codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP Status CodeDescription
200OK: Returned for successful operation completion
400Bad Request: Returned if the input is malformed and could not be parsed
401Unauthorized: Returned if user authentication failed or the token has expired
403Forbidden: Returned for authorization errors depending on the resource and token
404Not Found: Returned if the requested resource could not be found
500Processing Error: Returned if an error occurs on the server while processing the API call
\n
\n
\n
\nError handling\n

There are three processes involved with error handling and processing:

\n
    \n
  • The error is logged for supportability
    • \n
  • The error is returned to the caller for specific handling
    • \n
  • The database connection is rolled back
    • \n
\n
\n
\n
\ncURL examples\n

Retrieve generic credentials

\n

The following cURL example retrieves generic credentials by using a specified account ID and credentials ID.

\n
curl -X GET "https://cloudmanager.cloud.netapp.com/credentials/account/<accountId>/credentials/<credentialsId>\n" -H  "accept: application/json" -H  "authorization: <user token>"\n
\n
\n
\n

", - "version": "1.0", - "contact": {} - }, - "tags": [ - { - "name": "Generic", - "description": "
Overview\n

The generic endpoints manage and encrypt any type of credentials.

\n

You can perform the following actions with the generic endpoints:

\n
    \n
  • Create generic credentials
    • \n
  • Retrieve generic credentials
    • \n
  • Update generic credentials
    • \n
  • Delete generic credentials
    • \n
  • Retrieve generic credentials by credentials ID
    • \n
\n
\n" - }, - { - "name": "AWS", - "description": "
\nOverview\n

The AWS endpoints manage Amazon Resource Name (ARN) credentials.

\n

You can perform the following actions with the AWS endpoints:

\n
    \n
  • Create ARN credentials
    • \n
  • Update ARN credentials
    • \n
  • Retrieve ARN credentials
    • \n
\n
\n" - }, - { - "name": "Azure", - "description": "
\nOverview\n

The Azure endpoints manage and encrypt Microsoft Azure service principal credentials.

\n

You can perform the following actions with the Azure endpoints:

\n
    \n
  • Create service principal credentials
    • \n
  • Update service principal credentials
    • \n
  • Retrieve service principal credentials
    • \n
  • Generate a token from a credentials ID
    • \n
  • Generate a token from Azure credentials
    • \n
\n
\n" - } - ], - "servers": [ - { - "url": "/credentials/external" - } - ], - "components": { - "securitySchemes": { - "bearer": { - "scheme": "bearer", - "bearerFormat": "JWT", - "type": "http" - } - }, - "schemas": { - "ServicePrincipalRequest": { - "type": "object", - "properties": { - "tenantId": { - "type": "string" - }, - "clientId": { - "type": "string" - }, - "clientSecret": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "tenantId", - "clientId", - "clientSecret", - "name" - ] - }, - "saveCredentialsResponse": { - "type": "object", - "properties": { - "credentialsId": { - "type": "string", - "readOnly": true - }, - "credentialsType": { - "type": "string", - "readOnly": true - }, - "extra": { - "type": "object", - "readOnly": true - }, - "isSimulated": { - "type": "boolean", - "readOnly": true - } - }, - "required": [ - "credentialsId", - "credentialsType", - "extra", - "isSimulated" - ] - }, - "UpdateServicePrincipalRequest": { - "type": "object", - "properties": { - "tenantId": { - "type": "string" - }, - "clientId": { - "type": "string" - }, - "clientSecret": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "tenantId", - "clientId", - "clientSecret", - "name" - ] - }, - "GetServicePrincipalResponse": { - "type": "object", - "properties": { - "credentialsId": { - "type": "string" - }, - "clientId": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "credentialsType": { - "type": "string" - }, - "isSimulated": { - "type": "boolean" - } - }, - "required": [ - "credentialsId", - "clientId", - "tenantId", - "name", - "credentialsType", - "isSimulated" - ] - }, - "AzureTokenResponse": { - "type": "object", - "properties": { - "token": { - "type": "string" - } - }, - "required": [ - "token" - ] - }, - "GenerateAzureCredentialsRequest": { - "type": "object", - "properties": { - "tenantId": { - "type": "string" - }, - "clientId": { - "type": "string" - }, - "clientSecret": { - "type": "string" - } - }, - "required": [ - "tenantId", - "clientId", - "clientSecret" - ] - }, - "SaveCredentialsRequest": { - "type": "object", - "properties": { - "credentials": { - "type": "object" - }, - "credentialsType": { - "type": "string" - }, - "extra": { - "type": "object" - } - }, - "required": [ - "credentials", - "credentialsType" - ] - }, - "UpdateCredentialsRequest": { - "type": "object", - "properties": { - "credentials": { - "type": "object" - }, - "extra": { - "type": "object" - } - } - }, - "CredentialsItemResponse": { - "type": "object", - "properties": { - "credentialsId": { - "type": "string" - }, - "credentialsType": { - "type": "string" - }, - "extra": { - "type": "object" - }, - "credentials": { - "type": "object" - }, - "isSimulated": { - "type": "boolean" - } - }, - "required": [ - "credentialsId", - "credentialsType", - "extra", - "credentials", - "isSimulated" - ] - }, - "AssumeRoleRequest": { - "type": "object", - "properties": { - "arn": { - "type": "string" - }, - "name": { - "type": "string" - }, - "externalId": { - "type": "string" - } - }, - "required": [ - "arn", - "name" - ] - }, - "UpdateAssumeRoleRequest": { - "type": "object", - "properties": { - "arn": { - "type": "string" - }, - "name": { - "type": "string" - }, - "externalId": { - "type": "object" - } - } - }, - "GetAssumeRoleResponse": { - "type": "object", - "properties": { - "credentialsId": { - "type": "string" - }, - "arn": { - "type": "string" - }, - "externalId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "credentialsType": { - "type": "string" - }, - "isSimulated": { - "type": "boolean" - } - }, - "required": [ - "credentialsId", - "arn", - "name", - "credentialsType", - "isSimulated" - ] - } - } - }, - "paths": { - "/accounts/{accountPublicId}/azure/service-principal": { - "post": { - "operationId": "AzureController_addServicePrincipalCredentials", - "x-doc": { - "title": " ", - "category": " ", - "filename": " " - }, - "summary": "", - "description": "Creates new ARN credentials for a specified account public ID.\n
\n

Token usage: NetApp Console user token.

", - "parameters": [ - { - "name": "accountPublicId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "isGov", - "required": false, - "in": "query", - "description": "Indicates whether the service principal is located in the AWS GovCloud (US) location", - "schema": { - "type": "boolean" - } - }, - { - "name": "x-simulator", - "in": "header", - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServicePrincipalRequest" - } - } - } - }, - "responses": { - "200": { - "description": "Successful stored service principal credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/saveCredentialsResponse" - } - } - } - }, - "404": { - "description": "Account not found" - } - }, - "tags": [ - "Azure" - ], - "security": [ - { - "bearer": [] - } - ] - } - }, - "/accounts/{accountPublicId}/azure/service-principal/{credentialsId}": { - "patch": { - "operationId": "AzureController_updateServicePrincipalCredentials", - "x-doc": { - "title": " ", - "category": " ", - "filename": " " - }, - "summary": "", - "description": "Updates existing credentials using the specified account public ID.\n
\n

Token usage: NetApp Console user token.

", - "parameters": [ - { - "name": "accountPublicId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "credentialsId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateServicePrincipalRequest" - } - } - } - }, - "responses": { - "200": { - "description": "Successful updated service principal credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/saveCredentialsResponse" - } - } - } - }, - "404": { - "description": "Credentials not found" - } - }, - "tags": [ - "Azure" - ], - "security": [ - { - "bearer": [] - } - ] - }, - "get": { - "operationId": "AzureController_getCredentialsById", - "x-doc": { - "title": " ", - "category": " ", - "filename": " " - }, - "summary": "", - "description": "Retrieves an existing service principal using the specified account public ID.\n
\n

Token usage: Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header.

", - "parameters": [ - { - "name": "accountPublicId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "credentialsId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful fetched service principal credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetServicePrincipalResponse" - } - } - } - }, - "404": { - "description": "Credentials not found" - } - }, - "tags": [ - "Azure" - ], - "security": [ - { - "bearer": [] - } - ] - } - }, - "/accounts/{accountPublicId}/azure/service-principal/{credentialsId}/generate-token": { - "get": { - "operationId": "AzureController_generateTokenFromId", - "x-doc": { - "title": " ", - "category": " ", - "filename": " " - }, - "summary": "", - "description": "Generates an Azure token by using existing service principal credentials.\n
\n

Token usage: Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header.

", - "parameters": [ - { - "name": "accountPublicId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "credentialsId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful fetched generated token", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureTokenResponse" - } - } - } - }, - "404": { - "description": "Credentials not found" - } - }, - "tags": [ - "Azure" - ], - "security": [ - { - "bearer": [] - } - ] - } - }, - "/azure/generate-token": { - "post": { - "operationId": "AzureController_generateAzureToken", - "x-doc": { - "title": " ", - "category": " ", - "filename": " " - }, - "summary": "", - "description": "Generates an Azure token by using service principal credentials.\n
\n

Token usage: Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header.

", - "parameters": [ - { - "name": "x-simulator", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenerateAzureCredentialsRequest" - } - } - } - }, - "responses": { - "200": { - "description": "Successful fetched generated token", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureTokenResponse" - } - } - } - } - }, - "tags": [ - "Azure" - ], - "security": [ - { - "bearer": [] - } - ] - } - }, - "/accounts/{accountPublicId}/credentials": { - "post": { - "operationId": "GenericController_addGenericCredentials", - "x-doc": { - "title": " ", - "category": " ", - "filename": " " - }, - "summary": "", - "description": "Creates and encrypts new credentials for a specified account public ID.\n
\n

Token usage: Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header.

", - "parameters": [ - { - "name": "accountPublicId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulator", - "in": "header", - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SaveCredentialsRequest" - } - } - } - }, - "responses": { - "200": { - "description": "Successful stored generic credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/saveCredentialsResponse" - } - } - } - }, - "404": { - "description": "Account not found" - } - }, - "tags": [ - "Generic" - ], - "security": [ - { - "bearer": [] - } - ] - }, - "get": { - "operationId": "GenericController_getCredentialsByType", - "x-doc": { - "title": " ", - "category": " ", - "filename": " " - }, - "summary": "", - "description": "Retrieves a list of generic credentials by credentials type with a specified account public ID.\n
\n

Token usage: Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header.

", - "parameters": [ - { - "name": "accountPublicId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "credentialsType", - "required": true, - "in": "query", - "description": "The credentials type", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulator", - "in": "header", - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of credentials", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CredentialsItemResponse" - } - } - } - } - } - }, - "tags": [ - "Generic" - ], - "security": [ - { - "bearer": [] - } - ] - } - }, - "/accounts/{accountPublicId}/credentials/{credentialsId}": { - "patch": { - "operationId": "GenericController_updateGenericCredentials", - "x-doc": { - "title": " ", - "category": " ", - "filename": " " - }, - "summary": "", - "description": "Updates existing generic credentials.\n
\n

Token usage: Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header.

", - "parameters": [ - { - "name": "accountPublicId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "credentialsId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateCredentialsRequest" - } - } - } - }, - "responses": { - "200": { - "description": "Successful updated generic credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/saveCredentialsResponse" - } - } - } - }, - "404": { - "description": "Credentials not found" - } - }, - "tags": [ - "Generic" - ], - "security": [ - { - "bearer": [] - } - ] - }, - "delete": { - "operationId": "GenericController_deleteCredentials", - "x-doc": { - "title": " ", - "category": " ", - "filename": " " - }, - "summary": "", - "description": "Deletes generic credentials.\n
\n

Token usage: Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header.

", - "parameters": [ - { - "name": "accountPublicId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "credentialsId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful deleted generic credentials return OK", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Credentials not found" - } - }, - "tags": [ - "Generic" - ], - "security": [ - { - "bearer": [] - } - ] - }, - "get": { - "operationId": "GenericController_getCredentialsById", - "x-doc": { - "title": " ", - "category": " ", - "filename": " " - }, - "summary": "", - "description": "Retrieves specific generic credentials using the account public ID and credentials ID.\n
\n

Token usage: Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header.

", - "parameters": [ - { - "name": "accountPublicId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "credentialsId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "getDecrypted", - "required": false, - "in": "query", - "description": "Returns decrypted credentials when set to true. The default value is false", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "Successful fetched generic credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CredentialsItemResponse" - } - } - } - }, - "404": { - "description": "Credentials not found" - } - }, - "tags": [ - "Generic" - ], - "security": [ - { - "bearer": [] - } - ] - } - }, - "/accounts/{accountPublicId}/aws/assume-role": { - "post": { - "operationId": "AwsController_addAwsAssumeRoleCredentials", - "x-doc": { - "title": " ", - "category": " ", - "filename": " " - }, - "summary": "", - "description": "Creates new ARN credentials for a specified account.\n
\n

Token usage: NetApp Console user token.

", - "parameters": [ - { - "name": "accountPublicId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "isGov", - "required": true, - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulator", - "in": "header", - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AssumeRoleRequest" - } - } - } - }, - "responses": { - "200": { - "description": "Successful stored ARN credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/saveCredentialsResponse" - } - } - } - }, - "404": { - "description": "Account not found" - } - }, - "tags": [ - "AWS" - ], - "security": [ - { - "bearer": [] - } - ] - } - }, - "/accounts/{accountPublicId}/aws/assume-role/{credentialsId}": { - "patch": { - "operationId": "AwsController_updateAwsAssumeRoleCredentials", - "x-doc": { - "title": " ", - "category": " ", - "filename": " " - }, - "summary": "", - "description": "Updates existing credentials using the specified account public ID.\n
\n

Token usage: NetApp Console user token.

", - "parameters": [ - { - "name": "accountPublicId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "credentialsId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateAssumeRoleRequest" - } - } - } - }, - "responses": { - "200": { - "description": "Successful updated ARN credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/saveCredentialsResponse" - } - } - } - }, - "404": { - "description": "Credentials not found" - } - }, - "tags": [ - "AWS" - ], - "security": [ - { - "bearer": [] - } - ] - }, - "get": { - "operationId": "AwsController_getCredentialsById", - "x-doc": { - "title": " ", - "category": " ", - "filename": " " - }, - "summary": "", - "description": "Retrieves existing ARN credentials using the specified account public ID.\n
\n

Token usage: Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header.

", - "parameters": [ - { - "name": "accountPublicId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "credentialsId", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successful fetched ARN credentials", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetAssumeRoleResponse" - } - } - } - }, - "404": { - "description": "Credentials not found" - } - }, - "tags": [ - "AWS" - ], - "security": [ - { - "bearer": [] - } - ] - } - } - } -} \ No newline at end of file diff --git a/credential/delete-accounts-credentials-.adoc b/credential/delete-accounts-credentials-.adoc new file mode 100644 index 00000000..0abee4ae --- /dev/null +++ b/credential/delete-accounts-credentials-.adoc @@ -0,0 +1,57 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/delete-accounts-credentials-.html' +summary: 'Delete credentials' +--- + += Delete credentials + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/accounts/{accountPublicId}/credentials/{credentialsId}`# + + + +Deletes generic credentials. + +**Token usage:** Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountPublicId +|string +|path +|True +a| + +|credentialsId +|string +|path +|True +a| + +|=== + +== Response + +``` +Status: 200, Successful deleted generic credentials return OK +``` + + + +== Error + +``` +Status: 404, Credentials not found +``` + diff --git a/credential/generic_overview.adoc b/credential/generic_overview.adoc new file mode 100644 index 00000000..a5f82e19 --- /dev/null +++ b/credential/generic_overview.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/generic_overview.html' +summary: 'Generic endpoints in the Credentials REST API for the NetApp Console' +--- + += Generic endpoints in the Credentials REST API for the NetApp Console + + + +The generic endpoints manage and encrypt any type of credentials. + +You can perform the following actions with the generic endpoints: + +* Create generic credentials +* Retrieve generic credentials +* Update generic credentials +* Delete generic credentials +* Retrieve generic credentials by credentials ID + + diff --git a/credential/get-accounts-aws-assume-role-.adoc b/credential/get-accounts-aws-assume-role-.adoc new file mode 100644 index 00000000..34c73ac8 --- /dev/null +++ b/credential/get-accounts-aws-assume-role-.adoc @@ -0,0 +1,96 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/get-accounts-aws-assume-role-.html' +summary: 'Retrieve credentials using the ID' +--- + += Retrieve credentials using the ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/accounts/{accountPublicId}/aws/assume-role/{credentialsId}`# + + + +Retrieves existing ARN credentials using the specified account public ID. + +**Token usage:** Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountPublicId +|string +|path +|True +a| + +|credentialsId +|string +|path +|True +a| + +|=== + +== Response + +``` +Status: 200, Successful fetched ARN credentials +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentialsId +|string +|True +a| + +|arn +|string +|True +a| + +|externalId +|string +|False +a| + +|name +|string +|True +a| + +|credentialsType +|string +|True +a| + +|isSimulated +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: 404, Credentials not found +``` + diff --git a/credential/get-accounts-azure-service-principal-.adoc b/credential/get-accounts-azure-service-principal-.adoc new file mode 100644 index 00000000..c98c991c --- /dev/null +++ b/credential/get-accounts-azure-service-principal-.adoc @@ -0,0 +1,96 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/get-accounts-azure-service-principal-.html' +summary: 'Retrieve credentials by ID' +--- + += Retrieve credentials by ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/accounts/{accountPublicId}/azure/service-principal/{credentialsId}`# + + + +Retrieves an existing service principal using the specified account public ID. + +**Token usage:** Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountPublicId +|string +|path +|True +a| + +|credentialsId +|string +|path +|True +a| + +|=== + +== Response + +``` +Status: 200, Successful fetched service principal credentials +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentialsId +|string +|True +a| + +|clientId +|string +|True +a| + +|tenantId +|string +|True +a| + +|name +|string +|True +a| + +|credentialsType +|string +|True +a| + +|isSimulated +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: 404, Credentials not found +``` + diff --git a/credential/get-accounts-azure-service-principal-generate-token.adoc b/credential/get-accounts-azure-service-principal-generate-token.adoc new file mode 100644 index 00000000..7dc209b4 --- /dev/null +++ b/credential/get-accounts-azure-service-principal-generate-token.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/get-accounts-azure-service-principal-generate-token.html' +summary: 'Generate token from ID' +--- + += Generate token from ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/accounts/{accountPublicId}/azure/service-principal/{credentialsId}/generate-token`# + + + +Generates an Azure token by using existing service principal credentials. + +**Token usage:** Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountPublicId +|string +|path +|True +a| + +|credentialsId +|string +|path +|True +a| + +|=== + +== Response + +``` +Status: 200, Successful fetched generated token +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|token +|string +|True +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "token": "string" +} +==== + +== Error + +``` +Status: 404, Credentials not found +``` + diff --git a/credential/get-accounts-credentials-.adoc b/credential/get-accounts-credentials-.adoc new file mode 100644 index 00000000..59feb729 --- /dev/null +++ b/credential/get-accounts-credentials-.adoc @@ -0,0 +1,117 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/get-accounts-credentials-.html' +summary: 'Retrieve credentials by ID' +--- + += Retrieve credentials by ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/accounts/{accountPublicId}/credentials/{credentialsId}`# + + + +Retrieves specific generic credentials using the account public ID and credentials ID. + +**Token usage:** Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountPublicId +|string +|path +|True +a| + +|credentialsId +|string +|path +|True +a| + +|getDecrypted +|boolean +|query +|False +a|Returns decrypted credentials when set to true. The default value is false + + +|=== + +== Response + +``` +Status: 200, Successful fetched generic credentials +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentialsId +|string +|True +a| + +|credentialsType +|string +|True +a| + +|extra +|link:#extra[extra] +|True +a| + +|credentials +|link:#credentials[credentials] +|True +a| + +|isSimulated +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: 404, Credentials not found +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#extra] +[.api-collapsible-fifth-title] +extra + + +[#credentials] +[.api-collapsible-fifth-title] +credentials + + +//end collapsible .Definitions block +==== diff --git a/credential/get-accounts-credentials.adoc b/credential/get-accounts-credentials.adoc new file mode 100644 index 00000000..817dbc31 --- /dev/null +++ b/credential/get-accounts-credentials.adoc @@ -0,0 +1,111 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/get-accounts-credentials.html' +summary: 'Retrieve credentials by type' +--- + += Retrieve credentials by type + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/accounts/{accountPublicId}/credentials`# + + + +Retrieves a list of generic credentials by credentials type with a specified account public ID. + +**Token usage:** Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountPublicId +|string +|path +|True +a| + +|credentialsType +|string +|query +|True +a|The credentials type + + +|x-simulator +|string +|header +|False +a| + +|=== + +== Response + +``` +Status: 200, List of credentials +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentialsId +|string +|True +a| + +|credentialsType +|string +|True +a| + +|extra +|link:#extra[extra] +|True +a| + +|credentials +|link:#credentials[credentials] +|True +a| + +|isSimulated +|boolean +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#extra] +[.api-collapsible-fifth-title] +extra + + +[#credentials] +[.api-collapsible-fifth-title] +credentials + + +//end collapsible .Definitions block +==== diff --git a/credential/overview.adoc b/credential/overview.adoc new file mode 100644 index 00000000..27eb1f10 --- /dev/null +++ b/credential/overview.adoc @@ -0,0 +1,145 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/overview.html' +summary: 'Credentials REST API for the NetApp Console' +--- + += Credentials REST API for the NetApp Console + + + +The Credentials service is a NetApp Console service that provides a secure way to manage and encrypt credentials and sensitive data. The consumers of the service are both external users and internal services with the "credentials:internal" scope. + +The service manages three types of credentials: + +* Generic +* AWS Amazon Resource Name (AWS ARN) +* Azure (Azure service principal) + +In addition to the generic credentials, which can be any type of data, the service also provides dedicated endpoints for the following scenarios: + +* ARN credentials are considered best practice for managing third-party permissions. The Credentials service manages customer ARNs and can provide temporary credentials for users or other services. + +ARN credentials are not considered sensitive, so ARN data is not encrypted in a MongoDB database. + +When creating ARN credentials, the service automatically provides the credentials as type "aws_assume_role". + +For more information, see https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html[AWS ARN Documentation]. + +* Azure service principal credentials manage and encrypt the service principal data (which is considered sensitive) and can provide a temporary token for users or internal services. + +When creating Azure service principal credentials, the service automatically provides the credentials as type "azure_service_principal". + +For more information, see https://docs.microsoft.com/en-us/azure/active-directory/develop/app-objects-and-service-principals[Azure Service Principal Documentation]. + +**Note:** Before using the API reference documentation, review the https://docs.netapp.com/us-en/console-automation/platform/overview.html[Get started] section for the NetApp Console APIs. + +For more information about the security tokens and identifiers you'll need when using the API, review the https://docs.netapp.com/us-en/console-automation/platform/get_identifiers.html[Common workflows and tasks] section. + +''' + +== REST implementation + +=== HTTP methods + +|=== +| Method | Description + +| `POST` +| Create an object instance + +| `GET` +| Retrieve an object instance or collection + +| `PUT` +| Update an existing object's specified properties + +| `DELETE` +| Remove an existing object +|=== + +=== Request headers + +|=== +| Request Header | Description + +| `Authorization` +| Required. Contains a JWT access token + +| `x-simulator` +| Used to determine whether credentials are simulated +|=== + +=== Query parameters + +You can use query parameters with endpoints in the following components: + +|=== +| Query Parameter | Description + +| `credentialsType` +| Used for fetching a list of credentials by a specific credentials type + +| `isGov` +| Used to determine whether the service principal is located in the AWS GovCloud (US) location + +| `getDecrypted` +| Used to determine whether decrypted credentials are returned +|=== + +=== Response headers + +This API uses the standard HTTP response headers common with all NetApp Console service APIs. See https://docs.netapp.com/us-en/console-automation/platform/http_details.html#response-headers[REST implementation] for more information. + +=== HTTP status codes + +|=== +| HTTP Status Code | Description + +| `200` +| OK: Returned for successful operation completion + +| `400` +| Bad Request: Returned if the input is malformed and could not be parsed + +| `401` +| Unauthorized: Returned if user authentication failed or the token has expired + +| `403` +| Forbidden: Returned for authorization errors depending on the resource and token + +| `404` +| Not Found: Returned if the requested resource could not be found + +| `500` +| Processing Error: Returned if an error occurs on the server while processing the API call +|=== + +''' + +== Error handling + +There are three processes involved with error handling and processing: + +* The error is logged for supportability +* The error is returned to the caller for specific handling +* The database connection is rolled back + +''' + +== cURL examples + +=== Retrieve generic credentials + +The following cURL example retrieves generic credentials by using a specified account ID and credentials ID. + +.... + + curl -X GET "https://cloudmanager.cloud.netapp.com/credentials/account//credentials/ +" -H "accept: application/json" -H "authorization: " +.... + +''' + +{blank} + + + + + diff --git a/credential/patch-accounts-aws-assume-role-.adoc b/credential/patch-accounts-aws-assume-role-.adoc new file mode 100644 index 00000000..50fcb3c4 --- /dev/null +++ b/credential/patch-accounts-aws-assume-role-.adoc @@ -0,0 +1,144 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/patch-accounts-aws-assume-role-.html' +summary: 'Update credentials' +--- + += Update credentials + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/accounts/{accountPublicId}/aws/assume-role/{credentialsId}`# + + + +Updates existing credentials using the specified account public ID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountPublicId +|string +|path +|True +a| + +|credentialsId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|arn +|string +|False +a| + +|name +|string +|False +a| + +|externalId +|link:#externalId[externalId] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "arn": "string", + "name": "string" +} +==== + +== Response + +``` +Status: 200, Successful updated ARN credentials +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentialsId +|string +|True +a| + +|credentialsType +|string +|True +a| + +|extra +|link:#extra[extra] +|True +a| + +|isSimulated +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: 404, Credentials not found +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#externalId] +[.api-collapsible-fifth-title] +externalId + + +[#extra] +[.api-collapsible-fifth-title] +extra + + +//end collapsible .Definitions block +==== diff --git a/credential/patch-accounts-azure-service-principal-.adoc b/credential/patch-accounts-azure-service-principal-.adoc new file mode 100644 index 00000000..23a4775d --- /dev/null +++ b/credential/patch-accounts-azure-service-principal-.adoc @@ -0,0 +1,146 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/patch-accounts-azure-service-principal-.html' +summary: 'Update service principal credentials' +--- + += Update service principal credentials + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/accounts/{accountPublicId}/azure/service-principal/{credentialsId}`# + + + +Updates existing credentials using the specified account public ID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountPublicId +|string +|path +|True +a| + +|credentialsId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tenantId +|string +|True +a| + +|clientId +|string +|True +a| + +|clientSecret +|string +|True +a| + +|name +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tenantId": "string", + "clientId": "string", + "clientSecret": "string", + "name": "string" +} +==== + +== Response + +``` +Status: 200, Successful updated service principal credentials +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentialsId +|string +|True +a| + +|credentialsType +|string +|True +a| + +|extra +|link:#extra[extra] +|True +a| + +|isSimulated +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: 404, Credentials not found +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#extra] +[.api-collapsible-fifth-title] +extra + + +//end collapsible .Definitions block +==== diff --git a/credential/patch-accounts-credentials-.adoc b/credential/patch-accounts-credentials-.adoc new file mode 100644 index 00000000..ec018477 --- /dev/null +++ b/credential/patch-accounts-credentials-.adoc @@ -0,0 +1,129 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/patch-accounts-credentials-.html' +summary: 'Update generic credentials' +--- + += Update generic credentials + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/accounts/{accountPublicId}/credentials/{credentialsId}`# + + + +Updates existing generic credentials. + +**Token usage:** Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountPublicId +|string +|path +|True +a| + +|credentialsId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentials +|link:#credentials[credentials] +|False +a| + +|extra +|link:#extra[extra] +|False +a| + +|=== + + +== Response + +``` +Status: 200, Successful updated generic credentials +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentialsId +|string +|True +a| + +|credentialsType +|string +|True +a| + +|extra +|link:#extra[extra] +|True +a| + +|isSimulated +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: 404, Credentials not found +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#credentials] +[.api-collapsible-fifth-title] +credentials + + +[#extra] +[.api-collapsible-fifth-title] +extra + + +//end collapsible .Definitions block +==== diff --git a/credential/post-accounts-aws-assume-role.adoc b/credential/post-accounts-aws-assume-role.adoc new file mode 100644 index 00000000..d6b55410 --- /dev/null +++ b/credential/post-accounts-aws-assume-role.adoc @@ -0,0 +1,146 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/post-accounts-aws-assume-role.html' +summary: 'Create credentials' +--- + += Create credentials + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/accounts/{accountPublicId}/aws/assume-role`# + + + +Creates new ARN credentials for a specified account. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountPublicId +|string +|path +|True +a| + +|isGov +|string +|query +|True +a| + +|x-simulator +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|arn +|string +|True +a| + +|name +|string +|True +a| + +|externalId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "arn": "string", + "name": "string", + "externalId": "string" +} +==== + +== Response + +``` +Status: 200, Successful stored ARN credentials +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentialsId +|string +|True +a| + +|credentialsType +|string +|True +a| + +|extra +|link:#extra[extra] +|True +a| + +|isSimulated +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: 404, Account not found +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#extra] +[.api-collapsible-fifth-title] +extra + + +//end collapsible .Definitions block +==== diff --git a/credential/post-accounts-azure-service-principal.adoc b/credential/post-accounts-azure-service-principal.adoc new file mode 100644 index 00000000..eba06da6 --- /dev/null +++ b/credential/post-accounts-azure-service-principal.adoc @@ -0,0 +1,153 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/post-accounts-azure-service-principal.html' +summary: 'Add service principal credentials' +--- + += Add service principal credentials + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/accounts/{accountPublicId}/azure/service-principal`# + + + +Creates new ARN credentials for a specified account public ID. + +**Token usage:** NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountPublicId +|string +|path +|True +a| + +|isGov +|boolean +|query +|False +a|Indicates whether the service principal is located in the AWS GovCloud (US) location + + +|x-simulator +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tenantId +|string +|True +a| + +|clientId +|string +|True +a| + +|clientSecret +|string +|True +a| + +|name +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tenantId": "string", + "clientId": "string", + "clientSecret": "string", + "name": "string" +} +==== + +== Response + +``` +Status: 200, Successful stored service principal credentials +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentialsId +|string +|True +a| + +|credentialsType +|string +|True +a| + +|extra +|link:#extra[extra] +|True +a| + +|isSimulated +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: 404, Account not found +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#extra] +[.api-collapsible-fifth-title] +extra + + +//end collapsible .Definitions block +==== diff --git a/credential/post-accounts-credentials.adoc b/credential/post-accounts-credentials.adoc new file mode 100644 index 00000000..0316879f --- /dev/null +++ b/credential/post-accounts-credentials.adoc @@ -0,0 +1,134 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/post-accounts-credentials.html' +summary: 'Add generic credentials' +--- + += Add generic credentials + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/accounts/{accountPublicId}/credentials`# + + + +Creates and encrypts new credentials for a specified account public ID. + +**Token usage:** Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountPublicId +|string +|path +|True +a| + +|x-simulator +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentials +|link:#credentials[credentials] +|True +a| + +|credentialsType +|string +|True +a| + +|extra +|link:#extra[extra] +|False +a| + +|=== + + +== Response + +``` +Status: 200, Successful stored generic credentials +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentialsId +|string +|True +a| + +|credentialsType +|string +|True +a| + +|extra +|link:#extra[extra] +|True +a| + +|isSimulated +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: 404, Account not found +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#credentials] +[.api-collapsible-fifth-title] +credentials + + +[#extra] +[.api-collapsible-fifth-title] +extra + + +//end collapsible .Definitions block +==== diff --git a/credential/post-azure-generate-token.adoc b/credential/post-azure-generate-token.adoc new file mode 100644 index 00000000..d7cf2cb0 --- /dev/null +++ b/credential/post-azure-generate-token.adoc @@ -0,0 +1,108 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'credential/post-azure-generate-token.html' +summary: 'Generate Azure token' +--- + += Generate Azure token + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/generate-token`# + + + +Generates an Azure token by using service principal credentials. + +**Token usage:** Both a NetApp Console user token and service token. The service token needs to include the following scopes: credentials:internal. Pass the user token or service token in the Authorization request header. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tenantId +|string +|True +a| + +|clientId +|string +|True +a| + +|clientSecret +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tenantId": "string", + "clientId": "string", + "clientSecret": "string" +} +==== + +== Response + +``` +Status: 200, Successful fetched generated token +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|token +|string +|True +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "token": "string" +} +==== + diff --git a/credential/sidebar.yml b/credential/sidebar.yml deleted file mode 100644 index 0d32e741..00000000 --- a/credential/sidebar.yml +++ /dev/null @@ -1,3 +0,0 @@ -section: credential -title: Credentials -generate: credential diff --git a/cvo/cvo-x-doc.json b/cvo/cvo-x-doc.json deleted file mode 100644 index b17ce798..00000000 --- a/cvo/cvo-x-doc.json +++ /dev/null @@ -1,8588 +0,0 @@ -{ - "paths": { - "/gcp/ha/discovery/discover": { - "get": { - "x-doc": { - "title": "Retrieve a list of HA systems for a Google Cloud region", - "category": "Google Cloud system discovery (HA)", - "filename": "get-gcp-ha-discovery-discover.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/discovery/recover": { - "post": { - "x-doc": { - "title": "Save an HA system to the NetApp Console database", - "category": "Google Cloud system discovery (HA)", - "filename": "post-gcp-ha-discovery-recover.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/discover": { - "get": { - "x-doc": { - "title": "Retrieve a list of systems for a Google Cloud zone", - "category": "Google Cloud system discovery (single-node)", - "filename": "get-gcp-vsa-discover.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/recover": { - "post": { - "x-doc": { - "title": "Save a system to the NetApp Console database", - "category": "Google Cloud system discovery (single-node)", - "filename": "post-gcp-vsa-recover.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/volumes/quote": { - "post": { - "x-doc": { - "title": "Retrieve quotes for a new Azure volume", - "category": "Azure volumes (single-node)", - "filename": "post-azure-vsa-volumes-quote.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier": { - "post": { - "x-doc": { - "title": "Update the underlying volume tier", - "category": "Azure volumes (single-node)", - "filename": "post-azure-vsa-volumes--change-tier.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/volumes/volumes-for-backup": { - "get": { - "x-doc": { - "title": "Retrieve volumes for backup activation", - "category": "Azure volumes (single-node)", - "filename": "get-azure-vsa-volumes-volumes-for-backup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "x-doc": { - "title": "Modify an existing volume", - "category": "Azure volumes (single-node)", - "filename": "put-azure-vsa-volumes--.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing volume", - "category": "Azure volumes (single-node)", - "filename": "delete-azure-vsa-volumes--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy": { - "put": { - "x-doc": { - "title": "Add an export policy rule", - "category": "Azure volumes (single-node)", - "filename": "put-azure-vsa-volumes--exportpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/volumes/igroups/{workingEnvironmentId}/{svmName}": { - "get": { - "x-doc": { - "title": "Retrieve all igroups", - "category": "Azure volumes (single-node)", - "filename": "get-azure-vsa-volumes-igroups-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/volumes/initiator": { - "get": { - "x-doc": { - "title": "Retrieve all iSCSI initiators", - "category": "Azure volumes (single-node)", - "filename": "get-azure-vsa-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Add an iSCSI initiator", - "category": "Azure volumes (single-node)", - "filename": "post-azure-vsa-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "x-doc": { - "title": "Retrieve a list of volume snapshot descriptions", - "category": "Azure volumes (single-node)", - "filename": "get-azure-vsa-volumes--snapshots.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "x-doc": { - "title": "Clone an existing volume", - "category": "Azure volumes (single-node)", - "filename": "post-azure-vsa-volumes--clone.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move": { - "post": { - "x-doc": { - "title": "Move an existing volume", - "category": "Azure volumes (single-node)", - "filename": "post-azure-vsa-volumes--move.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/volumes": { - "get": { - "x-doc": { - "title": "Retrieve all volumes", - "category": "Azure volumes (single-node)", - "filename": "get-azure-vsa-volumes.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new volume", - "category": "Azure volumes (single-node)", - "filename": "post-azure-vsa-volumes.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "x-doc": { - "title": "Create a snapshot", - "category": "Azure volumes (single-node)", - "filename": "post-azure-vsa-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a snapshot", - "category": "Azure volumes (single-node)", - "filename": "delete-azure-vsa-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/azure": { - "post": { - "x-doc": { - "title": "Create an Azure account", - "category": "Account operations", - "filename": "post-accounts-azure.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/gcp": { - "post": { - "x-doc": { - "title": "Create a Google Cloud storage account", - "category": "Account operations", - "filename": "post-accounts-gcp.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/gcp/{cloudProviderAccountId}": { - "get": { - "x-doc": { - "title": "Retrieve a Google Cloud storage account", - "category": "Account operations", - "filename": "get-accounts-gcp-.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update a Google Cloud storage account", - "category": "Account operations", - "filename": "put-accounts-gcp-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/nss/set-vsa-list/{cloudProviderAccountId}": { - "put": { - "x-doc": { - "title": "Update the VSA list of an NSS account", - "category": "Account operations", - "filename": "put-accounts-nss-set-vsa-list-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/cloud-providers": { - "get": { - "x-doc": { - "title": "Retrieve all cloud accounts", - "category": "Account operations", - "filename": "get-accounts-cloud-providers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/aws/validate-creds": { - "post": { - "x-doc": { - "title": "Retrieve an AWS account ID for credentials", - "category": "Account operations", - "filename": "post-accounts-aws-validate-creds.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/gcp/validate-creds": { - "post": { - "x-doc": { - "title": "Validate the Google Cloud account request", - "category": "Account operations", - "filename": "post-accounts-gcp-validate-creds.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/azure/validate-creds": { - "post": { - "x-doc": { - "title": "Validate an Azure account request", - "category": "Account operations", - "filename": "post-accounts-azure-validate-creds.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/aws/{cloudProviderAccountId}": { - "get": { - "x-doc": { - "title": "Retrieve an AWS account", - "category": "Account operations", - "filename": "get-accounts-aws-.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update an existing AWS account", - "category": "Account operations", - "filename": "put-accounts-aws-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/aws": { - "post": { - "x-doc": { - "title": "Create an AWS account", - "category": "Account operations", - "filename": "post-accounts-aws.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/nss/{cloudProviderAccountId}": { - "get": { - "x-doc": { - "title": "Retrieve an NSS account", - "category": "Account operations", - "filename": "get-accounts-nss-.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update an NSS account", - "category": "Account operations", - "filename": "put-accounts-nss-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/{cloudProviderAccountId}": { - "delete": { - "x-doc": { - "title": "Delete an existing account", - "category": "Account operations", - "filename": "delete-accounts-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/azure/{cloudProviderAccountId}": { - "get": { - "x-doc": { - "title": "Retrieve an Azure account", - "category": "Account operations", - "filename": "get-accounts-azure-.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update an Azure account", - "category": "Account operations", - "filename": "put-accounts-azure-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts/nss": { - "post": { - "x-doc": { - "title": "Create an NSS account", - "category": "Account operations", - "filename": "post-accounts-nss.html", - "subcategory": null, - "explorer": false - } - } - }, - "/accounts": { - "get": { - "x-doc": { - "title": "Retrieve accounts", - "category": "Account operations", - "filename": "get-accounts.html", - "subcategory": null, - "explorer": false - } - } - }, - "/audit": { - "get": { - "x-doc": { - "title": "Retrieve audit group entries", - "category": "Audit operations", - "filename": "get-audit.html", - "subcategory": null, - "explorer": false - } - } - }, - "/audit/auditserver": { - "get": { - "x-doc": { - "title": "Retrieve audit groups and group records", - "category": "Audit operations", - "filename": "get-audit-auditserver.html", - "subcategory": null, - "explorer": false - } - } - }, - "/audit/activeTask/{requestId}": { - "get": { - "x-doc": { - "title": "Retrieve an active task", - "category": "Audit operations", - "filename": "get-audit-activetask-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/audit/{requestId}": { - "get": { - "x-doc": { - "title": "Retrieve an audit group entry", - "category": "Audit operations", - "filename": "get-audit-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/audit/local/audit/{accountId}": { - "get": { - "x-doc": { - "title": "Retrieve audit group entries", - "category": "Audit operations", - "filename": "get-audit-local-audit-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/audit/local/audit/{accountId}/{service}/{requestId}/records": { - "get": { - "x-doc": { - "title": "Retrieve an audit record", - "category": "Audit operations", - "filename": "get-audit-local-audit--records.html", - "subcategory": null, - "explorer": false - } - } - }, - "/audit/local/audit/{accountId}/options": { - "get": { - "x-doc": { - "title": "Retrieve audit page filter options", - "category": "Audit operations", - "filename": "get-audit-local-audit-options.html", - "subcategory": null, - "explorer": false - } - } - }, - "/auth/logout": { - "post": { - "x-doc": { - "title": "Sign out of the NetApp Console", - "category": "User management authentication ", - "filename": "post-auth-logout.html", - "subcategory": null, - "explorer": false - } - } - }, - "/auth/current-user": { - "get": { - "x-doc": { - "title": "Retrieve user representation", - "category": "User management authentication ", - "filename": "get-auth-current-user.html", - "subcategory": null, - "explorer": false - } - } - }, - "/auth/current-user/change-password": { - "put": { - "x-doc": { - "title": "Update the user password", - "category": "User management authentication ", - "filename": "put-auth-current-user-change-password.html", - "subcategory": null, - "explorer": false - } - } - }, - "/auth/login": { - "post": { - "x-doc": { - "title": "Sign in to the NetApp Console", - "category": "User management authentication ", - "filename": "post-auth-login.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/aggregates/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve aggregates", - "category": "Azure aggregates (single-node)", - "filename": "get-azure-vsa-aggregates-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/aggregates": { - "post": { - "x-doc": { - "title": "Create a new aggregate", - "category": "Azure aggregates (single-node)", - "filename": "post-azure-vsa-aggregates.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}": { - "delete": { - "x-doc": { - "title": "Delete an aggregate", - "category": "Azure aggregates (single-node)", - "filename": "delete-azure-vsa-aggregates-.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update IOPS and throughput for disks in an existing aggregate (single-node)", - "category": "Azure aggregates (single-node)", - "filename": "put-azure-vsa-aggregates-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks": { - "post": { - "x-doc": { - "title": "Add disks to an aggregate", - "category": "Azure aggregates (single-node)", - "filename": "post-azure-vsa-aggregates--disks.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/aggregates/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve aggregates", - "category": "Azure aggregates (HA)", - "filename": "get-azure-ha-aggregates-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/aggregates": { - "post": { - "x-doc": { - "title": "Create a new aggregate", - "category": "Azure aggregates (HA)", - "filename": "post-azure-ha-aggregates.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}": { - "delete": { - "x-doc": { - "title": "Delete an aggregate", - "category": "Azure aggregates (HA)", - "filename": "delete-azure-ha-aggregates-.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update IOPS and throughput for disks in an existing aggregate", - "category": "Azure aggregates (HA)", - "filename": "put-azure-ha-aggregates-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks": { - "post": { - "x-doc": { - "title": "Add disks to an aggregate", - "category": "Azure aggregates (HA)", - "filename": "post-azure-ha-aggregates--disks.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/discovery/discover": { - "get": { - "x-doc": { - "title": "Retrieve a list of systems for the Azure region", - "category": "Azure system discovery (HA)", - "filename": "get-azure-ha-discovery-discover.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/discovery/recover": { - "post": { - "x-doc": { - "title": "Save a system to the NetApp Console database", - "category": "Azure system discovery (HA)", - "filename": "post-azure-ha-discovery-recover.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/permutations": { - "get": { - "x-doc": { - "title": "Retrieve all ONTAP cloud configurations", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-permutations.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/associated-subscriptions": { - "get": { - "x-doc": { - "title": "Retrieve subscriptions", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-associated-subscriptions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/vnets": { - "get": { - "x-doc": { - "title": "Retrieve network extended information", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-vnets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/resource-groups": { - "get": { - "x-doc": { - "title": "Retrieve Azure resource groups", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-resource-groups.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/vaults": { - "get": { - "x-doc": { - "title": "Retrieve all vaults", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-vaults.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/keys-vault": { - "get": { - "x-doc": { - "title": "Retrieve all keys in a vault", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-keys-vault.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/network-requirements": { - "get": { - "x-doc": { - "title": "Retrieve the minimum number of IP addresses", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-network-requirements.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/validate-subscribed-to-ontap-cloud": { - "post": { - "x-doc": { - "title": "Validate the Azure marketplace subscription", - "category": "Azure system metadata (HA)", - "filename": "post-azure-ha-metadata-validate-subscribed-to-ontap-cloud.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/create-container": { - "post": { - "x-doc": { - "title": "Create a new blob container", - "category": "Azure system metadata (HA)", - "filename": "post-azure-ha-metadata-create-container.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/availability-zones": { - "get": { - "x-doc": { - "title": "Retrieve Azure availability zones", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-availability-zones.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/supported-capacity-tiers": { - "get": { - "x-doc": { - "title": "Retrieve capacity tiers for Azure disk types", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-supported-capacity-tiers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/storage-account-types": { - "get": { - "x-doc": { - "title": "Retrieve Azure storage account types", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-storage-account-types.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/tag-keys": { - "get": { - "x-doc": { - "title": "Retrieve tag names", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-tag-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/containers": { - "get": { - "x-doc": { - "title": "Retrieve all blob containers", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-containers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/regions": { - "get": { - "x-doc": { - "title": "Retrieve Azure regions", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-regions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/default-snapshot-policies": { - "get": { - "x-doc": { - "title": "Retrieve the default snapshot policies", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-default-snapshot-policies.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering": { - "get": { - "x-doc": { - "title": "Retrieve unsupported instance types for acceleration and capacity tiering", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/supported-features": { - "get": { - "x-doc": { - "title": "Retrieve supported features", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-supported-features.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/metadata/packages": { - "get": { - "x-doc": { - "title": "Retrieve the packages configuration", - "category": "Azure system metadata (HA)", - "filename": "get-azure-ha-metadata-packages.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/sync-avs-host": { - "put": { - "x-doc": { - "title": "Synchronize Azure VMware Solution hosts", - "category": "Azure volumes (HA)", - "filename": "put-azure-ha-volumes-storage-vms-volumes-sync-avs-host.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/remove-avs": { - "delete": { - "x-doc": { - "title": "Remove Azure VMware Solution hosts on a volume", - "category": "Azure volumes (HA)", - "filename": "delete-azure-ha-volumes-storage-vms-volumes-remove-avs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/quote": { - "post": { - "x-doc": { - "title": "Retrieve quotes for a new volume", - "category": "Azure volumes (HA)", - "filename": "post-azure-ha-volumes-quote.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier": { - "post": { - "x-doc": { - "title": "Update the underlying volume tier", - "category": "Azure volumes (HA)", - "filename": "post-azure-ha-volumes--change-tier.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/volumes-for-backup": { - "get": { - "x-doc": { - "title": "Retrieve volumes for backup activation", - "category": "Azure volumes (HA)", - "filename": "get-azure-ha-volumes-volumes-for-backup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "x-doc": { - "title": "Modify an existing volume", - "category": "Azure volumes (HA)", - "filename": "put-azure-ha-volumes--.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing volume", - "category": "Azure volumes (HA)", - "filename": "delete-azure-ha-volumes--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy": { - "put": { - "x-doc": { - "title": "Add an export policy rule", - "category": "Azure volumes (HA)", - "filename": "put-azure-ha-volumes--exportpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/setup-avs": { - "put": { - "x-doc": { - "title": "Set up Azure VMware Solution on a volume", - "category": "Azure volumes (HA)", - "filename": "put-azure-ha-volumes-storage-vms-volumes-setup-avs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/igroups/{workingEnvironmentId}/{svmName}": { - "get": { - "x-doc": { - "title": "Retrieve all igroups", - "category": "Azure volumes (HA)", - "filename": "get-azure-ha-volumes-igroups-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/initiator": { - "get": { - "x-doc": { - "title": "Retrieve all iSCSI initiators", - "category": "Azure volumes (HA)", - "filename": "get-azure-ha-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Add an iSCSI initiator", - "category": "Azure volumes (HA)", - "filename": "post-azure-ha-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "x-doc": { - "title": "Retrieve a list of volume snapshot descriptions", - "category": "Azure volumes (HA)", - "filename": "get-azure-ha-volumes--snapshots.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "x-doc": { - "title": "Clone an existing volume", - "category": "Azure volumes (HA)", - "filename": "post-azure-ha-volumes--clone.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move": { - "post": { - "x-doc": { - "title": "Move an existing volume", - "category": "Azure volumes (HA)", - "filename": "post-azure-ha-volumes--move.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes": { - "get": { - "x-doc": { - "title": "Retrieve volumes", - "category": "Azure volumes (HA)", - "filename": "get-azure-ha-volumes.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new volume", - "category": "Azure volumes (HA)", - "filename": "post-azure-ha-volumes.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "x-doc": { - "title": "Create a snapshot", - "category": "Azure volumes (HA)", - "filename": "post-azure-ha-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a snapshot", - "category": "Azure volumes (HA)", - "filename": "delete-azure-ha-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments": { - "get": { - "x-doc": { - "title": "Retrieve HA systems", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new Azure HA system", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist": { - "get": { - "x-doc": { - "title": "Check for non-persistent locks", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-cifs-locks-exist.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/svm/{svmName}": { - "delete": { - "x-doc": { - "title": "Delete an SVM", - "category": "Azure systems (HA)", - "filename": "delete-azure-ha-working-environments-svm-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/svm": { - "put": { - "x-doc": { - "title": "Modify the SVM name of the system", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-svm.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new SVM", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-svm.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters": { - "get": { - "x-doc": { - "title": "Retrieve Azure VMware Solution private cloud clusters for a subscription", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-resourcegroups-avs-private-clouds-clusters.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters/{clusterName}/hosts": { - "get": { - "x-doc": { - "title": "Retrieve Azure VMware Solution cluster hosts for a subscription", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-resourcegroups-avs-private-clouds-clusters-hosts.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/available-ips-in-subnet": { - "get": { - "x-doc": { - "title": "Retrieve available IP addresses in the subnet of a system", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-available-ips-in-subnet.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/resource-group-exists/{resourceGroupName}": { - "get": { - "x-doc": { - "title": "Check if a resource group with the specified name exists", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-resource-group-exists-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/avs-private-clouds": { - "get": { - "x-doc": { - "title": "Retrieve an Azure VMware Solution private cloud for a subscription", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-avs-private-clouds.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve a system", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a system", - "category": "Azure systems (HA)", - "filename": "delete-azure-ha-working-environments-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/delete-cifs": { - "post": { - "x-doc": { - "title": "Delete the CIFS configuration for a system", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-delete-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "x-doc": { - "title": "Retrieve the CIFS configuration for a system", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new CIFS configuration for a system", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity": { - "get": { - "x-doc": { - "title": "Validate prerequisites for converting a system", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-validate-byol-to-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/writing-speed": { - "put": { - "x-doc": { - "title": "Set the writing speed", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-writing-speed.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/license-instance-type": { - "get": { - "x-doc": { - "title": "Retrieve all license types and their associated instance types", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-license-instance-type.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Set the instance type", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-license-instance-type.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/ontap-available-images": { - "get": { - "x-doc": { - "title": "Retrieve images already installed on a system", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-ontap-available-images.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/update-image": { - "post": { - "x-doc": { - "title": "Perform an image update on a single node", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-update-image.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/update-eligibility": { - "get": { - "x-doc": { - "title": "Retrieve the eligibility support status of a system", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-update-eligibility.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/upload-license-file": { - "post": { - "x-doc": { - "title": "Upload a cloud license file", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-upload-license-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/upload-licenses": { - "post": { - "x-doc": { - "title": "Upload cloud license file content", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-upload-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/offbox": { - "put": { - "x-doc": { - "title": "Activate the off-box configuration", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-offbox.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/networkOptimization": { - "put": { - "x-doc": { - "title": "Modify the network port broadcast domain MTU", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-networkoptimization.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/create-request-parameters": { - "get": { - "x-doc": { - "title": "Retrieve action parameters", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-create-request-parameters.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering": { - "post": { - "x-doc": { - "title": "Enable capacity tiering", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-enable-capacity-tiering.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions": { - "get": { - "x-doc": { - "title": "Retrieve a list of upgrade versions", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-occm-provided-upgrade-versions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/sync-subscription": { - "post": { - "x-doc": { - "title": "Trigger subscription synchronization", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-sync-subscription.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/cost-and-usage": { - "get": { - "x-doc": { - "title": "Retrieve the system cost and usage", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-cost-and-usage.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/ontap-saving": { - "get": { - "x-doc": { - "title": "Retrieve system ONTAP savings", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-ontap-saving.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses": { - "get": { - "x-doc": { - "title": "Retrieve extra capacity licenses", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update an extra capacity license", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register an extra capacity license", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials": { - "put": { - "x-doc": { - "title": "Update extra capacity serial numbers", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register extra capacity serial numbers", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete extra capacity licenses by serial number", - "category": "Azure systems (HA)", - "filename": "delete-azure-ha-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/vscan-file-op": { - "put": { - "x-doc": { - "title": "Update the default Vscan file operation profile", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-vscan-file-op.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "x-doc": { - "title": "Update the NetApp Console password", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-update-credentials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/change-tier-level": { - "post": { - "x-doc": { - "title": "Update the tier level", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-change-tier-level.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/byol-to-capacity": { - "put": { - "x-doc": { - "title": "Update a BYOL license to a capacity-based license", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-byol-to-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/enable-worm": { - "put": { - "x-doc": { - "title": "Enable SnapLock for a system", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-enable-worm.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/ntp": { - "post": { - "x-doc": { - "title": "Create an NTP server", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-ntp.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/start": { - "post": { - "x-doc": { - "title": "Start a Cloud Volumes ONTAP instance", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-start.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/stop": { - "post": { - "x-doc": { - "title": "Stop a Cloud Volumes ONTAP instance", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-stop.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/support-registration": { - "get": { - "x-doc": { - "title": "Retrieve the support registration status", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-support-registration.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register a Cloud Volumes ONTAP system with NetApp", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-support-registration.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/schedules": { - "get": { - "x-doc": { - "title": "List the start/stop schedules for Cloud Volumes ONTAP", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-schedules.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Set schedules for Cloud Volumes ONTAP", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-schedules.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/activate-fpolicy": { - "put": { - "x-doc": { - "title": "Activate FPolicy for ransomware files", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-activate-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/disable-fpolicy": { - "put": { - "x-doc": { - "title": "Disable FPolicy for ransomware files", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-disable-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/fpolicy": { - "delete": { - "x-doc": { - "title": "Delete FPolicy for ransomware files", - "category": "Azure systems (HA)", - "filename": "delete-azure-ha-working-environments-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/parse-license-file": { - "post": { - "x-doc": { - "title": "Parse an uploaded cloud license file", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-parse-license-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/user-tags": { - "get": { - "x-doc": { - "title": "Retrieve editable tags for the cloud resources", - "category": "Azure systems (HA)", - "filename": "get-azure-ha-working-environments-user-tags.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Modify the user tags for cloud resources", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-user-tags.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy": { - "put": { - "x-doc": { - "title": "Activate snapshot policy assignment", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-activate-snapshot-policy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/snapshot-policy": { - "post": { - "x-doc": { - "title": "Create a snapshot policy", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-snapshot-policy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/change-serial": { - "post": { - "x-doc": { - "title": "Update the serial number of a system", - "category": "Azure systems (HA)", - "filename": "post-azure-ha-working-environments-change-serial.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/set-password": { - "put": { - "x-doc": { - "title": "Set the cluster password for a system", - "category": "Azure systems (HA)", - "filename": "put-azure-ha-working-environments-set-password.html", - "subcategory": null, - "explorer": false - } - } - }, - "/cloud-compliance/deploy-by-working-environments": { - "post": { - "x-doc": { - "title": "Deploy a cloud compliance instance by systems", - "category": "Cloud compliance operations", - "filename": "post-cloud-compliance-deploy-by-working-environments.html", - "subcategory": null, - "explorer": false - } - } - }, - "/cloud-compliance/info": { - "get": { - "x-doc": { - "title": "Retrieve cloud compliance information", - "category": "Cloud compliance operations", - "filename": "get-cloud-compliance-info.html", - "subcategory": null, - "explorer": false - } - } - }, - "/cloud-compliance/{workingEnvironmentId}/disable-onprem-scan": { - "post": { - "x-doc": { - "title": "Disable on-premises scanning", - "category": "Cloud compliance operations", - "filename": "post-cloud-compliance-disable-onprem-scan.html", - "subcategory": null, - "explorer": false - } - } - }, - "/cloud-compliance/fsx/{fileSystemId}/compliance-status": { - "get": { - "x-doc": { - "title": "Retrieve the service cloud compliance status using the file system ID", - "category": "Cloud compliance operations", - "filename": "get-cloud-compliance-fsx-compliance-status.html", - "subcategory": null, - "explorer": false - } - } - }, - "/cloud-compliance/{serviceId}/compliance-status": { - "get": { - "x-doc": { - "title": "Retrieve the service cloud compliance status using the service ID", - "category": "Cloud compliance operations", - "filename": "get-cloud-compliance-compliance-status.html", - "subcategory": null, - "explorer": false - } - } - }, - "/cloud-compliance/{serviceId}/enable-service-scan": { - "post": { - "x-doc": { - "title": "Enable scanning using the service ID", - "category": "Cloud compliance operations", - "filename": "post-cloud-compliance-enable-service-scan.html", - "subcategory": null, - "explorer": false - } - } - }, - "/cloud-compliance/{serviceId}/disable-service-scan": { - "post": { - "x-doc": { - "title": "Disable scanning using the service ID", - "category": "Cloud compliance operations", - "filename": "post-cloud-compliance-disable-service-scan.html", - "subcategory": null, - "explorer": false - } - } - }, - "/cloud-compliance/{workingEnvironmentId}/disable-scan": { - "post": { - "x-doc": { - "title": "Disable scanning using the system ID", - "category": "Cloud compliance operations", - "filename": "post-cloud-compliance-disable-scan.html", - "subcategory": null, - "explorer": false - } - } - }, - "/cloud-compliance/{workingEnvironmentId}/enable-scan": { - "post": { - "x-doc": { - "title": "Enable scanning using the system ID", - "category": "Cloud compliance operations", - "filename": "post-cloud-compliance-enable-scan.html", - "subcategory": null, - "explorer": false - } - } - }, - "/cloud-compliance/{workingEnvironmentId}/enable-onprem-scan": { - "post": { - "x-doc": { - "title": "Enable on-premises scanning using the system ID", - "category": "Cloud compliance operations", - "filename": "post-cloud-compliance-enable-onprem-scan.html", - "subcategory": null, - "explorer": false - } - } - }, - "/cloud-compliance/fsx/{fileSystemId}/enable-scan": { - "post": { - "x-doc": { - "title": "Enable scanning using the file system ID", - "category": "Cloud compliance operations", - "filename": "post-cloud-compliance-fsx-enable-scan.html", - "subcategory": null, - "explorer": false - } - } - }, - "/cloud-compliance/fsx/{fileSystemId}/disable-scan": { - "post": { - "x-doc": { - "title": "Disable scanning using the file system ID", - "category": "Cloud compliance operations", - "filename": "post-cloud-compliance-fsx-disable-scan.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/encryption/certificate": { - "get": { - "x-doc": { - "title": "Retrieve the installed certificate", - "category": "NetApp Console certificates", - "filename": "get-occm-encryption-certificate.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Validate and install a certificate", - "category": "NetApp Console certificates", - "filename": "post-occm-encryption-certificate.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/encryption/csr": { - "get": { - "x-doc": { - "title": "Retrieve a generated certificate signing request", - "category": "NetApp Console certificate signing requests", - "filename": "get-occm-encryption-csr.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Generate, store, and return a certificate signing request", - "category": "NetApp Console certificate signing requests", - "filename": "post-occm-encryption-csr.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/encryption/key-managers-ca-certificates": { - "get": { - "x-doc": { - "title": "Retrieve all key manager CA certificates", - "category": "NetApp Console CA certificates ", - "filename": "get-occm-encryption-key-managers-ca-certificates.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Add a new key manager CA certificate", - "category": "NetApp Console CA certificates ", - "filename": "post-occm-encryption-key-managers-ca-certificates.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/encryption/key-managers-ca-certificates/{keyManagerCaCertificateId}": { - "get": { - "x-doc": { - "title": "Retrieve a key manager CA certificate", - "category": "NetApp Console CA certificates ", - "filename": "get-occm-encryption-key-managers-ca-certificates-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a key manager CA certificate", - "category": "NetApp Console CA certificates ", - "filename": "delete-occm-encryption-key-managers-ca-certificates-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/encryption/key-managers/{keyManagerId}": { - "get": { - "x-doc": { - "title": "Retrieve a key manager using the public ID", - "category": "NetApp Console key managers", - "filename": "get-occm-encryption-key-managers-.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update an existing key manager", - "category": "NetApp Console key managers", - "filename": "put-occm-encryption-key-managers-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing key manager", - "category": "NetApp Console key managers", - "filename": "delete-occm-encryption-key-managers-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/encryption/key-managers": { - "get": { - "x-doc": { - "title": "Retrieve all key managers", - "category": "NetApp Console key managers", - "filename": "get-occm-encryption-key-managers.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Add a new key manager", - "category": "NetApp Console key managers", - "filename": "post-occm-encryption-key-managers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/working-environments/exists/{workingEnvironmentName}": { - "get": { - "x-doc": { - "title": "Check if a system with the specified name exists", - "category": "Common system operations", - "filename": "get-working-environments-exists-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/working-environments/actionRequired/{tenantId}": { - "get": { - "x-doc": { - "title": "Retrieve all non-premises system actions for a tenant ID", - "category": "Common system operations", - "filename": "get-working-environments-actionrequired-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/working-environments": { - "get": { - "x-doc": { - "title": "Retrieve all systems", - "category": "Common system operations", - "filename": "get-working-environments.html", - "subcategory": null, - "explorer": false - } - } - }, - "/working-environments/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve a Cloud Volumes ONTAP system", - "category": "Common system operations", - "filename": "get-working-environments-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/flexcache/fsx": { - "post": { - "x-doc": { - "title": "Create a new FlexCache volume for an FSx system", - "category": "FlexCache volume operations", - "filename": "post-flexcache-fsx.html", - "subcategory": null, - "explorer": false - } - } - }, - "/flexcache/all-relationships": { - "get": { - "x-doc": { - "title": "Retrieve all FlexCache volume relationships", - "category": "FlexCache volume operations", - "filename": "get-flexcache-all-relationships.html", - "subcategory": null, - "explorer": false - } - } - }, - "/flexcache/{workingEnvironmentId}/caches/{cacheId}": { - "put": { - "x-doc": { - "title": "Modify a FlexCache volume", - "category": "FlexCache volume operations", - "filename": "put-flexcache-caches-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a FlexCache volume", - "category": "FlexCache volume operations", - "filename": "delete-flexcache-caches-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/flexcache": { - "post": { - "x-doc": { - "title": "Create a new FlexCache volume", - "category": "FlexCache volume operations", - "filename": "post-flexcache.html", - "subcategory": null, - "explorer": false - } - } - }, - "/flexcache/caches": { - "get": { - "x-doc": { - "title": "Retrieve all FlexCache volumes lists", - "category": "FlexCache volume operations", - "filename": "get-flexcache-caches.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/volumes/{fileSystemId}": { - "get": { - "x-doc": { - "title": "Retrieve volumes", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "get-fsx-volumes-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/volumes/{fileSystemId}/{volumeId}": { - "get": { - "x-doc": { - "title": "Retrieve a volume using the ID", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "get-fsx-volumes-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/volumes/{fileSystemId}/nfs-clients": { - "get": { - "x-doc": { - "title": "Retrieve an NFS clients list for an FSx system", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "get-fsx-volumes-nfs-clients.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/volumes/{fileSystemId}/shares": { - "get": { - "x-doc": { - "title": "Retrieve a CIFS share list for an FSx system", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "get-fsx-volumes-shares.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/volumes/{fileSystemId}/count": { - "get": { - "x-doc": { - "title": "Retrieve the volume count", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "get-fsx-volumes-count.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}": { - "put": { - "x-doc": { - "title": "Modify an existing volume", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "put-fsx-volumes--.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing volume", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "delete-fsx-volumes--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/volumes/igroups/{fileSystemId}/{svmName}": { - "get": { - "x-doc": { - "title": "Retrieve all igroups", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "get-fsx-volumes-igroups-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/volumes/initiator": { - "get": { - "x-doc": { - "title": "Retrieve all iSCSI initiators", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "get-fsx-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Add an iSCSI initiator", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "post-fsx-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/snapshots": { - "get": { - "x-doc": { - "title": "Retrieve a list of snapshot descriptions for a volume", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "get-fsx-volumes--snapshots.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/clone": { - "post": { - "x-doc": { - "title": "Clone a volume", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "post-fsx-volumes--clone.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/volumes": { - "post": { - "x-doc": { - "title": "Create a new volume", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "post-fsx-volumes.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/snapshot": { - "post": { - "x-doc": { - "title": "Create a snapshot", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "post-fsx-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a snapshot", - "category": "Amazon FSx for NetApp ONTAP management volumes", - "filename": "delete-fsx-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/working-environments/{fileSystemId}/cifs": { - "get": { - "x-doc": { - "title": "Retrieve CIFS configuration for an FSx system", - "category": "Amazon FSx for NetApp ONTAP management systems", - "filename": "get-fsx-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new CIFS configuration for an FSx system", - "category": "Amazon FSx for NetApp ONTAP management systems", - "filename": "post-fsx-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/working-environments/{fileSystemId}/export-policies": { - "get": { - "x-doc": { - "title": "Retrieve an export policies list for an FSx system", - "category": "Amazon FSx for NetApp ONTAP management systems", - "filename": "get-fsx-working-environments-export-policies.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/working-environments/{fileSystemId}/svms": { - "get": { - "x-doc": { - "title": "Retrieve an SVM list for an FSx system", - "category": "Amazon FSx for NetApp ONTAP management systems", - "filename": "get-fsx-working-environments-svms.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/working-environments/validate-credentials": { - "post": { - "x-doc": { - "title": "Validate the credentials for an FSx system", - "category": "Amazon FSx for NetApp ONTAP management systems", - "filename": "post-fsx-working-environments-validate-credentials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/working-environments/{fileSystemId}/interfaces": { - "get": { - "x-doc": { - "title": "Retrieve network interfaces lists for an FSx system", - "category": "Amazon FSx for NetApp ONTAP management systems", - "filename": "get-fsx-working-environments-interfaces.html", - "subcategory": null, - "explorer": false - } - } - }, - "/fsx/working-environments/{fileSystemId}/snapshot-policies": { - "get": { - "x-doc": { - "title": "Retrieve snapshot policies for an FSx system", - "category": "Amazon FSx for NetApp ONTAP management systems", - "filename": "get-fsx-working-environments-snapshot-policies.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/gcp-encryption-keys": { - "get": { - "x-doc": { - "title": "Retrieve Google Cloud encryption keys for a region", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-gcp-encryption-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/service-accounts": { - "get": { - "x-doc": { - "title": "Retrieve a list of service accounts", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-service-accounts.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/network-requirements": { - "get": { - "x-doc": { - "title": "Retrieve the minimum number of IP addresses for a system", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-network-requirements.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/buckets": { - "get": { - "x-doc": { - "title": "Retrieve all cloud storage buckets", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/supported-capacity-tiers": { - "get": { - "x-doc": { - "title": "Retrieve supported capacity tiers for Google Cloud disk types", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-supported-capacity-tiers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/projects": { - "get": { - "x-doc": { - "title": "Retrieve a list of projects", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-projects.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/create-bucket": { - "post": { - "x-doc": { - "title": "Create a new bucket", - "category": "Google Cloud system metadata (single-node)", - "filename": "post-gcp-vsa-metadata-create-bucket.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/gcp-disk-types": { - "get": { - "x-doc": { - "title": "Retrieve the supported Google Cloud disk types", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-gcp-disk-types.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/tag-keys": { - "get": { - "x-doc": { - "title": "Retrieve all the labels for a project ID and zone", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-tag-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/permutations": { - "get": { - "x-doc": { - "title": "Retrieve all Cloud Volumes ONTAP configurations", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-permutations.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/regions": { - "get": { - "x-doc": { - "title": "Retrieve Google Cloud regions", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-regions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/default-snapshot-policies": { - "get": { - "x-doc": { - "title": "Retrieve default snapshot policies", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-default-snapshot-policies.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering": { - "get": { - "x-doc": { - "title": "Retrieve the instance types that do not support acceleration and capacity tiering", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/supported-features": { - "get": { - "x-doc": { - "title": "Retrieve supported features", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-supported-features.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/packages": { - "get": { - "x-doc": { - "title": "Retrieve the packages configuration", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-vsa-metadata-packages.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/aggregates/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve aggregates", - "category": "Google Cloud aggregates (single-node)", - "filename": "get-gcp-vsa-aggregates-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/aggregates": { - "post": { - "x-doc": { - "title": "Create a new aggregate", - "category": "Google Cloud aggregates (single-node)", - "filename": "post-gcp-vsa-aggregates.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName}": { - "delete": { - "x-doc": { - "title": "Delete an aggregate", - "category": "Google Cloud aggregates (single-node)", - "filename": "delete-gcp-vsa-aggregates-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks": { - "post": { - "x-doc": { - "title": "Add disks to an aggregate", - "category": "Google Cloud aggregates (single-node)", - "filename": "post-gcp-vsa-aggregates--disks.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/volumes/quote": { - "post": { - "x-doc": { - "title": "Retrieve quotes for a new volume", - "category": "Google Cloud volumes (single-node)", - "filename": "post-gcp-vsa-volumes-quote.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier": { - "post": { - "x-doc": { - "title": "Update the underlying volume tier", - "category": "Google Cloud volumes (single-node)", - "filename": "post-gcp-vsa-volumes--change-tier.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/volumes/volumes-for-backup": { - "get": { - "x-doc": { - "title": "Retrieve volumes for backup activation", - "category": "Google Cloud volumes (single-node)", - "filename": "get-gcp-vsa-volumes-volumes-for-backup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "x-doc": { - "title": "Modify a volume", - "category": "Google Cloud volumes (single-node)", - "filename": "put-gcp-vsa-volumes--.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a volume", - "category": "Google Cloud volumes (single-node)", - "filename": "delete-gcp-vsa-volumes--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy": { - "put": { - "x-doc": { - "title": "Add an export policy rule", - "category": "Google Cloud volumes (single-node)", - "filename": "put-gcp-vsa-volumes--exportpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/volumes/igroups/{workingEnvironmentId}/{svmName}": { - "get": { - "x-doc": { - "title": "Retrieve all igroups", - "category": "Google Cloud volumes (single-node)", - "filename": "get-gcp-vsa-volumes-igroups-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/volumes/initiator": { - "get": { - "x-doc": { - "title": "Retrieve all iSCSI initiators", - "category": "Google Cloud volumes (single-node)", - "filename": "get-gcp-vsa-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Add an iSCSI initiator", - "category": "Google Cloud volumes (single-node)", - "filename": "post-gcp-vsa-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "x-doc": { - "title": "Retrieve a list of snapshot descriptions for a volume", - "category": "Google Cloud volumes (single-node)", - "filename": "get-gcp-vsa-volumes--snapshots.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "x-doc": { - "title": "Clone a volume", - "category": "Google Cloud volumes (single-node)", - "filename": "post-gcp-vsa-volumes--clone.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move": { - "post": { - "x-doc": { - "title": "Move a volume", - "category": "Google Cloud volumes (single-node)", - "filename": "post-gcp-vsa-volumes--move.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/volumes": { - "get": { - "x-doc": { - "title": "Retrieve volumes", - "category": "Google Cloud volumes (single-node)", - "filename": "get-gcp-vsa-volumes.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new volume", - "category": "Google Cloud volumes (single-node)", - "filename": "post-gcp-vsa-volumes.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "x-doc": { - "title": "Create a snapshot", - "category": "Google Cloud volumes (single-node)", - "filename": "post-gcp-vsa-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a snapshot", - "category": "Google Cloud volumes (single-node)", - "filename": "delete-gcp-vsa-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/aggregates/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve aggregates", - "category": "Google Cloud aggregates (HA)", - "filename": "get-gcp-ha-aggregates-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/aggregates": { - "post": { - "x-doc": { - "title": "Create a new aggregate", - "category": "Google Cloud aggregates (HA)", - "filename": "post-gcp-ha-aggregates.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/aggregates/{workingEnvironmentId}/{aggregateName}": { - "delete": { - "x-doc": { - "title": "Delete an aggregate", - "category": "Google Cloud aggregates (HA)", - "filename": "delete-gcp-ha-aggregates-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks": { - "post": { - "x-doc": { - "title": "Add disks to an aggregate", - "category": "Google Cloud aggregates (HA)", - "filename": "post-gcp-ha-aggregates--disks.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/vpcs": { - "get": { - "x-doc": { - "title": "Retrieve Google Cloud networks and subnetworks", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-vpcs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/zones": { - "get": { - "x-doc": { - "title": "Retrieve Google Cloud regions and zones", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-zones.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/tag-keys": { - "get": { - "x-doc": { - "title": "Retrieve all labels for a project ID and region", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-tag-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/permutations": { - "get": { - "x-doc": { - "title": "Retrieve all Cloud Volumes ONTAP configurations", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-permutations.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/gcp-encryption-keys": { - "get": { - "x-doc": { - "title": "Retrieve Google Cloud encryption keys for a region", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-gcp-encryption-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/service-accounts": { - "get": { - "x-doc": { - "title": "Retrieve a list of service accounts", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-service-accounts.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/network-requirements": { - "get": { - "x-doc": { - "title": "Retrieve the minimum number of IP addresses for a system", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-network-requirements.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/buckets": { - "get": { - "x-doc": { - "title": "Retrieve all cloud storage buckets", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/supported-capacity-tiers": { - "get": { - "x-doc": { - "title": "Retrieve supported capacity tiers for Google Cloud disk types", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-supported-capacity-tiers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/projects": { - "get": { - "x-doc": { - "title": "Retrieve a list of projects", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-projects.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/create-bucket": { - "post": { - "x-doc": { - "title": "Create a new bucket", - "category": "Google Cloud system metadata (HA)", - "filename": "post-gcp-ha-metadata-create-bucket.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/gcp-disk-types": { - "get": { - "x-doc": { - "title": "Retrieve the supported disk types", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-gcp-disk-types.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/regions": { - "get": { - "x-doc": { - "title": "Retrieve Google Cloud regions", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-regions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/default-snapshot-policies": { - "get": { - "x-doc": { - "title": "Retrieve the default snapshot policies", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-default-snapshot-policies.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering": { - "get": { - "x-doc": { - "title": "Retrieve instance types that do not support acceleration and capacity tiering", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/supported-features": { - "get": { - "x-doc": { - "title": "Retrieve supported features", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-supported-features.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/packages": { - "get": { - "x-doc": { - "title": "Retrieve the packages configuration", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-ha-metadata-packages.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/volumes/quote": { - "post": { - "x-doc": { - "title": "Retrieve quotes for a new volume", - "category": "Google Cloud volumes (HA)", - "filename": "post-gcp-ha-volumes-quote.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier": { - "post": { - "x-doc": { - "title": "Update the underlying volume tier", - "category": "Google Cloud volumes (HA)", - "filename": "post-gcp-ha-volumes--change-tier.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/volumes/volumes-for-backup": { - "get": { - "x-doc": { - "title": "Retrieve volumes for backup activation", - "category": "Google Cloud volumes (HA)", - "filename": "get-gcp-ha-volumes-volumes-for-backup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "x-doc": { - "title": "Modify a volume", - "category": "Google Cloud volumes (HA)", - "filename": "put-gcp-ha-volumes--.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a volume", - "category": "Google Cloud volumes (HA)", - "filename": "delete-gcp-ha-volumes--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy": { - "put": { - "x-doc": { - "title": "Add an export policy rule", - "category": "Google Cloud volumes (HA)", - "filename": "put-gcp-ha-volumes--exportpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/volumes/igroups/{workingEnvironmentId}/{svmName}": { - "get": { - "x-doc": { - "title": "Retrieve all igroups", - "category": "Google Cloud volumes (HA)", - "filename": "get-gcp-ha-volumes-igroups-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/volumes/initiator": { - "get": { - "x-doc": { - "title": "Retrieve all iSCSI initiators", - "category": "Google Cloud volumes (HA)", - "filename": "get-gcp-ha-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Add an iSCSI initiator", - "category": "Google Cloud volumes (HA)", - "filename": "post-gcp-ha-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "x-doc": { - "title": "Retrieve a list of snapshot descriptions", - "category": "Google Cloud volumes (HA)", - "filename": "get-gcp-ha-volumes--snapshots.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "x-doc": { - "title": "Clone an existing volume", - "category": "Google Cloud volumes (HA)", - "filename": "post-gcp-ha-volumes--clone.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move": { - "post": { - "x-doc": { - "title": "Move an existing volume", - "category": "Google Cloud volumes (HA)", - "filename": "post-gcp-ha-volumes--move.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/volumes": { - "get": { - "x-doc": { - "title": "Retrieve volumes", - "category": "Google Cloud volumes (HA)", - "filename": "get-gcp-ha-volumes.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new volume", - "category": "Google Cloud volumes (HA)", - "filename": "post-gcp-ha-volumes.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "x-doc": { - "title": "Create a snapshot", - "category": "Google Cloud volumes (HA)", - "filename": "post-gcp-ha-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a snapshot", - "category": "Google Cloud volumes (HA)", - "filename": "delete-gcp-ha-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments": { - "get": { - "x-doc": { - "title": "Retrieve Cloud Volumes ONTAP systems", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new Cloud Volumes ONTAP Google Cloud HA system", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/stop": { - "post": { - "x-doc": { - "title": "Stop a specific Cloud Volumes ONTAP instance", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-stop.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist": { - "get": { - "x-doc": { - "title": "Check for non-persistent locks held on CIFS sessions", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-cifs-locks-exist.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/svm/{svmName}": { - "delete": { - "x-doc": { - "title": "Delete an SVM", - "category": "Google Cloud systems (HA)", - "filename": "delete-gcp-ha-working-environments-svm-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/svm": { - "put": { - "x-doc": { - "title": "Modify the SVM name of the Cloud Volumes ONTAP system", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-svm.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new SVM", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-svm.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve a system", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing system", - "category": "Google Cloud systems (HA)", - "filename": "delete-gcp-ha-working-environments-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/delete-cifs": { - "post": { - "x-doc": { - "title": "Delete the CIFS configuration for a system", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-delete-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "x-doc": { - "title": "Retrieve the CIFS configuration for a system", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new CIFS configuration for a system", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity": { - "get": { - "x-doc": { - "title": "Validate prerequisites for converting a system", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-validate-byol-to-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/writing-speed": { - "put": { - "x-doc": { - "title": "Modify the writing speed for a system", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-writing-speed.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/license-instance-type": { - "get": { - "x-doc": { - "title": "Retrieve all license types for a system", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-license-instance-type.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Set the instance type", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-license-instance-type.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/ontap-available-images": { - "get": { - "x-doc": { - "title": "Retrieve images already installed on a system", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-ontap-available-images.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/update-image": { - "post": { - "x-doc": { - "title": "Perform a complete image update", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-update-image.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/update-eligibility": { - "get": { - "x-doc": { - "title": "Retrieve the eligibility support status", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-update-eligibility.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/upload-license-file": { - "post": { - "x-doc": { - "title": "Upload a cloud license file", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-upload-license-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/upload-licenses": { - "post": { - "x-doc": { - "title": "Upload cloud license file content", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-upload-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/offbox": { - "put": { - "x-doc": { - "title": "Activate an off-box configuration", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-offbox.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/networkOptimization": { - "put": { - "x-doc": { - "title": "Modify the network port broadcast domain MTU", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-networkoptimization.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/create-request-parameters": { - "get": { - "x-doc": { - "title": "Retrieve action parameters", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-create-request-parameters.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering": { - "post": { - "x-doc": { - "title": "Enable capacity tiering", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-enable-capacity-tiering.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions": { - "get": { - "x-doc": { - "title": "Retrieve a list of upgrade versions", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-occm-provided-upgrade-versions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/sync-subscription": { - "post": { - "x-doc": { - "title": "Trigger subscription synchronization", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-sync-subscription.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/cost-and-usage": { - "get": { - "x-doc": { - "title": "Retrieve the system cost and usage", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-cost-and-usage.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/ontap-saving": { - "get": { - "x-doc": { - "title": "Retrieve system ONTAP savings", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-ontap-saving.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses": { - "get": { - "x-doc": { - "title": "Retrieve extra capacity licenses", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update extra capacity licenses", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register an extra capacity license", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials": { - "put": { - "x-doc": { - "title": "Update extra capacity license serial numbers", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register extra capacity license serial numbers", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete extra capacity licenses using the license serial numbers", - "category": "Google Cloud systems (HA)", - "filename": "delete-gcp-ha-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/vscan-file-op": { - "put": { - "x-doc": { - "title": "Update the default Vscan file operation profile", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-vscan-file-op.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "x-doc": { - "title": "Update the NetApp Console password", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-update-credentials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/change-tier-level": { - "post": { - "x-doc": { - "title": "Update the tier level", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-change-tier-level.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/byol-to-capacity": { - "put": { - "x-doc": { - "title": "Update a BYOL license to a capacity-based license", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-byol-to-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/enable-worm": { - "put": { - "x-doc": { - "title": "Enable SnapLock on a system", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-enable-worm.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/ntp": { - "post": { - "x-doc": { - "title": "Set up an NTP server", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-ntp.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/start": { - "post": { - "x-doc": { - "title": "Start a Cloud Volumes ONTAP instance", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-start.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/support-registration": { - "get": { - "x-doc": { - "title": "Retrieve the support registration status", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-support-registration.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register a Cloud Volumes ONTAP system with NetApp", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-support-registration.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/schedules": { - "get": { - "x-doc": { - "title": "List the start/stop schedules for Cloud Volumes ONTAP", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-schedules.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Set the schedules for Cloud Volumes ONTAP", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-schedules.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/activate-fpolicy": { - "put": { - "x-doc": { - "title": "Activate FPolicy for ransomware files", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-activate-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/disable-fpolicy": { - "put": { - "x-doc": { - "title": "Disable FPolicy for ransomware files", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-disable-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/fpolicy": { - "delete": { - "x-doc": { - "title": "Delete FPolicy for ransomware files", - "category": "Google Cloud systems (HA)", - "filename": "delete-gcp-ha-working-environments-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/parse-license-file": { - "post": { - "x-doc": { - "title": "Parse an uploaded cloud license file", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-parse-license-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/user-tags": { - "get": { - "x-doc": { - "title": "Retrieve editable tags for cloud resources", - "category": "Google Cloud systems (HA)", - "filename": "get-gcp-ha-working-environments-user-tags.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Modify user tags for cloud resources", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-user-tags.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy": { - "put": { - "x-doc": { - "title": "Activate snapshot policy assignment for unprotected read/write volumes", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-activate-snapshot-policy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/snapshot-policy": { - "post": { - "x-doc": { - "title": " Create a snapshot policy", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-snapshot-policy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/change-serial": { - "post": { - "x-doc": { - "title": "Update the serial number of a system", - "category": "Google Cloud systems (HA)", - "filename": "post-gcp-ha-working-environments-change-serial.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/set-password": { - "put": { - "x-doc": { - "title": "Set the cluster password for a system", - "category": "Google Cloud systems (HA)", - "filename": "put-gcp-ha-working-environments-set-password.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}/add-capacity": { - "post": { - "x-doc": { - "title": "Add capacity to an elastic volume aggregate", - "category": "AWS aggregates (HA)", - "filename": "post-aws-ha-aggregates--add-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/aggregates": { - "get": { - "x-doc": { - "title": "Retrieve aggregates", - "category": "AWS aggregates (HA)", - "filename": "get-aws-ha-aggregates.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new aggregate", - "category": "AWS aggregates (HA)", - "filename": "post-aws-ha-aggregates.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}": { - "delete": { - "x-doc": { - "title": "Delete an aggregate", - "category": "AWS aggregates (HA)", - "filename": "delete-aws-ha-aggregates-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks": { - "post": { - "x-doc": { - "title": "Add disks to an existing aggregate", - "category": "AWS aggregates (HA)", - "filename": "post-aws-ha-aggregates--disks.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/discovery/discover": { - "get": { - "x-doc": { - "title": "Retrieve a list of discovered systems", - "category": "AWS system discovery (HA)", - "filename": "get-aws-ha-discovery-discover.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/discovery/recover": { - "post": { - "x-doc": { - "title": "Save a previously discovered system", - "category": "AWS system discovery (HA)", - "filename": "post-aws-ha-discovery-recover.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/encryption/{workingEnvironmentId}/update-key-manager-ca-certificate": { - "post": { - "x-doc": { - "title": "Update the key manager CA certificate on a system", - "category": "AWS system encryption (HA)", - "filename": "post-aws-ha-encryption-update-key-manager-ca-certificate.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/encryption/{workingEnvironmentId}/update-client-certificate": { - "post": { - "x-doc": { - "title": "Update client certificate on a system", - "category": "AWS system encryption (HA)", - "filename": "post-aws-ha-encryption-update-client-certificate.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}": { - "post": { - "x-doc": { - "title": "Add a key manager to a system", - "category": "AWS system encryption (HA)", - "filename": "post-aws-ha-encryption-key-managers-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a key manager from a system", - "category": "AWS system encryption (HA)", - "filename": "delete-aws-ha-encryption-key-managers-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/validate-floating-ips": { - "post": { - "x-doc": { - "title": "Validate HA floating IP addresses", - "category": "AWS system metadata (HA)", - "filename": "post-aws-ha-metadata-validate-floating-ips.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/route-tables": { - "get": { - "x-doc": { - "title": "Retrieve route tables per VPC and their subnet associations", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-route-tables.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/permutations": { - "get": { - "x-doc": { - "title": "Retrieve all system configurations", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-permutations.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/manifests": { - "get": { - "x-doc": { - "title": "Retrieve all NetApp Console manifests", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-manifests.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/vpcs": { - "get": { - "x-doc": { - "title": "Retrieve VPCs", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-vpcs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/key-pairs": { - "get": { - "x-doc": { - "title": "Retrieve AWS user key pairs by region", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-key-pairs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/key-pairs-by-region": { - "get": { - "x-doc": { - "title": "Retrieve AWS user key pairs for all regions", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-key-pairs-by-region.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/instance-profiles": { - "get": { - "x-doc": { - "title": "Retrieve AWS instance profiles", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-instance-profiles.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/s3-summary": { - "get": { - "x-doc": { - "title": "Retrieve S3 buckets summary", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-s3-summary.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/network-requirements": { - "get": { - "x-doc": { - "title": "Retrieve the minimum number of required IP addresses", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-network-requirements.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/aws-encryption-keys": { - "get": { - "x-doc": { - "title": "Retrieve AWS encryption keys by region", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-aws-encryption-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/validate-subscribed-to-ontap-cloud": { - "post": { - "x-doc": { - "title": "Confirm the current user subscription", - "category": "AWS system metadata (HA)", - "filename": "post-aws-ha-metadata-validate-subscribed-to-ontap-cloud.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/get-buckets-details": { - "get": { - "x-doc": { - "title": "Retrieve all S3 buckets with additional information", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-get-buckets-details.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/get-buckets-application-info": { - "post": { - "x-doc": { - "title": "Retrieve the S3 buckets policy status and tiering level", - "category": "AWS system metadata (HA)", - "filename": "post-aws-ha-metadata-get-buckets-application-info.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/buckets": { - "get": { - "x-doc": { - "title": "Retrieve all S3 buckets", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/supported-capacity-tiers": { - "get": { - "x-doc": { - "title": "Retrieve supported capacity tiers for EBS volume types", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-supported-capacity-tiers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/create-bucket": { - "post": { - "x-doc": { - "title": "Create a new S3 bucket", - "category": "AWS system metadata (HA)", - "filename": "post-aws-ha-metadata-create-bucket.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/ebs-volume-types": { - "get": { - "x-doc": { - "title": "Retrieve supported EBS volume types", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-ebs-volume-types.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/tag-keys": { - "get": { - "x-doc": { - "title": "Retrieve all tag names", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-tag-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/regions": { - "get": { - "x-doc": { - "title": "Retrieve AWS regions", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-regions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/default-snapshot-policies": { - "get": { - "x-doc": { - "title": "Retrieve default snapshot policies available on a cluster", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-default-snapshot-policies.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering": { - "get": { - "x-doc": { - "title": "Retrieve unsupported instance types for acceleration and capacity tiering", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/supported-features": { - "get": { - "x-doc": { - "title": "Retrieve supported features", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-supported-features.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/metadata/packages": { - "get": { - "x-doc": { - "title": "Retrieve packages configuration", - "category": "AWS system metadata (HA)", - "filename": "get-aws-ha-metadata-packages.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/volumes/quote": { - "post": { - "x-doc": { - "title": "Retrieve quotes for a new volume", - "category": "AWS volumes (HA)", - "filename": "post-aws-ha-volumes-quote.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier": { - "post": { - "x-doc": { - "title": "Update the underlying volume tier", - "category": "AWS volumes (HA)", - "filename": "post-aws-ha-volumes--change-tier.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/volumes/volumes-for-backup": { - "get": { - "x-doc": { - "title": "Retrieve volumes for backup activation", - "category": "AWS volumes (HA)", - "filename": "get-aws-ha-volumes-volumes-for-backup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "x-doc": { - "title": "Modify an existing volume", - "category": "AWS volumes (HA)", - "filename": "put-aws-ha-volumes--.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing volume", - "category": "AWS volumes (HA)", - "filename": "delete-aws-ha-volumes--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy": { - "put": { - "x-doc": { - "title": "Add an export policy rule", - "category": "AWS volumes (HA)", - "filename": "put-aws-ha-volumes--exportpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/volumes/igroups/{workingEnvironmentId}/{svmName}": { - "get": { - "x-doc": { - "title": "Retrieve all igroups", - "category": "AWS volumes (HA)", - "filename": "get-aws-ha-volumes-igroups-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/volumes/initiator": { - "get": { - "x-doc": { - "title": "Retrieve all iSCSI initiators", - "category": "AWS volumes (HA)", - "filename": "get-aws-ha-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Add an iSCSI initiator", - "category": "AWS volumes (HA)", - "filename": "post-aws-ha-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "x-doc": { - "title": "Retrieve a list of snapshot descriptions for the volume", - "category": "AWS volumes (HA)", - "filename": "get-aws-ha-volumes--snapshots.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "x-doc": { - "title": "Clone an existing volume", - "category": "AWS volumes (HA)", - "filename": "post-aws-ha-volumes--clone.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move": { - "post": { - "x-doc": { - "title": "Move an existing volume", - "category": "AWS volumes (HA)", - "filename": "post-aws-ha-volumes--move.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/volumes": { - "get": { - "x-doc": { - "title": "Retrieve all volumes", - "category": "AWS volumes (HA)", - "filename": "get-aws-ha-volumes.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new volume", - "category": "AWS volumes (HA)", - "filename": "post-aws-ha-volumes.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "x-doc": { - "title": "Create a snapshot", - "category": "AWS volumes (HA)", - "filename": "post-aws-ha-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a snapshot", - "category": "AWS volumes (HA)", - "filename": "delete-aws-ha-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments": { - "get": { - "x-doc": { - "title": "Retrieve Cloud Volumes ONTAP systems", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new AWS HA Cloud Volumes ONTAP system", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/route-tables": { - "put": { - "x-doc": { - "title": "Update the route tables for an HA system", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-route-tables.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/update-mediator": { - "post": { - "x-doc": { - "title": "Update the mediator for a system", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-update-mediator.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist": { - "get": { - "x-doc": { - "title": "Check for non-persistent locks held on CIFS sessions", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-cifs-locks-exist.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve an HA system", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing system", - "category": "AWS systems (HA)", - "filename": "delete-aws-ha-working-environments-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/delete-cifs": { - "post": { - "x-doc": { - "title": "Delete the CIFS configuration for a system", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-delete-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "x-doc": { - "title": "Retrieve the CIFS configuration for a system", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new CIFS configuration for a system", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity": { - "get": { - "x-doc": { - "title": "Validate prerequisites for converting a system", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-validate-byol-to-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/writing-speed": { - "put": { - "x-doc": { - "title": "Set the writing speed for a system", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-writing-speed.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/license-instance-type": { - "get": { - "x-doc": { - "title": "Retrieve all license types and their associated instance types", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-license-instance-type.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Set the instance type", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-license-instance-type.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/ontap-available-images": { - "get": { - "x-doc": { - "title": "Retrieve images already installed on system", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-ontap-available-images.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/update-image": { - "post": { - "x-doc": { - "title": "Perform a complete image update operation", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-update-image.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/update-eligibility": { - "get": { - "x-doc": { - "title": "Retrieve the eligibility support status of a system", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-update-eligibility.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/upload-license-file": { - "post": { - "x-doc": { - "title": "Upload a cloud license file", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-upload-license-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/upload-licenses": { - "post": { - "x-doc": { - "title": "Upload cloud license file content", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-upload-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/offbox": { - "put": { - "x-doc": { - "title": "Activate an off-box configuration", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-offbox.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/networkOptimization": { - "put": { - "x-doc": { - "title": "Modify the network port broadcast domain MTU", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-networkoptimization.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/create-request-parameters": { - "get": { - "x-doc": { - "title": "Retrieve action parameters", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-create-request-parameters.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering": { - "post": { - "x-doc": { - "title": "Enable capacity tiering", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-enable-capacity-tiering.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions": { - "get": { - "x-doc": { - "title": "Retrieve a list of upgrade versions", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-occm-provided-upgrade-versions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/sync-subscription": { - "post": { - "x-doc": { - "title": "Trigger subscription synchronization", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-sync-subscription.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/cost-and-usage": { - "get": { - "x-doc": { - "title": "Retrieve the system cost and usage", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-cost-and-usage.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/ontap-saving": { - "get": { - "x-doc": { - "title": "Retrieve systems ONTAP savings", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-ontap-saving.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses": { - "get": { - "x-doc": { - "title": "Retrieve extra capacity licenses", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update an extra capacity license", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register an extra capacity license", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials": { - "put": { - "x-doc": { - "title": "Update extra capacity license serial numbers", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register extra capacity license serial numbers", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete extra capacity licenses using the serial number", - "category": "AWS systems (HA)", - "filename": "delete-aws-ha-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/vscan-file-op": { - "put": { - "x-doc": { - "title": "Update the default Vscan file operation profile", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-vscan-file-op.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "x-doc": { - "title": "Update the NetApp Console password", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-update-credentials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/change-tier-level": { - "post": { - "x-doc": { - "title": "Update the tier level", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-change-tier-level.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/byol-to-capacity": { - "put": { - "x-doc": { - "title": "Update a BYOL license to a capacity-based license", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-byol-to-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/enable-worm": { - "put": { - "x-doc": { - "title": "Enable SnapLock for a system", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-enable-worm.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/ntp": { - "post": { - "x-doc": { - "title": "Set up an NTP server", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-ntp.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/start": { - "post": { - "x-doc": { - "title": "Start a specific instance", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-start.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/stop": { - "post": { - "x-doc": { - "title": "Stop a specific instance", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-stop.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/support-registration": { - "get": { - "x-doc": { - "title": "Retrieve the support registration status of a system", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-support-registration.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register a system with NetApp", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-support-registration.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/schedules": { - "get": { - "x-doc": { - "title": "List the start/stop schedules for a system", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-schedules.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Set the schedules for a system", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-schedules.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/svm": { - "put": { - "x-doc": { - "title": "Modify the SVM name of a system", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-svm.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/activate-fpolicy": { - "put": { - "x-doc": { - "title": "Activate FPolicy for ransomware files", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-activate-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/disable-fpolicy": { - "put": { - "x-doc": { - "title": "Disable FPolicy for ransomware files", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-disable-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/fpolicy": { - "delete": { - "x-doc": { - "title": "Delete FPolicy for ransomware files", - "category": "AWS systems (HA)", - "filename": "delete-aws-ha-working-environments-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/parse-license-file": { - "post": { - "x-doc": { - "title": "Parse an uploaded cloud license file", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-parse-license-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/user-tags": { - "get": { - "x-doc": { - "title": "Retrieve editable tags for cloud resources", - "category": "AWS systems (HA)", - "filename": "get-aws-ha-working-environments-user-tags.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Modify user tags for cloud resources", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-user-tags.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy": { - "put": { - "x-doc": { - "title": "Activate snapshot policy assignment for all unprotected read/write volumes", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-activate-snapshot-policy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/snapshot-policy": { - "post": { - "x-doc": { - "title": "Create a snapshot policy", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-snapshot-policy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/change-serial": { - "post": { - "x-doc": { - "title": "Update the serial number of a system", - "category": "AWS systems (HA)", - "filename": "post-aws-ha-working-environments-change-serial.html", - "subcategory": null, - "explorer": false - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/set-password": { - "put": { - "x-doc": { - "title": "Set the cluster password for a system", - "category": "AWS systems (HA)", - "filename": "put-aws-ha-working-environments-set-password.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/key-store": { - "post": { - "x-doc": { - "title": "Generate a new key pair and self-signed certificate", - "category": "NetApp Console key store", - "filename": "post-occm-key-store.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/key-store/external-certificate-file": { - "post": { - "x-doc": { - "title": "Generate a new key pair and self-signed certificate at the key store", - "category": "NetApp Console key store", - "filename": "post-occm-key-store-external-certificate-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/key-store/external-certificate": { - "post": { - "x-doc": { - "title": "Generate a new key pair and self-signed certificate at the key store", - "category": "NetApp Console key store", - "filename": "post-occm-key-store-external-certificate.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/key-store/trusted-certificate-file": { - "post": { - "x-doc": { - "title": "Validate and install the certificate in the trust store", - "category": "NetApp Console key store", - "filename": "post-occm-key-store-trusted-certificate-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/key-store/signed-certificate-file": { - "post": { - "x-doc": { - "title": "Validate and install the provided root CA chain", - "category": "NetApp Console key store", - "filename": "post-occm-key-store-signed-certificate-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/key-store/signed-certificate": { - "get": { - "x-doc": { - "title": "Retrieve the CA signed certificate", - "category": "NetApp Console key store", - "filename": "get-occm-key-store-signed-certificate.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Validate and install the provided root CA chain", - "category": "NetApp Console key store", - "filename": "post-occm-key-store-signed-certificate.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/key-store/self-certificate": { - "get": { - "x-doc": { - "title": "Retrieve the self-signed certificate of the NetApp Console key store", - "category": "NetApp Console key store", - "filename": "get-occm-key-store-self-certificate.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/key-store/user-trusted-certificates": { - "get": { - "x-doc": { - "title": "Return the existing trusted certificates from the trust store", - "category": "NetApp Console key store", - "filename": "get-occm-key-store-user-trusted-certificates.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/key-store/trusted-certificate/{certificateId}": { - "delete": { - "x-doc": { - "title": "Delete an existing trusted certificate from the trust store", - "category": "NetApp Console key store", - "filename": "delete-occm-key-store-trusted-certificate-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/monitoring/deploy-by-working-environments": { - "post": { - "x-doc": { - "title": "Deploy a monitoring instance by systems", - "category": "Monitoring operations", - "filename": "post-monitoring-deploy-by-working-environments.html", - "subcategory": null, - "explorer": false - } - } - }, - "/monitoring/info": { - "get": { - "x-doc": { - "title": "Retrieve monitoring information", - "category": "Monitoring operations", - "filename": "get-monitoring-info.html", - "subcategory": null, - "explorer": false - } - } - }, - "/monitoring/{workingEnvironmentId}/disable-monitoring": { - "post": { - "x-doc": { - "title": "Disable monitoring", - "category": "Monitoring operations", - "filename": "post-monitoring-disable-monitoring.html", - "subcategory": null, - "explorer": false - } - } - }, - "/monitoring/{workingEnvironmentId}/enable-monitoring": { - "post": { - "x-doc": { - "title": "Enable monitoring", - "category": "Monitoring operations", - "filename": "post-monitoring-enable-monitoring.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/asup/download-signed": { - "get": { - "x-doc": { - "title": "Retrieve the signed URL for the NetApp Console support data", - "category": "NetApp Console AutoSupport", - "filename": "get-occm-asup-download-signed.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/asup": { - "get": { - "x-doc": { - "title": "Retrieve the AutoSupport configuration", - "category": "NetApp Console AutoSupport", - "filename": "get-occm-asup.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update the AutoSupport configuration", - "category": "NetApp Console AutoSupport", - "filename": "put-occm-asup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/asup/download-ontap-cloud-asups": { - "get": { - "x-doc": { - "title": "Download a compressed file of all the AutoSupport files from all VSAs", - "category": "NetApp Console AutoSupport", - "filename": "get-occm-asup-download-ontap-cloud-asups.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/asup/send-Cot-performance-Asup/{workingEnvironmentId}": { - "post": { - "x-doc": { - "title": "Send performance archive support data to NetApp support", - "category": "NetApp Console AutoSupport", - "filename": "post-occm-asup-send-cot-performance-asup-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/asup/download": { - "get": { - "x-doc": { - "title": "Download NetApp Console support data", - "category": "NetApp Console AutoSupport", - "filename": "get-occm-asup-download.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/asup/send": { - "post": { - "x-doc": { - "title": "Send NetApp Console support data to NetApp support", - "category": "NetApp Console AutoSupport", - "filename": "post-occm-asup-send.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/asup/send-Cot-Asup": { - "post": { - "x-doc": { - "title": "Send Cloud Volumes ONTAP support data to NetApp support", - "category": "NetApp Console AutoSupport", - "filename": "post-occm-asup-send-cot-asup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/config/simplicator": { - "get": { - "x-doc": { - "title": "Retrieve the current simplicator URI and status", - "category": "NetApp Console configuration", - "filename": "get-occm-config-simplicator.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/config/simplicator/reset": { - "post": { - "x-doc": { - "title": "Reset to the default simplicator URI", - "category": "NetApp Console configuration", - "filename": "post-occm-config-simplicator-reset.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/config": { - "get": { - "x-doc": { - "title": "Retrieve NetApp Console configuration parameters", - "category": "NetApp Console configuration", - "filename": "get-occm-config.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Configure modifiable NetApp Console parameters", - "category": "NetApp Console configuration", - "filename": "put-occm-config.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/available-update-versions": { - "get": { - "x-doc": { - "title": "Check for a new version of the NetApp Console", - "category": "NetApp Console ", - "filename": "get-occm-system-available-update-versions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/cloud-ontap-update-image-metadata": { - "post": { - "x-doc": { - "title": "Perform a fetch and process of image update metadata files", - "category": "NetApp Console ", - "filename": "post-occm-system-cloud-ontap-update-image-metadata.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/cloud-ontap-update-metadata": { - "post": { - "x-doc": { - "title": "Perform a fetch and cache of Cloud Volumes ONTAP and NetApp Console files", - "category": "NetApp Console ", - "filename": "post-occm-system-cloud-ontap-update-metadata.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/cloud-provider-regions": { - "get": { - "x-doc": { - "title": "Retrieve supported regions for the cloud providers", - "category": "NetApp Console ", - "filename": "get-occm-system-cloud-provider-regions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/manually-activate-auto-vsa-capacity-management-cycle": { - "post": { - "x-doc": { - "title": "Activate the Cloud Volumes ONTAP capacity automatic management cycle", - "category": "NetApp Console ", - "filename": "post-occm-system-manually-activate-auto-vsa-capacity-management-cycle.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/manually-trigger-send-daily-notification": { - "post": { - "x-doc": { - "title": "Trigger sending daily notifications", - "category": "NetApp Console ", - "filename": "post-occm-system-manually-trigger-send-daily-notification.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/restart-server": { - "post": { - "x-doc": { - "title": "Restart the server", - "category": "NetApp Console ", - "filename": "post-occm-system-restart-server.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/feature-flags": { - "get": { - "x-doc": { - "title": "Retrieve feature flags", - "category": "NetApp Console ", - "filename": "get-occm-system-feature-flags.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/external-config": { - "get": { - "x-doc": { - "title": "Retrieve the NetApp Console feedback configuration", - "category": "NetApp Console ", - "filename": "get-occm-system-external-config.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/about": { - "get": { - "x-doc": { - "title": "Retrieve the NetApp Console server information", - "category": "NetApp Console ", - "filename": "get-occm-system-about.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/support-services": { - "get": { - "x-doc": { - "title": "Retrieve the NetApp Console support services information", - "category": "NetApp Console ", - "filename": "get-occm-system-support-services.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/update": { - "post": { - "x-doc": { - "title": "Update the NetApp Console", - "category": "NetApp Console ", - "filename": "post-occm-system-update.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/occm-instance-placement": { - "get": { - "x-doc": { - "title": "Retrieve the region, VPC, and subnet", - "category": "NetApp Console ", - "filename": "get-occm-system-occm-instance-placement.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/system/patch": { - "post": { - "x-doc": { - "title": "Update the NetApp Console with the specified patch version", - "category": "NetApp Console ", - "filename": "post-occm-system-patch.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/tenancy-service/users/update-current-user": { - "put": { - "x-doc": { - "title": "Update the current NetApp Console service user", - "category": "NetApp Console identity and access management", - "filename": "put-occm-tenancy-service-users-update-current-user.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/tenancy-service/workspaces/{workspaceId}/associate": { - "post": { - "x-doc": { - "title": "Associate a console agent with a workspace", - "category": "NetApp Console identity and access management", - "filename": "post-occm-tenancy-service-workspaces-associate.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/tenancy-service/workspaces": { - "get": { - "x-doc": { - "title": "Retrieve visible workspaces", - "category": "NetApp Console identity and access management", - "filename": "get-occm-tenancy-service-workspaces.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/aggregates": { - "get": { - "x-doc": { - "title": "Retrieve aggregates", - "category": "On-premises ONTAP cluster aggregates", - "filename": "get-onprem-aggregates.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/metadata/cluster-info": { - "get": { - "x-doc": { - "title": "Verify the address and credentials of a cluster", - "category": "On-premises ONTAP cluster metadata", - "filename": "get-onprem-metadata-cluster-info.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/volumes/volumes-for-backup": { - "get": { - "x-doc": { - "title": "Retrieve volumes for backup activation", - "category": "On-premises ONTAP cluster volumes", - "filename": "get-onprem-volumes-volumes-for-backup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "x-doc": { - "title": "Modify an existing volume", - "category": "On-premises ONTAP cluster volumes", - "filename": "put-onprem-volumes--.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing volume", - "category": "On-premises ONTAP cluster volumes", - "filename": "delete-onprem-volumes--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "x-doc": { - "title": "Retrieve a list of snapshot descriptions", - "category": "On-premises ONTAP cluster volumes", - "filename": "get-onprem-volumes--snapshots.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "x-doc": { - "title": "Clone an existing volume", - "category": "On-premises ONTAP cluster volumes", - "filename": "post-onprem-volumes--clone.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/volumes": { - "get": { - "x-doc": { - "title": "Retrieve volumes", - "category": "On-premises ONTAP cluster volumes", - "filename": "get-onprem-volumes.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new volume", - "category": "On-premises ONTAP cluster volumes", - "filename": "post-onprem-volumes.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "x-doc": { - "title": "Create a snapshot", - "category": "On-premises ONTAP cluster volumes", - "filename": "post-onprem-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a snapshot", - "category": "On-premises ONTAP cluster volumes", - "filename": "delete-onprem-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/azure-cloud-backup-setup": { - "post": { - "x-doc": { - "title": "Set up Azure backup to cloud", - "category": "On-premises ONTAP cluster systems", - "filename": "post-onprem-working-environments-azure-cloud-backup-setup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/aws-cloud-backup-setup": { - "post": { - "x-doc": { - "title": "Set up AWS backup to cloud", - "category": "On-premises ONTAP cluster systems", - "filename": "post-onprem-working-environments-aws-cloud-backup-setup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/gcp-cloud-backup-setup": { - "post": { - "x-doc": { - "title": "Set up Google Cloud backup to cloud", - "category": "On-premises ONTAP cluster systems", - "filename": "post-onprem-working-environments-gcp-cloud-backup-setup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/sgws-cloud-backup-setup": { - "post": { - "x-doc": { - "title": "Set up StorageGRID backup to cloud", - "category": "On-premises ONTAP cluster systems", - "filename": "post-onprem-working-environments-sgws-cloud-backup-setup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/ip-spaces": { - "get": { - "x-doc": { - "title": "Retrieve an IPspace list for an existing system", - "category": "On-premises ONTAP cluster systems", - "filename": "get-onprem-working-environments-ip-spaces.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/working-environments": { - "get": { - "x-doc": { - "title": "Retrieve on-premises systems", - "category": "On-premises ONTAP cluster systems", - "filename": "get-onprem-working-environments.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Discover an on-premises system", - "category": "On-premises ONTAP cluster systems", - "filename": "post-onprem-working-environments.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve an on-premises ONTAP system", - "category": "On-premises ONTAP cluster systems", - "filename": "get-onprem-working-environments-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an on-premises ONTAP system", - "category": "On-premises ONTAP cluster systems", - "filename": "delete-onprem-working-environments-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "x-doc": { - "title": "Modify the NetApp Console password", - "category": "On-premises ONTAP cluster systems", - "filename": "put-onprem-working-environments-update-credentials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "x-doc": { - "title": "Retrieve a CIFS configuration for a system", - "category": "On-premises ONTAP cluster systems", - "filename": "get-onprem-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/metadata/snapmirror-svm-policies/{sourceWorkingEnvironmentId}/{svmName}/{targetWorkingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve SnapMirror policies", - "category": "Replication metadata", - "filename": "get-replication-metadata-snapmirror-svm-policies--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/metadata/snapmirror-policies/{sourceWorkingEnvironmentId}/{targetWorkingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve SnapMirror policies", - "category": "Replication metadata", - "filename": "get-replication-metadata-snapmirror-policies-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/metadata/snapshot-labels/{workingEnvironmentId}/{svmName}/{volumeName}": { - "get": { - "x-doc": { - "title": "Return a list of snapshot labels", - "category": "Replication metadata", - "filename": "get-replication-metadata-snapshot-labels--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/break/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "post": { - "x-doc": { - "title": "Break a SnapMirror replication relationship", - "category": "Replication", - "filename": "post-replication-break--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/all-relationships": { - "get": { - "x-doc": { - "title": "Return pairs of relationships", - "category": "Replication", - "filename": "get-replication-all-relationships.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/fsx": { - "post": { - "x-doc": { - "title": "Create a new replication for an FSx system", - "category": "Replication", - "filename": "post-replication-fsx.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/onprem": { - "post": { - "x-doc": { - "title": "Create a new replication for an on-premises system", - "category": "Replication", - "filename": "post-replication-onprem.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/vsa": { - "post": { - "x-doc": { - "title": "Create a new replication for a Cloud Volumes ONTAP system", - "category": "Replication", - "filename": "post-replication-vsa.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/resync/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "post": { - "x-doc": { - "title": "Resync a SnapMirror replication relationship", - "category": "Replication", - "filename": "post-replication-resync--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/update/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "post": { - "x-doc": { - "title": "Update the destination endpoint of the SnapMirror relationship", - "category": "Replication", - "filename": "post-replication-update--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "delete": { - "x-doc": { - "title": "Remove a replication relationship", - "category": "Replication", - "filename": "delete-replication--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/initialize/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "post": { - "x-doc": { - "title": "Initialize an existing SnapMirror relationship", - "category": "Replication", - "filename": "post-replication-initialize--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/reverse/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "post": { - "x-doc": { - "title": "Reverse an existing SnapMirror relationship", - "category": "Replication", - "filename": "post-replication-reverse--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/{workingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "put": { - "x-doc": { - "title": "Modify a SnapMirror replication relationship", - "category": "Replication", - "filename": "put-replication--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/intercluster-lifs": { - "get": { - "x-doc": { - "title": "Retrieve the intercluster LIFs", - "category": "Replication", - "filename": "get-replication-intercluster-lifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/schedules/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve the replication schedules of a system", - "category": "Replication", - "filename": "get-replication-schedules-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/status": { - "get": { - "x-doc": { - "title": "Retrieve the status of all SnapMirror relationships", - "category": "Replication", - "filename": "get-replication-status.html", - "subcategory": null, - "explorer": false - } - } - }, - "/replication/status/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve SnapMirror replication relationship status", - "category": "Replication", - "filename": "get-replication-status-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/saas-mp-service/attach-subscription/{provider}/{cloudAccountId}": { - "put": { - "x-doc": { - "title": "Attach a SaaS subscription", - "category": "NetApp Console SaaS marketplace", - "filename": "put-occm-saas-mp-service-attach-subscription-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/saas-mp-service/{workingEnvironmentId}/subscription": { - "get": { - "x-doc": { - "title": "Retrieve SaaS marketplace subscriptions", - "category": "NetApp Console SaaS marketplace", - "filename": "get-occm-saas-mp-service-subscription.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/saas-mp-service/account": { - "get": { - "x-doc": { - "title": "Retrieve current SaaS marketplace accounts and subscriptions", - "category": "NetApp Console SaaS marketplace", - "filename": "get-occm-saas-mp-service-account.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/setup/validate/proxy": { - "post": { - "x-doc": { - "title": "Validate a proxy URL", - "category": "NetApp Console initial setup", - "filename": "post-occm-setup-validate-proxy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/setup/validate/connectivity": { - "post": { - "x-doc": { - "title": "Validate an active internet connection", - "category": "NetApp Console initial setup", - "filename": "post-occm-setup-validate-connectivity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/setup-portal/complete-connectivity-pending-setup": { - "post": { - "x-doc": { - "title": "Complete the setup", - "category": "NetApp Console initial setup", - "filename": "post-occm-setup-portal-complete-connectivity-pending-setup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/setup-portal/register": { - "post": { - "x-doc": { - "title": "Register NetApp Console", - "category": "NetApp Console initial setup", - "filename": "post-occm-setup-portal-register.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/setup-portal/register-in-local-auth": { - "post": { - "x-doc": { - "title": "Register NetApp Console to a dark site", - "category": "NetApp Console initial setup", - "filename": "post-occm-setup-portal-register-in-local-auth.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/setup-portal/init": { - "post": { - "x-doc": { - "title": "Perform an initial setup with NetApp Console", - "category": "NetApp Console initial setup", - "filename": "post-occm-setup-portal-init.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/setup-portal/init-standalone-local-auth": { - "post": { - "x-doc": { - "title": "Perform an initial standalone setup with the local identity provider", - "category": "NetApp Console initial setup", - "filename": "post-occm-setup-portal-init-standalone-local-auth.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/setup-portal/proxy/setup": { - "post": { - "x-doc": { - "title": "Set up a proxy URL", - "category": "NetApp Console initial setup", - "filename": "post-occm-setup-portal-proxy-setup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/occm/setup-portal/validate/connectivity": { - "post": { - "x-doc": { - "title": "Confirm the NetApp Console active internet connection", - "category": "NetApp Console initial setup", - "filename": "post-occm-setup-portal-validate-connectivity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/tenants/{tenantId}": { - "get": { - "x-doc": { - "title": "Retrieve a tenant", - "category": "Tenant operations", - "filename": "get-tenants-.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update an existing tenant", - "category": "Tenant operations", - "filename": "put-tenants-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing tenant", - "category": "Tenant operations", - "filename": "delete-tenants-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/tenants/{tenantId}/nss-keys": { - "put": { - "x-doc": { - "title": "Link a tenant to a NetApp support site account", - "category": "Tenant operations", - "filename": "put-tenants-nss-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/tenants": { - "get": { - "x-doc": { - "title": "Retrieve tenants", - "category": "Tenant operations", - "filename": "get-tenants.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new tenant", - "category": "Tenant operations", - "filename": "post-tenants.html", - "subcategory": null, - "explorer": false - } - } - }, - "/users/{userId}": { - "get": { - "x-doc": { - "title": "Retrieve a user", - "category": "User management", - "filename": "get-users-.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update an existing user", - "category": "User management", - "filename": "put-users-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing user", - "category": "User management", - "filename": "delete-users-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/users/{userId}/reset-password": { - "put": { - "x-doc": { - "title": "Reset the password", - "category": "User management", - "filename": "put-users-reset-password.html", - "subcategory": null, - "explorer": false - } - } - }, - "/users/{userId}/working-environments-grant-revoke": { - "post": { - "x-doc": { - "title": "Grant or revoke permissions to a user", - "category": "User management", - "filename": "post-users-working-environments-grant-revoke.html", - "subcategory": null, - "explorer": false - } - } - }, - "/users": { - "get": { - "x-doc": { - "title": "Retrieve all users", - "category": "User management", - "filename": "get-users.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new user", - "category": "User management", - "filename": "post-users.html", - "subcategory": null, - "explorer": false - } - } - }, - "/users/add-user": { - "post": { - "x-doc": { - "title": "Add a NetApp Cloud Central user to NetApp Console", - "category": "User management", - "filename": "post-users-add-user.html", - "subcategory": null, - "explorer": false - } - } - }, - "/users/{userId}/remove-user": { - "delete": { - "x-doc": { - "title": "Remove a user from NetApp Console", - "category": "User management", - "filename": "delete-users-remove-user.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/discover": { - "get": { - "x-doc": { - "title": "Retrieve a list of discovered systems", - "category": "Azure system discovery (single-node)", - "filename": "get-azure-vsa-discover.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/recover": { - "post": { - "x-doc": { - "title": "Save a previously discovered Cloud Volumes ONTAP system", - "category": "Azure system discovery (single-node)", - "filename": "post-azure-vsa-recover.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/associated-subscriptions": { - "get": { - "x-doc": { - "title": "Retrieve associated subscriptions", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-associated-subscriptions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/vnets": { - "get": { - "x-doc": { - "title": "Retrieve network extended information", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-vnets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/resource-groups": { - "get": { - "x-doc": { - "title": "Retrieve Azure resource groups by region", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-resource-groups.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/vaults": { - "get": { - "x-doc": { - "title": "Retrieve all vaults", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-vaults.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/keys-vault": { - "get": { - "x-doc": { - "title": "Retrieve all keys in a vault", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-keys-vault.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/network-requirements": { - "get": { - "x-doc": { - "title": "Retrieve the minimum number of required IP addresses", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-network-requirements.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/validate-subscribed-to-ontap-cloud": { - "post": { - "x-doc": { - "title": "Confirm the current user subscription", - "category": "Azure system metadata (single-node)", - "filename": "post-azure-vsa-metadata-validate-subscribed-to-ontap-cloud.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/create-container": { - "post": { - "x-doc": { - "title": "Create a new blob container", - "category": "Azure system metadata (single-node)", - "filename": "post-azure-vsa-metadata-create-container.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/availability-zones": { - "get": { - "x-doc": { - "title": "Retrieve Azure availability zones by region", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-availability-zones.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/supported-capacity-tiers": { - "get": { - "x-doc": { - "title": "Retrieve supported capacity tiers for Azure disk types", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-supported-capacity-tiers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/storage-account-types": { - "get": { - "x-doc": { - "title": "Retrieve supported Azure storage account types", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-storage-account-types.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/tag-keys": { - "get": { - "x-doc": { - "title": "Retrieve all tag names", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-tag-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/containers": { - "get": { - "x-doc": { - "title": "Retrieve all blob containers", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-containers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/permutations": { - "get": { - "x-doc": { - "title": "Retrieve all Cloud Volumes ONTAP configurations", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-permutations.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/regions": { - "get": { - "x-doc": { - "title": "Retrieve Azure regions", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-regions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/default-snapshot-policies": { - "get": { - "x-doc": { - "title": "Retrieve the default snapshot policies", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-default-snapshot-policies.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering": { - "get": { - "x-doc": { - "title": "Retrieve unsupported instance types for acceleration and capacity tiering", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/supported-features": { - "get": { - "x-doc": { - "title": "Retrieve supported features", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-supported-features.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/metadata/packages": { - "get": { - "x-doc": { - "title": "Retrieve package configurations", - "category": "Azure system metadata (single-node)", - "filename": "get-azure-vsa-metadata-packages.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/delete-cifs": { - "post": { - "x-doc": { - "title": "Delete the CIFS configuration for a system", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-delete-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "x-doc": { - "title": "Retrieve a CIFS configuration for a system", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Set up a new CIFS configuration", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity": { - "get": { - "x-doc": { - "title": "Validate prerequisites for converting a system", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-validate-byol-to-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve a Cloud Volumes ONTAP system", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing Cloud Volumes ONTAP system", - "category": "AWS systems (single-node)", - "filename": "delete-vsa-working-environments-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/writing-speed": { - "put": { - "x-doc": { - "title": "Set the writing speed for Cloud Volumes ONTAP", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-writing-speed.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/license-instance-type": { - "get": { - "x-doc": { - "title": "Retrieve all license types", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-license-instance-type.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Set the instance type", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-license-instance-type.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/ontap-available-images": { - "get": { - "x-doc": { - "title": "Retrieve images already installed on the system", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-ontap-available-images.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/update-image": { - "post": { - "x-doc": { - "title": "Perform a complete image update", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-update-image.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/update-eligibility": { - "get": { - "x-doc": { - "title": "Retrieve the eligibility support status", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-update-eligibility.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/upload-license-file": { - "post": { - "x-doc": { - "title": "Upload a cloud license file", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-upload-license-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/upload-licenses": { - "post": { - "x-doc": { - "title": "Upload cloud license file content", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-upload-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/offbox": { - "put": { - "x-doc": { - "title": "Activate an off-box configuration", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-offbox.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/networkOptimization": { - "put": { - "x-doc": { - "title": "Modify the network port broadcast domain MTU", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-networkoptimization.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/create-request-parameters": { - "get": { - "x-doc": { - "title": "Retrieve the action parameters", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-create-request-parameters.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering": { - "post": { - "x-doc": { - "title": "Enable capacity tiering", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-enable-capacity-tiering.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions": { - "get": { - "x-doc": { - "title": "Retrieve a list of upgrade versions", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-occm-provided-upgrade-versions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/sync-subscription": { - "post": { - "x-doc": { - "title": "Trigger subscription synchronization", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-sync-subscription.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/cost-and-usage": { - "get": { - "x-doc": { - "title": "Retrieve systems cost and usage", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-cost-and-usage.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/ontap-saving": { - "get": { - "x-doc": { - "title": "Retrieve systems ONTAP savings", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-ontap-saving.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses": { - "get": { - "x-doc": { - "title": "Retrieve extra capacity licenses", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update extra capacity licenses", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register extra capacity licenses", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials": { - "put": { - "x-doc": { - "title": "Update extra capacity serial numbers", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register extra capacity serial numbers", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete extra capacity licenses by serial numbers", - "category": "AWS systems (single-node)", - "filename": "delete-vsa-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/vscan-file-op": { - "put": { - "x-doc": { - "title": "Update the default Vscan file operation profile", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-vscan-file-op.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingOntapEnvironmentId}/update-credentials": { - "put": { - "x-doc": { - "title": "Update the NetApp Console password", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-update-credentials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/change-tier-level": { - "post": { - "x-doc": { - "title": "Modify the tier level", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-change-tier-level.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity": { - "put": { - "x-doc": { - "title": "Update the BYOL licence to a capacity-based license", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-byol-to-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/enable-worm": { - "put": { - "x-doc": { - "title": "Enable SnapLock for an existing system", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-enable-worm.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/ntp": { - "post": { - "x-doc": { - "title": "Set up an NTP server", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-ntp.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/start": { - "post": { - "x-doc": { - "title": "Start a specific Cloud Volumes ONTAP instance", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-start.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/stop": { - "post": { - "x-doc": { - "title": "Stop a specific Cloud Volumes ONTAP instance", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-stop.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/support-registration": { - "get": { - "x-doc": { - "title": "Retrieve the support registration status", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-support-registration.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register a Cloud Volumes ONTAP system", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-support-registration.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/schedules": { - "get": { - "x-doc": { - "title": "List the start/stop schedules", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-schedules.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Set the schedules", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-schedules.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/svm": { - "put": { - "x-doc": { - "title": "Modify the SVM name", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-svm.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy": { - "put": { - "x-doc": { - "title": "Activate the FPolicy for ransomware files", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-activate-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy": { - "put": { - "x-doc": { - "title": "Disable the FPolicy for ransomware files", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-disable-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/fpolicy": { - "delete": { - "x-doc": { - "title": "Delete the FPolicy for ransomware files", - "category": "AWS systems (single-node)", - "filename": "delete-vsa-working-environments-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/parse-license-file": { - "post": { - "x-doc": { - "title": "Parse an uploaded cloud license file", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-parse-license-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/user-tags": { - "get": { - "x-doc": { - "title": "Retrieve editable tags for cloud resources", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments-user-tags.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Modify user tags for cloud resources", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-user-tags.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy": { - "put": { - "x-doc": { - "title": "Activate snapshot policy assignments", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-activate-snapshot-policy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/snapshot-policy": { - "post": { - "x-doc": { - "title": "Create a snapshot policy", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-snapshot-policy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/change-serial": { - "post": { - "x-doc": { - "title": "Update the serial number of Cloud Volumes ONTAP", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments-change-serial.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/set-password": { - "put": { - "x-doc": { - "title": "Set the cluster password", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-set-password.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments": { - "get": { - "x-doc": { - "title": "Retrieve Cloud Volumes ONTAP systems", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new Cloud Volumes ONTAP system", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/svm/{svmName}": { - "delete": { - "x-doc": { - "title": "Delete an SVM", - "category": "Azure systems (single-node)", - "filename": "delete-azure-vsa-working-environments-svm-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/svm": { - "put": { - "x-doc": { - "title": "Modify the SVM name", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-svm.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new SVM", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-svm.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters": { - "get": { - "x-doc": { - "title": "Retrieve Azure VMware Solution private cloud clusters", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-resourcegroups-avs-private-clouds-clusters.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters/{clusterName}/hosts": { - "get": { - "x-doc": { - "title": "Retrieve Azure VMware Solution cluster hosts", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-resourcegroups-avs-private-clouds-clusters-hosts.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/available-ips-in-subnet": { - "get": { - "x-doc": { - "title": "Retrieve the number of available IP addresses", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-available-ips-in-subnet.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/resource-group-exists/{resourceGroupName}": { - "get": { - "x-doc": { - "title": "Check if a resource group with the specified name exists", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-resource-group-exists-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/avs-private-clouds": { - "get": { - "x-doc": { - "title": "Retrieve an Azure VMware Solution private cloud", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-avs-private-clouds.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve a Cloud Volumes ONTAP system", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing Cloud Volumes ONTAP system", - "category": "Azure systems (single-node)", - "filename": "delete-azure-vsa-working-environments-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/delete-cifs": { - "post": { - "x-doc": { - "title": "Delete a CIFS configuration", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-delete-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "x-doc": { - "title": "Retrieve a CIFS configuration", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Set up a new CIFS configuration", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity": { - "get": { - "x-doc": { - "title": "Validate prerequisites for converting a system", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-validate-byol-to-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/writing-speed": { - "put": { - "x-doc": { - "title": "Modify the writing speed", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-writing-speed.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/license-instance-type": { - "get": { - "x-doc": { - "title": "Retrieve all license types", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-license-instance-type.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Set the instance type", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-license-instance-type.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/ontap-available-images": { - "get": { - "x-doc": { - "title": "Retrieve images already installed", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-ontap-available-images.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/update-image": { - "post": { - "x-doc": { - "title": "Perform a complete image update operation", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-update-image.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/update-eligibility": { - "get": { - "x-doc": { - "title": "Retrieve the eligibility support status", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-update-eligibility.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/upload-license-file": { - "post": { - "x-doc": { - "title": "Upload a cloud license file", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-upload-license-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/upload-licenses": { - "post": { - "x-doc": { - "title": "Upload cloud license file content", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-upload-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/offbox": { - "put": { - "x-doc": { - "title": "Activate an off-box configuration", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-offbox.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/networkOptimization": { - "put": { - "x-doc": { - "title": "Modify the network port broadcast domain MTU", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-networkoptimization.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/create-request-parameters": { - "get": { - "x-doc": { - "title": "Retrieve the action parameters", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-create-request-parameters.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering": { - "post": { - "x-doc": { - "title": "Enable capacity tiering", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-enable-capacity-tiering.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions": { - "get": { - "x-doc": { - "title": "Retrieve a list of upgrade versions", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-occm-provided-upgrade-versions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/sync-subscription": { - "post": { - "x-doc": { - "title": "Trigger subscription synchronization", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-sync-subscription.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/cost-and-usage": { - "get": { - "x-doc": { - "title": "Retrieve systems cost and usage", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-cost-and-usage.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/ontap-saving": { - "get": { - "x-doc": { - "title": "Retrieve systems ONTAP savings", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-ontap-saving.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses": { - "get": { - "x-doc": { - "title": "Retrieve extra capacity licenses", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update extra capacity licenses", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register extra capacity licenses", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials": { - "put": { - "x-doc": { - "title": "Update extra capacity serial numbers", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register extra capacity serial numbers", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete extra capacity licenses by serial numbers", - "category": "Azure systems (single-node)", - "filename": "delete-azure-vsa-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/vscan-file-op": { - "put": { - "x-doc": { - "title": "Update the default Vscan file operation profile", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-vscan-file-op.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "x-doc": { - "title": "Update the NetApp Console password", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-update-credentials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/change-tier-level": { - "post": { - "x-doc": { - "title": "Change the tier level", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-change-tier-level.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity": { - "put": { - "x-doc": { - "title": "Update the BYOL licence to a capacity-based license", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-byol-to-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/enable-worm": { - "put": { - "x-doc": { - "title": "Enable SnapLock for an existing system", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-enable-worm.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/ntp": { - "post": { - "x-doc": { - "title": "Set up an NTP server", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-ntp.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/start": { - "post": { - "x-doc": { - "title": "Start a specific Cloud Volumes ONTAP instance", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-start.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/stop": { - "post": { - "x-doc": { - "title": "Stop a specific Cloud Volumes ONTAP instance", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-stop.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/support-registration": { - "get": { - "x-doc": { - "title": "Retrieve the support registration status", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-support-registration.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register a Cloud Volumes ONTAP system with NetApp", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-support-registration.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/schedules": { - "get": { - "x-doc": { - "title": "List the start-stop schedules", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-schedules.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Set the schedules for Cloud Volumes ONTAP", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-schedules.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy": { - "put": { - "x-doc": { - "title": "Activate the FPolicy for ransomware files", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-activate-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy": { - "put": { - "x-doc": { - "title": "Disable the FPolicy for ransomware files", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-disable-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/fpolicy": { - "delete": { - "x-doc": { - "title": "Delete the FPolicy for ransomware files", - "category": "Azure systems (single-node)", - "filename": "delete-azure-vsa-working-environments-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/parse-license-file": { - "post": { - "x-doc": { - "title": "Parse an uploaded cloud license file", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-parse-license-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/user-tags": { - "get": { - "x-doc": { - "title": "Retrieve editable tags for cloud resources", - "category": "Azure systems (single-node)", - "filename": "get-azure-vsa-working-environments-user-tags.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Modify user tags for cloud resources", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-user-tags.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy": { - "put": { - "x-doc": { - "title": "Activate snapshot policy assignment", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-activate-snapshot-policy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/snapshot-policy": { - "post": { - "x-doc": { - "title": "Create a snapshot policy", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-snapshot-policy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/change-serial": { - "post": { - "x-doc": { - "title": "Update the serial number of Cloud Volumes ONTAP", - "category": "Azure systems (single-node)", - "filename": "post-azure-vsa-working-environments-change-serial.html", - "subcategory": null, - "explorer": false - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/set-password": { - "put": { - "x-doc": { - "title": "Set the cluster password for a Cloud Volumes ONTAP system", - "category": "Azure systems (single-node)", - "filename": "put-azure-vsa-working-environments-set-password.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments": { - "get": { - "x-doc": { - "title": "Retrieve Cloud Volumes ONTAP systems", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new Cloud Volumes ONTAP system", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/svm/{svmName}": { - "delete": { - "x-doc": { - "title": "Delete an SVM", - "category": "Google Cloud systems (single-node)", - "filename": "delete-gcp-vsa-working-environments-svm-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/svm": { - "put": { - "x-doc": { - "title": "Modify the SVM name", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-svm.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new SVM", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-svm.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve a Cloud Volumes ONTAP system", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing Cloud Volumes ONTAP system", - "category": "Google Cloud systems (single-node)", - "filename": "delete-gcp-vsa-working-environments-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/delete-cifs": { - "post": { - "x-doc": { - "title": "Delete a CIFS configuration", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-delete-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "x-doc": { - "title": "Retrieve a CIFS configuration", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Set up a new CIFS configuration", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-cifs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity": { - "get": { - "x-doc": { - "title": "Validate prerequisites for converting a system", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-validate-byol-to-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/writing-speed": { - "put": { - "x-doc": { - "title": "Set the writing speed", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-writing-speed.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/license-instance-type": { - "get": { - "x-doc": { - "title": "Retrieve all license types and their associated instance types", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-license-instance-type.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Set the instance type", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-license-instance-type.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/ontap-available-images": { - "get": { - "x-doc": { - "title": "Retrieve images already installed", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-ontap-available-images.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/update-image": { - "post": { - "x-doc": { - "title": "Perform a complete image update operation", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-update-image.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/update-eligibility": { - "get": { - "x-doc": { - "title": "Retrieve the eligibility support status", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-update-eligibility.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/upload-license-file": { - "post": { - "x-doc": { - "title": "Upload a cloud license file", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-upload-license-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/upload-licenses": { - "post": { - "x-doc": { - "title": "Upload cloud license file content", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-upload-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/offbox": { - "put": { - "x-doc": { - "title": "Activate an offbox configuration", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-offbox.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/networkOptimization": { - "put": { - "x-doc": { - "title": "Modify the network port broadcast domain MTU", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-networkoptimization.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/create-request-parameters": { - "get": { - "x-doc": { - "title": "Retrieve the action parameters", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-create-request-parameters.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering": { - "post": { - "x-doc": { - "title": "Enable capacity tiering", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-enable-capacity-tiering.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions": { - "get": { - "x-doc": { - "title": "Retrieve a list of upgrade versions", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-occm-provided-upgrade-versions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/sync-subscription": { - "post": { - "x-doc": { - "title": "Trigger subscription synchronization", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-sync-subscription.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/cost-and-usage": { - "get": { - "x-doc": { - "title": "Retrieve system cost and usage", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-cost-and-usage.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/ontap-saving": { - "get": { - "x-doc": { - "title": "Retrieve system ONTAP savings", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-ontap-saving.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses": { - "get": { - "x-doc": { - "title": "Retrieve extra capacity licenses", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update extra capacity licenses", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register extra capacity licenses", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-extra-capacity-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials": { - "put": { - "x-doc": { - "title": "Update extra capacity serial numbers", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register extra capacity serial numbers", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete extra capacity licenses by serial numbers", - "category": "Google Cloud systems (single-node)", - "filename": "delete-gcp-vsa-working-environments-extra-capacity-serials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/vscan-file-op": { - "put": { - "x-doc": { - "title": "Update the default Vscan file operation profile", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-vscan-file-op.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "x-doc": { - "title": "Update the NetApp Console password", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-update-credentials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/change-tier-level": { - "post": { - "x-doc": { - "title": "Update the tier level", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-change-tier-level.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity": { - "put": { - "x-doc": { - "title": "Update a BYOL licence to a capacity-based license", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-byol-to-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/enable-worm": { - "put": { - "x-doc": { - "title": "Enable SnapLock for a system", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-enable-worm.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/ntp": { - "post": { - "x-doc": { - "title": "Set up an NTP server", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-ntp.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/start": { - "post": { - "x-doc": { - "title": "Start a Cloud Volumes ONTAP instance", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-start.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/stop": { - "post": { - "x-doc": { - "title": "Stop a Cloud Volumes ONTAP instance", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-stop.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/support-registration": { - "get": { - "x-doc": { - "title": "Retrieve the registration support status", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-support-registration.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Register a Cloud Volumes ONTAP system", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-support-registration.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/schedules": { - "get": { - "x-doc": { - "title": "List the start/stop schedules", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-schedules.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Set the schedules for Cloud Volumes ONTAP", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-schedules.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy": { - "put": { - "x-doc": { - "title": "Activate the FPolicy for ransomware files", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-activate-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy": { - "put": { - "x-doc": { - "title": "Disable the FPolicy for ransomware files", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-disable-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/fpolicy": { - "delete": { - "x-doc": { - "title": "Delete the FPolicy for ransomware files", - "category": "Google Cloud systems (single-node)", - "filename": "delete-gcp-vsa-working-environments-fpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/parse-license-file": { - "post": { - "x-doc": { - "title": "Parse an uploaded cloud license file", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-parse-license-file.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/user-tags": { - "get": { - "x-doc": { - "title": "Retrieve editable tags", - "category": "Google Cloud systems (single-node)", - "filename": "get-gcp-vsa-working-environments-user-tags.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Modify user tags for cloud resources", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-user-tags.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy": { - "put": { - "x-doc": { - "title": "Activate snapshot policy assignment", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-activate-snapshot-policy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/snapshot-policy": { - "post": { - "x-doc": { - "title": "Create a snapshot policy", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-snapshot-policy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/change-serial": { - "post": { - "x-doc": { - "title": "Update the serial number of Cloud Volumes ONTAP", - "category": "Google Cloud systems (single-node)", - "filename": "post-gcp-vsa-working-environments-change-serial.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/set-password": { - "put": { - "x-doc": { - "title": "Set the cluster password", - "category": "Google Cloud systems (single-node)", - "filename": "put-gcp-vsa-working-environments-set-password.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/add-capacity": { - "post": { - "x-doc": { - "title": "Add the capacity to an existing elastic volume aggregate", - "category": "AWS aggregates (single-node)", - "filename": "post-vsa-aggregates--add-capacity.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/aggregates": { - "get": { - "x-doc": { - "title": "Retrieve aggregates", - "category": "AWS aggregates (single-node)", - "filename": "get-vsa-aggregates.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new aggregate", - "category": "AWS aggregates (single-node)", - "filename": "post-vsa-aggregates.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/aggregates/{workingEnvironmentId}/{aggregateName}": { - "delete": { - "x-doc": { - "title": "Delete an existing aggregate", - "category": "AWS aggregates (single-node)", - "filename": "delete-vsa-aggregates-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks": { - "post": { - "x-doc": { - "title": "Add disks to an existing aggregate", - "category": "AWS aggregates (single-node)", - "filename": "post-vsa-aggregates--disks.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/discover": { - "get": { - "x-doc": { - "title": "Retrieve a list of discovered systems", - "category": "AWS system discovery (single-node)", - "filename": "get-vsa-discover.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/recover": { - "post": { - "x-doc": { - "title": "Save a previously discovered Cloud Volumes ONTAP system", - "category": "AWS system discovery (single-node)", - "filename": "post-vsa-recover.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/encryption/{workingEnvironmentId}/update-key-manager-ca-certificate": { - "post": { - "x-doc": { - "title": "Update the key manager CA certificate", - "category": "AWS system encryption (single-node)", - "filename": "post-vsa-encryption-update-key-manager-ca-certificate.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/encryption/{workingEnvironmentId}/update-client-certificate": { - "post": { - "x-doc": { - "title": "Update the client certificate", - "category": "AWS system encryption (single-node)", - "filename": "post-vsa-encryption-update-client-certificate.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}": { - "post": { - "x-doc": { - "title": "Add a key manager", - "category": "AWS system encryption (single-node)", - "filename": "post-vsa-encryption-key-managers-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a key manager", - "category": "AWS system encryption (single-node)", - "filename": "delete-vsa-encryption-key-managers-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/permutations": { - "get": { - "x-doc": { - "title": "Retrieve all Cloud Volumes ONTAP configurations", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-permutations.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/manifests": { - "get": { - "x-doc": { - "title": "Retrieve all NetApp Console manifests", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-manifests.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/vpcs": { - "get": { - "x-doc": { - "title": "Retrieve VPCs", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-vpcs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/key-pairs": { - "get": { - "x-doc": { - "title": "Retrieve AWS user key pairs by region", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-key-pairs.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/key-pairs-by-region": { - "get": { - "x-doc": { - "title": "Retrieve AWS user key pairs for all regions", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-key-pairs-by-region.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/instance-profiles": { - "get": { - "x-doc": { - "title": "Retrieve AWS instance profiles", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-instance-profiles.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/s3-summary": { - "get": { - "x-doc": { - "title": "Retrieve S3 buckets summary", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-s3-summary.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/network-requirements": { - "get": { - "x-doc": { - "title": "Retrieve the minimum number of required IP addresses", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-network-requirements.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/aws-encryption-keys": { - "get": { - "x-doc": { - "title": "Retrieve AWS encryption keys by region", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-aws-encryption-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/validate-subscribed-to-ontap-cloud": { - "post": { - "x-doc": { - "title": "Comfirm that the current user is subscribed", - "category": "AWS system metadata (single-node)", - "filename": "post-vsa-metadata-validate-subscribed-to-ontap-cloud.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/get-buckets-details": { - "get": { - "x-doc": { - "title": "Retrieve all S3 buckets", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-get-buckets-details.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/get-buckets-application-info": { - "post": { - "x-doc": { - "title": "Retrieve S3 buckets policy status and tiering level", - "category": "AWS system metadata (single-node)", - "filename": "post-vsa-metadata-get-buckets-application-info.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/buckets": { - "get": { - "x-doc": { - "title": "Retrieve all S3 buckets", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-buckets.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/supported-capacity-tiers": { - "get": { - "x-doc": { - "title": "Retrieve supported capacity tiers for EBS volume types", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-supported-capacity-tiers.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/create-bucket": { - "post": { - "x-doc": { - "title": "Create a new S3 bucket", - "category": "AWS system metadata (single-node)", - "filename": "post-vsa-metadata-create-bucket.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/ebs-volume-types": { - "get": { - "x-doc": { - "title": "Retrieve supported EBS volume types", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-ebs-volume-types.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/tag-keys": { - "get": { - "x-doc": { - "title": "Retrieve all tag names", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-tag-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/regions": { - "get": { - "x-doc": { - "title": "Retrieve AWS regions", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-regions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/default-snapshot-policies": { - "get": { - "x-doc": { - "title": "Retrieve default snapshot policies available on a cluster", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-default-snapshot-policies.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering": { - "get": { - "x-doc": { - "title": "Retrieve unsupported instance types for acceleration and capacity tiering", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/supported-features": { - "get": { - "x-doc": { - "title": "Retrieve supported features", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-supported-features.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/metadata/packages": { - "get": { - "x-doc": { - "title": "Retrieve package configurations", - "category": "AWS system metadata (single-node)", - "filename": "get-vsa-metadata-packages.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/volumes/quote": { - "post": { - "x-doc": { - "title": "Retrieve quotes for a new volume", - "category": "AWS volumes (single-node)", - "filename": "post-vsa-volumes-quote.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier": { - "post": { - "x-doc": { - "title": "Update the underlying volume tier", - "category": "AWS volumes (single-node)", - "filename": "post-vsa-volumes--change-tier.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/volumes/volumes-for-backup": { - "get": { - "x-doc": { - "title": "Retrieve the volumes for backup activation", - "category": "AWS volumes (single-node)", - "filename": "get-vsa-volumes-volumes-for-backup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "x-doc": { - "title": "Modify an existing volume", - "category": "AWS volumes (single-node)", - "filename": "put-vsa-volumes--.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an existing volume", - "category": "AWS volumes (single-node)", - "filename": "delete-vsa-volumes--.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy": { - "put": { - "x-doc": { - "title": "Add an export policy rule", - "category": "AWS volumes (single-node)", - "filename": "put-vsa-volumes--exportpolicy.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/volumes/igroups/{workingEnvironmentId}/{svmName}": { - "get": { - "x-doc": { - "title": "Retrieve all igroups", - "category": "AWS volumes (single-node)", - "filename": "get-vsa-volumes-igroups-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/volumes/initiator": { - "get": { - "x-doc": { - "title": "Retrieve all iSCSI initiators", - "category": "AWS volumes (single-node)", - "filename": "get-vsa-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Add an iSCSI initiator", - "category": "AWS volumes (single-node)", - "filename": "post-vsa-volumes-initiator.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "x-doc": { - "title": "Retrieve a list of snapshot descriptions for the volume", - "category": "AWS volumes (single-node)", - "filename": "get-vsa-volumes--snapshots.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "x-doc": { - "title": "Clone an existing volume", - "category": "AWS volumes (single-node)", - "filename": "post-vsa-volumes--clone.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "x-doc": { - "title": "Update the NetApp Console password ", - "category": "AWS systems (single-node)", - "filename": "put-vsa-working-environments-update-credentials.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move": { - "post": { - "x-doc": { - "title": "Move an existing volume", - "category": "AWS volumes (single-node)", - "filename": "post-vsa-volumes--move.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/volumes": { - "get": { - "x-doc": { - "title": "Retrieve volumes", - "category": "AWS volumes (single-node)", - "filename": "get-vsa-volumes.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new volume", - "category": "AWS volumes (single-node)", - "filename": "post-vsa-volumes.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "x-doc": { - "title": "Create a snapshot", - "category": "AWS volumes (single-node)", - "filename": "post-vsa-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a snapshot", - "category": "AWS volumes (single-node)", - "filename": "delete-vsa-volumes--snapshot.html", - "subcategory": null, - "explorer": false - } - } - }, - "/vsa/working-environments": { - "get": { - "x-doc": { - "title": "Retrieve Cloud Volumes ONTAP systems", - "category": "AWS systems (single-node)", - "filename": "get-vsa-working-environments.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create a new Cloud Volumes ONTAP system ", - "category": "AWS systems (single-node)", - "filename": "post-vsa-working-environments.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/vsa/metadata/workerPools": { - "get": { - "x-doc": { - "title": "Retrieve Google Cloud worker pools for a Cloud Volumes ONTAP system", - "category": "Google Cloud system metadata (HA)", - "filename": "get-gcp-vsa-metadata-workerpools.html", - "subcategory": null, - "explorer": false - } - } - }, - "/gcp/ha/metadata/workerPools": { - "get": { - "x-doc": { - "title": "Retrieve Google Cloud worker pools for a Cloud Volumes ONTAP system", - "category": "Google Cloud system metadata (single-node)", - "filename": "get-gcp-ha-metadata-workerpools.html", - "subcategory": null, - "explorer": false - } - } - } - } -} \ No newline at end of file diff --git a/cvo/cvo.json b/cvo/cvo.json deleted file mode 100644 index ba791b57..00000000 --- a/cvo/cvo.json +++ /dev/null @@ -1,49171 +0,0 @@ -{ - "openapi": "3.0.1", - "servers": [ - { - "url": "/occm/api" - } - ], - "paths": { - "/gcp/ha/discovery/discover": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Discovery" - ], - "description": "Retrieves a list of discovered systems visible to the current user in the specified Google Cloud region.", - "operationId": "discover", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "project", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DiscoveredGcpHaResponse" - } - } - } - } - } - } - } - }, - "/gcp/ha/discovery/recover": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Discovery" - ], - "description": "Saves a previously discovered Cloud Volumes ONTAP system to the NetApp Console database.", - "operationId": "recover", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecoverGcpHaRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpVsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/discover": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Discovery" - ], - "description": "Retrieves a list of discovered systems visible to the current user in the specified Google Cloud zone.", - "operationId": "discover_1", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "project", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DiscoveredGcpVsaResponse" - } - } - } - } - } - } - } - }, - "/gcp/vsa/recover": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Discovery" - ], - "description": "Saves a previously discovered Cloud Volumes ONTAP system to the NetApp Console database.", - "operationId": "recover_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecoverGcpVsaRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpVsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Modifies an existing volume.", - "operationId": "modifyVolume", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Deletes an existing volume.", - "operationId": "deleteVolume", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/volumes/volumes-for-backup": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Retrieves all volumes for backup activation.", - "operationId": "volumesForBackup", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "offset", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "limit", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "search", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filterBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListFilterByParam" - } - }, - { - "name": "sortBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListSortByParam" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumesListForBackup" - } - } - } - } - } - } - }, - "/azure/vsa/volumes/quote": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Retrieves quotes for a new volume. Returns the resource quote required for the requested volume.", - "operationId": "quoteVolume", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeQuoteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeQuoteResponse" - } - } - } - } - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Updates the underlying volume tier.", - "operationId": "changeVolumeTier", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeVolumeTierRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/volumes/igroups/{workingEnvironmentId}/{svmName}": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Retrieves all igroups.", - "operationId": "getIgroups", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/IGroup" - } - } - } - } - } - } - } - }, - "/azure/vsa/volumes/initiator": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Retrieves all iSCSI initiators.", - "operationId": "getInitiators", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Initiator" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Adds an iSCSI initiator.", - "operationId": "saveInitiator", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Initiator" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Returns a list of snapshot descriptions for the volume.", - "operationId": "volumeSnapshots", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotResponse" - } - } - } - } - } - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Adds an export policy rule.", - "operationId": "addExportPolicyRule", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Clones an existing volume.", - "operationId": "cloneVolume", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeCloneRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Creates a snapshot manually.", - "operationId": "createSnapshot", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Deletes a snapshot manually.", - "operationId": "deleteSnapshot", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Moves an existing volume.", - "operationId": "moveVolume", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeMoveRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/volumes": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Retrieves all volumes.", - "operationId": "volumes", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Volumes" - ], - "description": "Creates a new volume. If the aggregateName and maxNumOfDisksApprovedToAdd properties are not populated, the response fails with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.", - "operationId": "createVolume", - "parameters": [ - { - "name": "createAggregateIfNotFound", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/accounts/cloud-providers": { - "get": { - "tags": [ - "Account operations" - ], - "description": "Retrieves all cloud accounts (AWS, Azure, and Google Cloud).", - "operationId": "allAccountsBesidesNss", - "parameters": [ - { - "name": "providerType", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderAccountResponse" - } - } - } - } - }, - "deprecated": true - } - }, - "/accounts/aws/validate-creds": { - "post": { - "tags": [ - "Account operations" - ], - "description": "Retrieves an AWS cloud account ID for the specified credentials.", - "operationId": "getAwsCloudAccountId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AwsAccountRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - }, - "deprecated": true - } - }, - "/accounts/gcp/validate-creds": { - "post": { - "tags": [ - "Account operations" - ], - "description": "Validates a Google Cloud provider account request.", - "operationId": "validateGcpAccount", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpStorageAccountRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - }, - "deprecated": true - } - }, - "/accounts/azure/validate-creds": { - "post": { - "tags": [ - "Account operations" - ], - "description": "Validates an Azure account request.", - "operationId": "validateAzureAccount", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureAccountRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AssociatedSubscription" - } - } - } - } - } - }, - "deprecated": true - } - }, - "/accounts/azure": { - "post": { - "tags": [ - "Account operations" - ], - "description": "Creates an Azure account.", - "operationId": "createAzureAccount", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureAccountRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureAccountResponse" - } - } - } - } - }, - "deprecated": true - } - }, - "/accounts/gcp": { - "post": { - "tags": [ - "Account operations" - ], - "description": "Creates a Google Cloud storage account.", - "operationId": "createGcpStorageAccount", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpStorageAccountRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpAccountResponse" - } - } - } - } - }, - "deprecated": true - } - }, - "/accounts/gcp/{cloudProviderAccountId}": { - "get": { - "tags": [ - "Account operations" - ], - "description": "Retrieves a Google Cloud storage account using the public ID.", - "operationId": "gcpStorageAccount", - "parameters": [ - { - "name": "cloudProviderAccountId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpAccountResponse" - } - } - } - } - }, - "deprecated": true - }, - "put": { - "tags": [ - "Account operations" - ], - "description": "Updates an existing Google Cloud storage account.", - "operationId": "updateGcpStorageAccount", - "parameters": [ - { - "name": "cloudProviderAccountId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpStorageAccountRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpAccountResponse" - } - } - } - } - }, - "deprecated": true - } - }, - "/accounts/nss/set-vsa-list/{cloudProviderAccountId}": { - "put": { - "tags": [ - "Account operations" - ], - "description": "Updates the system list of an existing NetApp Support Site account.", - "operationId": "updateNssAccountVsaList", - "parameters": [ - { - "name": "cloudProviderAccountId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NssAccountVsaListRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/accounts/aws/{cloudProviderAccountId}": { - "get": { - "tags": [ - "Account operations" - ], - "description": "Retrieves an AWS account using the public ID.", - "operationId": "awsAccount", - "parameters": [ - { - "name": "cloudProviderAccountId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AwsAccountResponse" - } - } - } - } - }, - "deprecated": true - }, - "put": { - "tags": [ - "Account operations" - ], - "description": "Updates an existing AWS account.", - "operationId": "updateAwsAccount", - "parameters": [ - { - "name": "cloudProviderAccountId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AwsAccountRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AwsAccountResponse" - } - } - } - } - }, - "deprecated": true - } - }, - "/accounts/aws": { - "post": { - "tags": [ - "Account operations" - ], - "description": "Creates an AWS account.", - "operationId": "createAwsAccount", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AwsAccountRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AwsAccountResponse" - } - } - } - } - }, - "deprecated": true - } - }, - "/accounts/nss/{cloudProviderAccountId}": { - "get": { - "tags": [ - "Account operations" - ], - "description": "Retrieves a NetApp Support Site account using the public ID.", - "operationId": "nssAccount", - "parameters": [ - { - "name": "cloudProviderAccountId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NssAccountResponse" - } - } - } - } - } - }, - "put": { - "tags": [ - "Account operations" - ], - "description": "Updates an existing NetApp Support Site account.", - "operationId": "updateNssAccount", - "parameters": [ - { - "name": "cloudProviderAccountId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NssAccountRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NssAccountResponse" - } - } - } - } - } - } - }, - "/accounts/{cloudProviderAccountId}": { - "delete": { - "tags": [ - "Account operations" - ], - "description": "Deletes an existing account. You cannot delete an account that is attached to systems.", - "operationId": "deleteAccount", - "parameters": [ - { - "name": "cloudProviderAccountId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - }, - "deprecated": true - } - }, - "/accounts/azure/{cloudProviderAccountId}": { - "get": { - "tags": [ - "Account operations" - ], - "description": "Retrieves an Azure account using the public ID.", - "operationId": "azureAccount", - "parameters": [ - { - "name": "cloudProviderAccountId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureAccountResponse" - } - } - } - } - }, - "deprecated": true - }, - "put": { - "tags": [ - "Account operations" - ], - "description": "Updates an existing Azure account.", - "operationId": "updateAzureAccount", - "parameters": [ - { - "name": "cloudProviderAccountId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureAccountRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureAccountResponse" - } - } - } - } - }, - "deprecated": true - } - }, - "/accounts/nss": { - "post": { - "tags": [ - "Account operations" - ], - "description": "Creates a NetApp Support Site account.", - "operationId": "createNssAccount", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NssAccountRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NssAccountResponse" - } - } - } - } - } - } - }, - "/accounts": { - "get": { - "tags": [ - "Account operations" - ], - "description": "Retrieves accounts.", - "operationId": "allAccounts", - "parameters": [ - { - "name": "providerType", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderAccountResponse" - } - } - } - } - }, - "deprecated": true - } - }, - "/audit": { - "get": { - "tags": [ - "Audit operations" - ], - "description": "Retrieves audit group entries. You can optionally filter by query parameters.", - "operationId": "auditGroups", - "parameters": [ - { - "name": "limit", - "in": "query", - "schema": { - "type": "integer", - "format": "int32", - "default": 100 - } - }, - { - "name": "after", - "in": "query", - "schema": { - "type": "integer", - "format": "int64", - "default": 0 - } - }, - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AuditGroupSummary" - } - } - } - } - } - } - } - }, - "/audit/auditserver": { - "get": { - "tags": [ - "Audit operations" - ], - "description": "Retrieves audit groups and group records. You can optionally filter by query parameters.", - "operationId": "auditGroupsAndRecords", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AuditGroupSummary" - } - } - } - } - } - } - } - }, - "/audit/activeTask/{requestId}": { - "get": { - "tags": [ - "Audit operations" - ], - "description": "Retrieves the active task for the request ID.", - "operationId": "activeTaskByRequestId", - "parameters": [ - { - "name": "requestId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaskCacheEntry" - } - } - } - } - } - } - }, - "/audit/{requestId}": { - "get": { - "tags": [ - "Audit operations" - ], - "description": "Retrieves the audit group entry for the specified request ID.", - "operationId": "auditGroupByRequestId", - "parameters": [ - { - "name": "requestId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "records", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AuditGroupSummary" - } - } - } - } - } - } - } - }, - "/audit/local/audit/{accountId}": { - "get": { - "tags": [ - "Audit operations" - ], - "description": "Retrieves audit group entries. You can optionally filter by query parameters for the local UI.", - "operationId": "auditGroupsForLocal", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudCentralAuditGroupResponse" - } - } - } - } - } - } - } - }, - "/audit/local/audit/{accountId}/{service}/{requestId}/records": { - "get": { - "tags": [ - "Audit operations" - ], - "description": "Retrieves an audit record with the specified request ID for the local UI.", - "operationId": "auditRecordsForLocal", - "parameters": [ - { - "name": "requestId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudCentralAuditRecordResponse" - } - } - } - } - } - } - } - }, - "/audit/local/audit/{accountId}/options": { - "get": { - "tags": [ - "Audit operations" - ], - "description": "Retrieves audit page filter options for the local UI.", - "operationId": "auditOptionsForLocal", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CloudCentralAuditOptionsResponse" - } - } - } - } - } - } - }, - "/auth/logout": { - "post": { - "tags": [ - "User management operations - Authentication operations" - ], - "description": "Signs out of the NetApp Console.", - "operationId": "logout", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/auth/current-user": { - "get": { - "tags": [ - "User management operations - Authentication operations" - ], - "description": "Retrieves a representation of the current user.", - "operationId": "getCurrentUser", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserResponse" - } - } - } - } - } - } - }, - "/auth/current-user/change-password": { - "put": { - "tags": [ - "User management operations - Authentication operations" - ], - "description": "Updates the password for the current user.", - "operationId": "changeCurrentUserPassword", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResetPassword" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/auth/login": { - "post": { - "tags": [ - "User management operations - Authentication operations" - ], - "description": "Signs in to the NetApp Console.", - "operationId": "login", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserPasswordRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Aggregates" - ], - "description": "Updates IOPS and throughput for the disks in an existing aggregate.", - "operationId": "changeDisksIopsAndThrouput", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateDisksIopsAndThrouputRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud Azure system operations - Aggregates" - ], - "description": "Deletes an existing aggregate.", - "operationId": "deleteAggregate", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/aggregates/{workingEnvironmentId}": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Aggregates" - ], - "description": "Retrieves aggregates.", - "operationId": "aggregates", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AggregateResponse" - } - } - } - } - } - } - } - }, - "/azure/vsa/aggregates": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Aggregates" - ], - "description": "Creates a new aggregate.", - "operationId": "createAggregate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaAggregateCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Aggregates" - ], - "description": "Adds disks to an existing aggregate.", - "operationId": "addDisksToAggregate", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddDisksToAggregateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Aggregates" - ], - "description": "Updates IOPS and throughput for the disks in an existing aggregate.", - "operationId": "changeDisksIopsAndThrouput_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateDisksIopsAndThrouputRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Aggregates" - ], - "description": "Deletes an existing aggregate.", - "operationId": "deleteAggregate_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/aggregates/{workingEnvironmentId}": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Aggregates" - ], - "description": "Retrieves aggregates.", - "operationId": "aggregates_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AggregateResponse" - } - } - } - } - } - } - } - }, - "/azure/ha/aggregates": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Aggregates" - ], - "description": "Creates a new aggregate.", - "operationId": "createAggregate_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaAggregateCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Aggregates" - ], - "description": "Adds disks to an existing aggregate.", - "operationId": "addDisksToAggregate_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddDisksToAggregateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/discovery/recover": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Discovery" - ], - "description": "Saves a previously discovered Cloud Volumes ONTAP system to the NetApp Console database.", - "operationId": "discoverAzure", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecoverAzureHARequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureDiscoveredWorkingEnvironmentRequest" - } - } - } - } - } - } - }, - "/azure/ha/discovery/discover": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Discovery" - ], - "description": "Retrieves a list of discovered systems visible to the current user in the specified Azure region.", - "operationId": "discover_2", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DiscoveredAzureHaResponse" - } - } - } - } - } - } - } - }, - "/azure/ha/metadata/permutations": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves all ONTAP cloud configurations.", - "operationId": "permutations", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Configuration" - } - } - } - } - } - } - } - }, - "/azure/ha/metadata/network-requirements": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves the minimum number of required IP addresses for a Cloud Volumes ONTAP system.", - "operationId": "networkRequirements", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureNetworkRequirementsResponse" - } - } - } - } - } - } - }, - "/azure/ha/metadata/validate-subscribed-to-ontap-cloud": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Validates that the current user is subscribed to the Cloud Volumes ONTAP product in the Azure marketplace.", - "operationId": "validateSubscribedToOntapCloud", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureValidateSubscribedToOntapCloudRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureValidateSubscribedToOntapCloudResponse" - } - } - } - } - } - } - }, - "/azure/ha/metadata/associated-subscriptions": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves associated subscriptions.", - "operationId": "associatedSubscriptions", - "parameters": [ - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AssociatedSubscription" - } - } - } - } - } - } - } - }, - "/azure/ha/metadata/supported-capacity-tiers": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves the supported capacity tiers for Azure disk types.", - "operationId": "supportedCapacityTiers", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ontapVersion", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "dataEncryptionType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "licenseType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "instanceType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportedCapacityTiers" - } - } - } - } - } - } - }, - "/azure/ha/metadata/create-container": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Creates a new blob container.", - "operationId": "createBlobContainer", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateBlobContainerRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/metadata/availability-zones": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves Azure availability zones by region.", - "operationId": "availabilityZones", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureAvailabilityZoneResponse" - } - } - } - } - } - } - }, - "/azure/ha/metadata/vnets": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves network extended information.", - "operationId": "vpcs", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureNetworkExtendedResponse" - } - } - } - } - } - } - }, - "/azure/ha/metadata/vaults": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves all vaults.", - "operationId": "listVaults", - "parameters": [ - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureKeyVault" - } - } - } - } - } - } - } - }, - "/azure/ha/metadata/keys-vault": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves all keys in a vault.", - "operationId": "listKeysInVault", - "parameters": [ - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "resourceGroupName", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "vaultName", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureKey" - } - } - } - } - } - } - } - }, - "/azure/ha/metadata/resource-groups": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves Azure resource groups by region.", - "operationId": "resourceGroups", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureResourceGroupByRegionResponse" - } - } - } - } - } - } - } - }, - "/azure/ha/metadata/storage-account-types": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves supported Azure storage account types.", - "operationId": "disks", - "parameters": [ - { - "name": "isMultiZone", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "isFlashcacheInstance", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "isManagedDiskSupported", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureStorageAccountTypeResponse" - } - } - } - } - } - } - } - }, - "/azure/ha/metadata/tag-keys": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves all of the tag names.", - "operationId": "tagKeys", - "parameters": [ - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/TagKeyResponse" - } - } - } - } - } - } - } - }, - "/azure/ha/metadata/containers": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves all blob containers.", - "operationId": "listContainers", - "parameters": [ - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "resourceGroupName", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "storageAccountName", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureBlobContainer" - } - } - } - } - } - } - } - }, - "/azure/ha/metadata/regions": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves the Azure regions where a Cloud Volumes ONTAP system can be created.", - "operationId": "regions", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureRegionResponse" - } - } - } - } - } - } - } - }, - "/azure/ha/metadata/default-snapshot-policies": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves the default snapshot policies available on a cluster.", - "operationId": "defaultSnapshotPolicies", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicy" - } - } - } - } - } - } - } - }, - "/azure/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves the instance types that do not support acceleration and capacity tiering.", - "operationId": "instanceTypesNotSupportingAccelerationAndCapacityTiering", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse" - } - } - } - } - } - } - }, - "/azure/ha/metadata/supported-features": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves the supported features.", - "operationId": "supportedFeatures", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ontapVersion", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "dataEncryptionType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "licenseType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "instanceType", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportedFeaturesResponse" - } - } - } - } - } - } - }, - "/azure/ha/metadata/packages": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Metadata" - ], - "description": "Retrieves the packages configuration.", - "operationId": "packages", - "parameters": [ - { - "name": "deploymentModel", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "capacityPackage", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/PackageInfoResponse" - } - } - } - } - } - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/sync-avs-host": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Synchronizes Azure VMware Solution hosts on a volume.", - "operationId": "syncHostAvsOnVolume", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SyncAvsOnVolumeRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/remove-avs": { - "delete": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Removes Azure VMware Solution hosts on a volume.", - "operationId": "removeAvsOnVolume", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AvsOnVolumeRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Modifies an existing volume.", - "operationId": "modifyVolume_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Deletes an existing volume.", - "operationId": "deleteVolume_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/volumes/volumes-for-backup": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Retrieves all volumes for backup activation.", - "operationId": "volumesForBackup_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "offset", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "limit", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "search", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filterBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListFilterByParam" - } - }, - { - "name": "sortBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListSortByParam" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumesListForBackup" - } - } - } - } - } - } - }, - "/azure/ha/volumes/quote": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Retrieves quotes for a new volume. Returns the resource quote required for the requested volume.", - "operationId": "quoteVolume_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeQuoteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeQuoteResponse" - } - } - } - } - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Updates the underlying volume tier.", - "operationId": "changeVolumeTier_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeVolumeTierRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/volumes/igroups/{workingEnvironmentId}/{svmName}": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Retrieves all igroups.", - "operationId": "getIgroups_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/IGroup" - } - } - } - } - } - } - } - }, - "/azure/ha/volumes/initiator": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Retrieves all iSCSI initiators.", - "operationId": "getInitiators_1", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Initiator" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Adds an iSCSI initiator.", - "operationId": "saveInitiator_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Initiator" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Returns a list of snapshot descriptions for the volume.", - "operationId": "volumeSnapshots_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotResponse" - } - } - } - } - } - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Adds an export policy rule.", - "operationId": "addExportPolicyRule_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/setup-avs": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Sets up Azure VMware Solution on a volume.", - "operationId": "setupAvsOnVolume", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AvsOnVolumeRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Clones an existing volume.", - "operationId": "cloneVolume_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeCloneRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Creates a snapshot manually.", - "operationId": "createSnapshot_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Deletes a snapshot manually.", - "operationId": "deleteSnapshot_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Moves an existing volume.", - "operationId": "moveVolume_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeMoveRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/volumes": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Retrieves all volumes.", - "operationId": "volumes_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Volumes" - ], - "description": "Creates a new volume. If the aggregateName and maxNumOfDisksApprovedToAdd properties are not populated, the response fails with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.", - "operationId": "createVolume_1", - "parameters": [ - { - "name": "createAggregateIfNotFound", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves Cloud Volumes ONTAP systems visible to the current user.", - "operationId": "workingEnvironments", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "tenantId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureVsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Creates a new Azure HA Cloud Volumes ONTAP system.", - "operationId": "createAzureHaWorkingEnvironment", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateAzureVSAWorkingEnvironmentRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureVsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Checks for non-persistent locks held on CIFS sessions.", - "operationId": "cifsLocksExist", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/svm/{svmName}": { - "delete": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Deletes an SVM.", - "operationId": "deleteSvm", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/svm": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Modifies the SVM name of the Cloud Volumes ONTAP system.", - "operationId": "changeSvmName", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SvmNameModificationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Creates a new SVM.", - "operationId": "createSvm", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateAzureSvmRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves Azure VMware Solution private cloud clusters for the existing subscription.", - "operationId": "privateCloudClusters", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "privateCloudName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AvsPrivateCloudCluster" - } - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters/{clusterName}/hosts": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves Azure VMware Solution cluster hosts for the existing subscription.", - "operationId": "privateCloudClusterHosts", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "privateCloudName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "clusterName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AvsPrivateCloudClusterHost" - } - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/available-ips-in-subnet": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves the number of available IP addresses in the Cloud Volumes ONTAP system's subnet.", - "operationId": "availableIpsInVsaSubnet", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AvailableIpsResponse" - } - } - } - } - } - } - }, - "/azure/ha/working-environments/resource-group-exists/{resourceGroupName}": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Checks if a resource group with the specified name already exists. Returns true if a resource group with that name already exists, false otherwise.", - "operationId": "resourceGroupExists", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/avs-private-clouds": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves an Azure VMware Solution private cloud for the existing subscription.", - "operationId": "privateClouds", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AvsPrivateCloud" - } - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves a Cloud Volumes ONTAP system.", - "operationId": "workingEnvironment", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureVsaWorkingEnvironmentResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Deletes an existing Cloud Volumes ONTAP system, including all cloud resources created for the system (unless the localDelete flag is set to true).", - "operationId": "deleteVsaWorkingEnvironment", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "localDelete", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "forceDelete", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/delete-cifs": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Deletes the CIFS configuration of an existing Cloud Volumes ONTAP system.", - "operationId": "setupCifsConfiguration", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CIFSDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves the CIFS configuration for an existing Cloud Volumes ONTAP system.", - "operationId": "cifsConfiguration", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svm", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CIFSConfigurationResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Sets up a new CIFS configuration for an existing Cloud Volumes ONTAP system.", - "operationId": "setupCifsConfiguration_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CIFSConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Validates the prerequisites for converting an existing Cloud Volumes ONTAP system.", - "operationId": "preValidateByolToCapacity", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreValidationResponse" - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/writing-speed": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Sets the writing speed for Cloud Volumes ONTAP.", - "operationId": "modifyWritingSpeed", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WritingSpeedRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/license-instance-type": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves all license types and their associated instance types for a specific Cloud Volumes ONTAP instance.", - "operationId": "licenseAndInstanceTypes", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseAndInstanceType" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Sets the instance type of a specific Cloud Volumes ONTAP system.", - "operationId": "changeLicenseAndInstanceType", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseAndInstanceTypeModificationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/ontap-available-images": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves images already installed on the Cloud Volumes ONTAP system.", - "operationId": "ontapAvailableImages", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/UpdateLocalImage" - } - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/update-image": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP system.", - "operationId": "updateSystemImage", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateSystemImageRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/update-eligibility": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves the eligibility support status of a Cloud Volumes ONTAP system. Valid values are NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED.", - "operationId": "occmUpgradeEligibilityChecks", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EligibilityResponse" - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/upload-license-file": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Uploads a cloud license file on the specified Cloud Volumes ONTAP system.", - "operationId": "uploadLicenseFile", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves a list of versions to which this Cloud Volumes ONTAP system can be upgraded.", - "operationId": "occmProvidedCloudOntapUpgradeVersions", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OntapUpdateImageMetadata" - } - } - } - } - } - } - } - }, - "/azure/ha/working-environments/sync-subscription": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Manually triggers subscription synchronization for all Cloud Volumes ONTAP systems.", - "operationId": "syncVsaWorkingEnvironmentsSubscription", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/upload-licenses": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Uploads the content of a cloud license file on the specified Cloud Volumes ONTAP system.", - "operationId": "uploadLicenseFileContent", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseFileContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/offbox": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Activates an off-box configuration.", - "operationId": "activateOntapConfiguration", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/networkOptimization": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Modifies the network port broadcast domain MTU of the Cloud Volumes ONTAP system.", - "operationId": "changeNetworkOptimizationLevel", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeNetworkOptimizationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/create-request-parameters": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves the action parameters used in the create request for a specific Cloud Volumes ONTAP instance.", - "operationId": "createRequestParameters", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateRequestParametersResponse" - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Enables capacity tiering.", - "operationId": "enableCapacityTiering", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EnableCapacityTieringRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/cost-and-usage": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves the system cost and usage.", - "operationId": "workingEnvironmentCostAndUsage", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "start", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "end", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkingEnvironmentCostAndUsageResponse" - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/ontap-saving": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves system ONTAP savings.", - "operationId": "workingEnvironmentOntapSaving", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkingEnvironmentOntapSavingResponse" - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves extra capacity licenses for Cloud Volumes ONTAP.", - "operationId": "getExtraCapacityLicenses", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GetLicenseResponse" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": " Updates an extra capacity license.", - "operationId": "updateExtraCapacityLicenses", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Registers an extra capacity license.", - "operationId": "uploadExtraCapacityLicenses", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": " Updates an extra capacity license serial number.", - "operationId": "updateExtraCapacitySerials", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Registers an extra capacity serial number.", - "operationId": "uploadExtraCapacitySerials", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Deletes extra capacity licenses by serial numbers.", - "operationId": "deleteExtraCapacityLicenses", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/vscan-file-op": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Updates the default Vscan file operation profile. Profiles on existing CIFS shares will change only on writes-only mode.", - "operationId": "updateVscanFileOperation", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VscanFileOpRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/user-tags": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves the editable tags for the cloud resources in a specific Cloud Volumes ONTAP instance.", - "operationId": "userTags", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserTagsResponse" - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Modifies the user tags for cloud resources in a specific Cloud Volumes ONTAP instance.", - "operationId": "modifyUserTags", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ModifyUserTagsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/parse-license-file": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Parses an uploaded cloud license file.", - "operationId": "parseLicenseFile", - "parameters": [ - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProvidedLicenseResponse" - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Updates the NetApp Console password for a specific Cloud Volumes ONTAP system.", - "operationId": "updatePassword", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateCredentialsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/change-tier-level": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Updates the tier level.", - "operationId": "changeTierLevel", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeTierLevelRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/enable-worm": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Enables SnapLock for an existing Cloud Volumes ONTAP system.", - "operationId": "enableWorm", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WormRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/byol-to-capacity": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Updates a bring-your-own-license (BYOL) license to a capacity-based license for an existing Cloud Volumes ONTAP system.", - "operationId": "byolToCapacity", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseConversionRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RegisterCvoResponse" - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/ntp": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Sets up an NTP server.", - "operationId": "setupNtpServer", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NTPConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/start": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Starts a specific Cloud Volumes ONTAP instance.", - "operationId": "startVsa", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/stop": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Stops a specific Cloud Volumes ONTAP instance.", - "operationId": "stopVsa", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "takeSnapshots", - "in": "query", - "schema": { - "type": "boolean", - "default": true - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/support-registration": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Retrieves the support registration status of a Cloud Volumes ONTAP system.", - "operationId": "status", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportRegistrationResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Registers a Cloud Volumes ONTAP system with NetApp.", - "operationId": "registerSupport", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "nssAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportRegistrationResponse" - } - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/schedules": { - "get": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Lists the start/stop schedules for Cloud Volumes ONTAP.", - "operationId": "getSchedules", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaSchedule" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Sets schedules for Cloud Volumes ONTAP.", - "operationId": "setSchedules", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaSchedulesRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/activate-fpolicy": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Activates the FPolicy for ransomware files.", - "operationId": "activateFpolicy", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/disable-fpolicy": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Disables the FPolicy for ransomware files.", - "operationId": "disableFpolicy", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/fpolicy": { - "delete": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Deletes the FPolicy for ransomware files.", - "operationId": "deleteFpolicy", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Activates snapshot policy assignment for all unprotected read/write volumes.", - "operationId": "activateSnapshotPolicy", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/snapshot-policy": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Creates a snapshot policy.", - "operationId": "createSnapshotPolicy", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotPolicyCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/change-serial": { - "post": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Updates the serial number of a Cloud Volumes ONTAP system.", - "operationId": "changeSerialNumber", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeSerialNumberRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/ha/working-environments/{workingEnvironmentId}/set-password": { - "put": { - "tags": [ - "ONTAP Cloud Azure HA system operations - Systems" - ], - "description": "Sets the cluster password for a specific Cloud Volumes ONTAP system.", - "operationId": "setPassword", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "occmOnly", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordWrapper" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/cloud-compliance/deploy-by-working-environments": { - "post": { - "tags": [ - "Cloud Compliance Operations" - ], - "description": "Deploys a Cloud Compliance instance by systems.", - "operationId": "deployCloudComplianceInstance", - "requestBody": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/CreateCloudComplianceByWesRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/cloud-compliance/info": { - "get": { - "tags": [ - "Cloud Compliance Operations" - ], - "description": "Retrieves Cloud Compliance information.", - "operationId": "getCloudComplianceInfo", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CloudComplianceInfoResponse" - } - } - } - } - } - } - }, - "/cloud-compliance/{workingEnvironmentId}/disable-onprem-scan": { - "post": { - "tags": [ - "Cloud Compliance Operations" - ], - "description": "Disables on-premises scanning.", - "operationId": "disableOnpremScan", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/cloud-compliance/fsx/{fileSystemId}/compliance-status": { - "get": { - "tags": [ - "Cloud Compliance Operations" - ], - "description": "Retrieves the service Cloud Compliance status using the file system ID.", - "operationId": "getFsxComplianceStatus", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CloudComplianceStatusResponse" - } - } - } - } - } - } - }, - "/cloud-compliance/{serviceId}/compliance-status": { - "get": { - "tags": [ - "Cloud Compliance Operations" - ], - "description": "Retrieves the service Cloud Compliance status using the service ID.", - "operationId": "getServiceComplianceStatus", - "parameters": [ - { - "name": "serviceId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CloudComplianceStatusResponse" - } - } - } - } - } - } - }, - "/cloud-compliance/{serviceId}/enable-service-scan": { - "post": { - "tags": [ - "Cloud Compliance Operations" - ], - "description": "Enables scanning using the service ID.", - "operationId": "enableServiceScan", - "parameters": [ - { - "name": "serviceId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/EnableServiceScanRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/cloud-compliance/{serviceId}/disable-service-scan": { - "post": { - "tags": [ - "Cloud Compliance Operations" - ], - "description": "Disables scanning using the service ID.", - "operationId": "disableServiceScan", - "parameters": [ - { - "name": "serviceId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/cloud-compliance/{workingEnvironmentId}/enable-scan": { - "post": { - "tags": [ - "Cloud Compliance Operations" - ], - "description": "Enables scanning using the system ID.", - "operationId": "enableScan", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/cloud-compliance/{workingEnvironmentId}/disable-scan": { - "post": { - "tags": [ - "Cloud Compliance Operations" - ], - "description": "Disables scanning using the system ID.", - "operationId": "disableScan", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/cloud-compliance/fsx/{fileSystemId}/enable-scan": { - "post": { - "tags": [ - "Cloud Compliance Operations" - ], - "description": "Enables scanning using the file system ID.", - "operationId": "enableFsxScan", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/cloud-compliance/fsx/{fileSystemId}/disable-scan": { - "post": { - "tags": [ - "Cloud Compliance Operations" - ], - "description": "Disables scanning using the file system ID.", - "operationId": "disableFsxScan", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/cloud-compliance/{workingEnvironmentId}/enable-onprem-scan": { - "post": { - "tags": [ - "Cloud Compliance Operations" - ], - "description": "Enables on-premises scanning using the system ID.", - "operationId": "enableOnpremScan", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/encryption/certificate": { - "get": { - "tags": [ - "Cloud Manager system operations - Encryption - Certificate" - ], - "description": "Retrieves the installed certificate, if one exists.", - "operationId": "certificate", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "Cloud Manager system operations - Encryption - Certificate" - ], - "description": "Validates and installs the provided certificate. Successive API calls overwrite any previously installed certificates. The certificate must match a previously generated certificate signing request (CSR).", - "operationId": "installCertificate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InstallCertificatesRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - } - }, - "/occm/encryption/csr": { - "get": { - "tags": [ - "Cloud Manager system operations - Encryption - CSR" - ], - "description": "Retrieves the most recently generated certificate signing request (CSR), if it exists.", - "operationId": "csr", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CsrResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "Cloud Manager system operations - Encryption - CSR" - ], - "description": "Generates, stores, and returns a certificate signing request (CSR). This CSR can be signed by a certificate authority (CA) and installed in the NetApp Console using /install_certificate. Successive calls will not overwrite previously generated CSRs.", - "operationId": "generateCsr", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CsrResponse" - } - } - } - } - } - } - }, - "/occm/encryption/key-managers-ca-certificates": { - "get": { - "tags": [ - "Cloud Manager system operations - Encryption - Key manager certificate authority (CA) certificates operations" - ], - "description": "Retrieves all key manager certificate authority (CA) certificates.", - "operationId": "keyManagersCaCertificates", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "Cloud Manager system operations - Encryption - Key manager certificate authority (CA) certificates operations" - ], - "description": "Adds a new key manager certificate authority (CA) certificate.", - "operationId": "addKeyManagerCaCertificate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeyManagerCaCertificateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - } - }, - "/occm/encryption/key-managers-ca-certificates/{keyManagerCaCertificateId}": { - "get": { - "tags": [ - "Cloud Manager system operations - Encryption - Key manager certificate authority (CA) certificates operations" - ], - "description": "Retrieves a specific key manager certificate authority (CA) certificate.", - "operationId": "keyManagerCaCertificate", - "parameters": [ - { - "name": "keyManagerCaCertificateId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "Cloud Manager system operations - Encryption - Key manager certificate authority (CA) certificates operations" - ], - "description": "Deletes an existing key manager certificate authority (CA) certificate.", - "operationId": "deleteKeyManagerCaCertificate", - "parameters": [ - { - "name": "keyManagerCaCertificateId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/encryption/key-managers/{keyManagerId}": { - "get": { - "tags": [ - "Cloud Manager system operations - Encryption - Key managers" - ], - "description": "Returns specific key manager using the public ID.", - "operationId": "keyManager", - "parameters": [ - { - "name": "keyManagerId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeyManagerResponse" - } - } - } - } - } - }, - "put": { - "tags": [ - "Cloud Manager system operations - Encryption - Key managers" - ], - "description": "Updates an existing key manager.", - "operationId": "updateKeyManager", - "parameters": [ - { - "name": "keyManagerId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeyManagerRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeyManagerResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "Cloud Manager system operations - Encryption - Key managers" - ], - "description": "Deletes an existing key manager.", - "operationId": "deleteKeyManager", - "parameters": [ - { - "name": "keyManagerId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/encryption/key-managers": { - "get": { - "tags": [ - "Cloud Manager system operations - Encryption - Key managers" - ], - "description": "Retrieves all key managers.", - "operationId": "keyManagers", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/KeyManagerResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "Cloud Manager system operations - Encryption - Key managers" - ], - "description": "Adds a new key manager.", - "operationId": "addKeyManager", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeyManagerRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeyManagerResponse" - } - } - } - } - } - } - }, - "/working-environments/exists/{workingEnvironmentName}": { - "get": { - "tags": [ - "Common system operations" - ], - "description": "Checks if a system with the specified name already exists. Returns true if a system with that name already exists, false otherwise.", - "operationId": "workingEnvironmentsByName", - "parameters": [ - { - "name": "workingEnvironmentName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - } - } - } - }, - "/working-environments/actionRequired/{tenantId}": { - "get": { - "tags": [ - "Common system operations" - ], - "description": "Returns all non-premises system actions required for a specific tenant ID.", - "operationId": "actionsRequired", - "parameters": [ - { - "name": "tenantId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantActionsRequiredResponse" - } - } - } - } - } - } - }, - "/working-environments": { - "get": { - "tags": [ - "Common system operations" - ], - "description": "Retrieves all systems.", - "operationId": "workingEnvironments_1", - "parameters": [ - { - "name": "tenantId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkingEnvironments" - } - } - } - } - } - } - }, - "/working-environments/{workingEnvironmentId}": { - "get": { - "tags": [ - "Common system operations" - ], - "description": "Retrieves a Cloud Volumes ONTAP system.", - "operationId": "workingEnvironment_1", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenericVsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "/flexcache/fsx": { - "post": { - "tags": [ - "FlexCache Operations" - ], - "description": "Creates a new FlexCache volume in an FSx system.", - "operationId": "createFlexcacheFsx", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateFlexCacheRestRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/flexcache/all-relationships": { - "get": { - "tags": [ - "FlexCache Operations" - ], - "description": "Retrieves all FlexCache volume relationships.", - "operationId": "relationships", - "parameters": [ - { - "name": "workspaceId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AllRelationships" - } - } - } - } - } - } - }, - "/flexcache/{workingEnvironmentId}/caches/{cacheId}": { - "put": { - "tags": [ - "FlexCache Operations" - ], - "description": "Modifies a FlexCache volume.", - "operationId": "modifyFlexcache", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cacheId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ModifyFlexCacheRestRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "FlexCache Operations" - ], - "description": "Deletes a FlexCache volume.", - "operationId": "deleteFlexCache", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cacheId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/flexcache": { - "post": { - "tags": [ - "FlexCache Operations" - ], - "description": "Creates a new FlexCache volume in a Cloud Volumes ONTAP system.", - "operationId": "createFlexcache", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateFlexCacheRestRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/flexcache/caches": { - "get": { - "tags": [ - "FlexCache Operations" - ], - "description": "Retrieves all FlexCache volume lists.", - "operationId": "caches", - "parameters": [ - { - "name": "workspaceId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/FlexCacheResponse" - } - } - } - } - } - } - } - }, - "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}": { - "put": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Modifies an existing volume.", - "operationId": "modifyVolume_2", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FsxVolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Deletes an existing volume.", - "operationId": "deleteVolume_2", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/fsx/volumes/{fileSystemId}": { - "get": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Retrieves all volumes.", - "operationId": "fsxVolumes", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeResponse" - } - } - } - } - } - } - } - }, - "/fsx/volumes/{fileSystemId}/{volumeId}": { - "get": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Retrieves volume using the ID.", - "operationId": "volumeById", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeResponse" - } - } - } - } - } - } - }, - "/fsx/volumes/{fileSystemId}/nfs-clients": { - "get": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Retrieves an NFS client list for an existing FSx system.", - "operationId": "fsxNfsClients", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svm", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "volume", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/NfsClientsResponse" - } - } - } - } - } - } - } - }, - "/fsx/volumes/{fileSystemId}/shares": { - "get": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Retrieves a CIFS share list for an existing FSx system.", - "operationId": "fsxVolumesShares", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svm", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "volume", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeShareResponse" - } - } - } - } - } - } - } - }, - "/fsx/volumes/{fileSystemId}/count": { - "get": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Retrieves the volume count.", - "operationId": "fsxVolumeCount", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svm", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "int32" - } - } - } - } - } - } - }, - "/fsx/volumes/igroups/{fileSystemId}/{svmName}": { - "get": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Retrieves all igroups.", - "operationId": "getIgroups_2", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/IGroup" - } - } - } - } - } - } - } - }, - "/fsx/volumes/initiator": { - "get": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Retrieves all iSCSI initiators.", - "operationId": "getInitiators_2", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Initiator" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Adds an iSCSI initiator.", - "operationId": "saveInitiator_2", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Initiator" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/snapshots": { - "get": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Returns a list of snapshot descriptions for the volume.", - "operationId": "volumeSnapshots_2", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotResponse" - } - } - } - } - } - } - } - }, - "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/clone": { - "post": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Clones an existing volume.", - "operationId": "cloneVolume_2", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeCloneRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/snapshot": { - "post": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Creates a snapshot manually.", - "operationId": "createSnapshot_2", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Deletes a snapshot manually.", - "operationId": "deleteSnapshot_2", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/fsx/volumes": { - "post": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Creates a new volume.", - "operationId": "createVolume_2", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FsxVolumeCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/fsx/working-environments/{fileSystemId}/cifs": { - "get": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Systems" - ], - "description": "Retrieves a CIFS configuration for an existing FSx system.", - "operationId": "cifsConfiguration_1", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svm", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CIFSConfigurationResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Systems" - ], - "description": "Sets up a new CIFS configuration for an existing FSx system.", - "operationId": "setupCifsConfiguration_2", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CIFSConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/fsx/working-environments/{fileSystemId}/export-policies": { - "get": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Systems" - ], - "description": "Retrieves an export policies list for an existing FSx system.", - "operationId": "fsxExportPolicies", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svm", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ExportPolicyResponse" - } - } - } - } - } - } - } - }, - "/fsx/working-environments/{fileSystemId}/snapshot-policies": { - "get": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Systems" - ], - "description": "Retrieves the snapshot policies for an existing FSx system.", - "operationId": "snapshotPolicies", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicy" - } - } - } - } - } - } - } - }, - "/fsx/working-environments/{fileSystemId}/svms": { - "get": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Systems" - ], - "description": "Retrieves an SVM list for an existing FSx system.", - "operationId": "svmList", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SvmResponse" - } - } - } - } - } - } - } - }, - "/fsx/working-environments/{fileSystemId}/interfaces": { - "get": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Systems" - ], - "description": "Retrieves a network interfaces list for an existing FSx system.", - "operationId": "fsxInterfaces", - "parameters": [ - { - "name": "fileSystemId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svm", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InterfaceResponse" - } - } - } - } - } - } - } - }, - "/fsx/working-environments/validate-credentials": { - "post": { - "tags": [ - "FSx (Data ONTAP cluster) system operations - Systems" - ], - "description": "Validates the provided credentials for an existing FSx system.", - "operationId": "testCredentials", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ZapiCredentials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FsxCredentialsStatusResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/network-requirements": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves the minimum number of required IP addresses for a Cloud Volumes ONTAP system.", - "operationId": "networkRequirements_1", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpNetworkRequirementsResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/gcp-encryption-keys": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves Google Cloud encryption keys for a specific region.", - "operationId": "gcpEncryptionKeys", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "project", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpEncryptionKey" - } - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/service-accounts": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves a list of Service Accounts from the project.", - "operationId": "serviceAccounts", - "parameters": [ - { - "name": "project", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpServiceAccountsResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/supported-capacity-tiers": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves the supported capacity tiers for Google Cloud disk types.", - "operationId": "supportedCapacityTiers_1", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ontapVersion", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "dataEncryptionType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "licenseType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "instanceType", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportedCapacityTiers" - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/buckets": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves all cloud storage buckets.", - "operationId": "listBuckets", - "parameters": [ - { - "name": "projectId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpBucket" - } - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/workerPools": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves Google Cloud worker pools using Infrastructure Manager (IM) in which a private mode Cloud Volumes ONTAP system can be created.", - "operationId": "workerPools", - "parameters": [ - { - "name": "project", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OptionListWorkerPool" - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/create-bucket": { - "post": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Creates a new bucket.", - "operationId": "createBucket", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateBucketRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/metadata/gcp-disk-types": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves the supported Google Cloud disk types.", - "operationId": "disks_1", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpDiskTypeResponse" - } - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/tag-keys": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves all of the labels for the specific project ID and zone.", - "operationId": "tagKeys_1", - "parameters": [ - { - "name": "projectId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "zone", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/TagKeyResponse" - } - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/projects": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves a list of projects for which the user has permission.", - "operationId": "projects", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpProjectsResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/regions": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves Google Cloud regions where a Cloud Volumes ONTAP system can be created.", - "operationId": "regions_1", - "parameters": [ - { - "name": "project", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpRegionResponse" - } - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/permutations": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves all Cloud Volumes ONTAP configurations.", - "operationId": "permutations_1", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Configuration" - } - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/default-snapshot-policies": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves the default snapshot policies available on a cluster.", - "operationId": "defaultSnapshotPolicies_1", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicy" - } - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves the instance types that do not support acceleration and capacity tiering.", - "operationId": "instanceTypesNotSupportingAccelerationAndCapacityTiering_1", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/supported-features": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves the supported features.", - "operationId": "supportedFeatures_1", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ontapVersion", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "dataEncryptionType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "licenseType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "instanceType", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportedFeaturesResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/metadata/packages": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Metadata" - ], - "description": "Retrieves the packages configuration.", - "operationId": "packages_1", - "parameters": [ - { - "name": "deploymentModel", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "capacityPackage", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/PackageInfoResponse" - } - } - } - } - } - } - } - }, - "/gcp/vsa/aggregates/{workingEnvironmentId}": { - "get": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Aggregates" - ], - "description": "Retrieves aggregates.", - "operationId": "aggregates_2", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AggregateResponse" - } - } - } - } - } - } - } - }, - "/gcp/vsa/aggregates": { - "post": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Aggregates" - ], - "description": "Creates a new aggregate.", - "operationId": "createAggregate_2", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaAggregateCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName}": { - "delete": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Aggregates" - ], - "description": "Deletes an existing aggregate.", - "operationId": "deleteAggregate_2", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks": { - "post": { - "tags": [ - "ONTAP Cloud Google Cloud system operations - Aggregates" - ], - "description": "Adds disks to an existing aggregate.", - "operationId": "addDisksToAggregate_2", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddDisksToAggregateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Modifies an existing volume.", - "operationId": "modifyVolume_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Deletes an existing volume.", - "operationId": "deleteVolume_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/volumes/volumes-for-backup": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Retrieves all volumes for backup activation.", - "operationId": "volumesForBackup_2", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "offset", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "limit", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "search", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filterBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListFilterByParam" - } - }, - { - "name": "sortBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListSortByParam" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumesListForBackup" - } - } - } - } - } - } - }, - "/gcp/vsa/volumes/quote": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Retrieves quotes for a new volume. Returns the resource quote required for the requested volume.", - "operationId": "quoteVolume_2", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeQuoteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeQuoteResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Updates the underlying volume tier.", - "operationId": "changeVolumeTier_2", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeVolumeTierRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/volumes/igroups/{workingEnvironmentId}/{svmName}": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Retrieves all igroups.", - "operationId": "getIgroups_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/IGroup" - } - } - } - } - } - } - } - }, - "/gcp/vsa/volumes/initiator": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Retrieves all iSCSI initiators.", - "operationId": "getInitiators_3", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Initiator" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Adds an iSCSI initiator.", - "operationId": "saveInitiator_3", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Initiator" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Returns a list of snapshot descriptions for the volume.", - "operationId": "volumeSnapshots_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotResponse" - } - } - } - } - } - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Adds an export policy rule.", - "operationId": "addExportPolicyRule_2", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Clones an existing volume.", - "operationId": "cloneVolume_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeCloneRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Creates a snapshot manually.", - "operationId": "createSnapshot_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Deletes a snapshot manually.", - "operationId": "deleteSnapshot_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Moves an existing volume.", - "operationId": "moveVolume_2", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeMoveRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/volumes": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Retrieves all volumes.", - "operationId": "volumes_2", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Volumes" - ], - "description": "Creates a new volume. If the aggregateName and maxNumOfDisksApprovedToAdd properties are not populated, the response fails with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.", - "operationId": "createVolume_3", - "parameters": [ - { - "name": "createAggregateIfNotFound", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/aggregates/{workingEnvironmentId}": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Aggregates" - ], - "description": "Retrieves aggregates.", - "operationId": "aggregates_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AggregateResponse" - } - } - } - } - } - } - } - }, - "/gcp/ha/aggregates": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Aggregates" - ], - "description": "Creates a new aggregate.", - "operationId": "createAggregate_3", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaAggregateCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/aggregates/{workingEnvironmentId}/{aggregateName}": { - "delete": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Aggregates" - ], - "description": "Deletes an existing aggregate.", - "operationId": "deleteAggregate_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Aggregates" - ], - "description": "Adds disks to an existing aggregate.", - "operationId": "addDisksToAggregate_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddDisksToAggregateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/metadata/vpcs": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves Google Cloud networks and subnetworks where a Cloud Volumes ONTAP system can be created.", - "operationId": "connectivityForHa", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "project", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpConnectivityResponse" - } - } - } - } - } - } - } - }, - "/gcp/ha/metadata/zones": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves Google Cloud regions and zones where a Cloud Volumes ONTAP system can be created.", - "operationId": "regionsAndZones", - "parameters": [ - { - "name": "project", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpZonesAndRegionResponse" - } - } - } - } - } - } - } - }, - "/gcp/ha/metadata/tag-keys": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves all labels in the specified project ID and region.", - "operationId": "tagKeys_2", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "projectId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/TagKeyResponse" - } - } - } - } - } - } - } - }, - "/gcp/ha/metadata/permutations": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves all Cloud Volumes ONTAP configurations.", - "operationId": "permutations_2", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Configuration" - } - } - } - } - } - } - } - }, - "/gcp/ha/metadata/network-requirements": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves the minimum number of required IP addresses for a Cloud Volumes ONTAP system.", - "operationId": "networkRequirements_2", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpNetworkRequirementsResponse" - } - } - } - } - } - } - }, - "/gcp/ha/metadata/gcp-encryption-keys": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves Google Cloud encryption keys for a specific region.", - "operationId": "gcpEncryptionKeys_1", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "project", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpEncryptionKey" - } - } - } - } - } - } - } - }, - "/gcp/ha/metadata/service-accounts": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves a list of Service Accounts from the project.", - "operationId": "serviceAccounts_1", - "parameters": [ - { - "name": "project", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpServiceAccountsResponse" - } - } - } - } - } - } - }, - "/gcp/ha/metadata/supported-capacity-tiers": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves the supported capacity tiers for Google Cloud disk types.", - "operationId": "supportedCapacityTiers_2", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ontapVersion", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "dataEncryptionType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "licenseType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "instanceType", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportedCapacityTiers" - } - } - } - } - } - } - }, - "/gcp/ha/metadata/buckets": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves all cloud storage buckets.", - "operationId": "listBuckets_1", - "parameters": [ - { - "name": "projectId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpBucket" - } - } - } - } - } - } - } - }, - "/gcp/ha/metadata/workerPools": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves Google Cloud worker pools using Infrastructure Manager (IM) in which a private mode Cloud Volumes ONTAP system can be created.", - "operationId": "workerPools_1", - "parameters": [ - { - "name": "project", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OptionListWorkerPool" - } - } - } - } - } - } - }, - "/gcp/ha/metadata/create-bucket": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Creates a new bucket.", - "operationId": "createBucket_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateBucketRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/metadata/gcp-disk-types": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves the supported Google Cloud disk types.", - "operationId": "disks_2", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpDiskTypeResponse" - } - } - } - } - } - } - } - }, - "/gcp/ha/metadata/projects": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves a list of projects for which the user has permission.", - "operationId": "projects_1", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpProjectsResponse" - } - } - } - } - } - } - }, - "/gcp/ha/metadata/regions": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves Google Cloud regions where a Cloud Volumes ONTAP system can be created.", - "operationId": "regions_2", - "parameters": [ - { - "name": "project", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpRegionResponse" - } - } - } - } - } - } - } - }, - "/gcp/ha/metadata/default-snapshot-policies": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves the default snapshot policies available on a cluster.", - "operationId": "defaultSnapshotPolicies_2", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicy" - } - } - } - } - } - } - } - }, - "/gcp/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves the instance types that do not support acceleration and capacity tiering.", - "operationId": "instanceTypesNotSupportingAccelerationAndCapacityTiering_2", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse" - } - } - } - } - } - } - }, - "/gcp/ha/metadata/supported-features": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves the supported features.", - "operationId": "supportedFeatures_2", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ontapVersion", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "dataEncryptionType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "licenseType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "instanceType", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportedFeaturesResponse" - } - } - } - } - } - } - }, - "/gcp/ha/metadata/packages": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Metadata" - ], - "description": "Retrieves the packages configuration.", - "operationId": "packages_2", - "parameters": [ - { - "name": "deploymentModel", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "capacityPackage", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/PackageInfoResponse" - } - } - } - } - } - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Modifies an existing volume.", - "operationId": "modifyVolume_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Deletes an existing volume.", - "operationId": "deleteVolume_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/volumes/volumes-for-backup": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Retrieves all volumes for backup activation.", - "operationId": "volumesForBackup_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "offset", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "limit", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "search", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filterBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListFilterByParam" - } - }, - { - "name": "sortBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListSortByParam" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumesListForBackup" - } - } - } - } - } - } - }, - "/gcp/ha/volumes/quote": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Retrieves quotes for a new volume. Returns the resource quote required for the requested volume.", - "operationId": "quoteVolume_3", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeQuoteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeQuoteResponse" - } - } - } - } - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Updates the underlying volume tier.", - "operationId": "changeVolumeTier_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeVolumeTierRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/volumes/igroups/{workingEnvironmentId}/{svmName}": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Retrieves all igroups.", - "operationId": "getIgroups_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/IGroup" - } - } - } - } - } - } - } - }, - "/gcp/ha/volumes/initiator": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Retrieves all iSCSI initiators.", - "operationId": "getInitiators_4", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Initiator" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Adds an iSCSI initiator.", - "operationId": "saveInitiator_4", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Initiator" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Returns a list of snapshot descriptions for the volume.", - "operationId": "volumeSnapshots_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotResponse" - } - } - } - } - } - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Adds an export policy rule.", - "operationId": "addExportPolicyRule_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Clones an existing volume.", - "operationId": "cloneVolume_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeCloneRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Creates a snapshot manually.", - "operationId": "createSnapshot_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Deletes a snapshot manually.", - "operationId": "deleteSnapshot_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Moves an existing volume.", - "operationId": "moveVolume_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeMoveRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/volumes": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Retrieves all volumes.", - "operationId": "volumes_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Volumes" - ], - "description": "Creates a new volume. If the aggregateName and maxNumOfDisksApprovedToAdd properties are not populated, the response fails with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.", - "operationId": "createVolume_4", - "parameters": [ - { - "name": "createAggregateIfNotFound", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Retrieves Cloud Volumes ONTAP systems visible to the current user.", - "operationId": "workingEnvironments_2", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "tenantId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpVsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Creates a new Cloud Volumes ONTAP Google Cloud HA system.", - "operationId": "createVsaWorkingEnvironment", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateGcpVsaWorkingEnvironmentRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpVsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/stop": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Stops a specific Cloud Volumes ONTAP instance.", - "operationId": "stopVsa_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "takeSnapshots", - "in": "query", - "schema": { - "type": "boolean", - "default": true - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Checks for non-persistent locks held on CIFS sessions.", - "operationId": "cifsLocksExist_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/svm/{svmName}": { - "delete": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Deletes an SVM.", - "operationId": "deleteSvm_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/svm": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Modifies the SVM name of the Cloud Volumes ONTAP system.", - "operationId": "changeSvmName_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SvmNameModificationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Creates a new SVM.", - "operationId": "createSvm_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateSvmRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Retrieves a Cloud Volumes ONTAP system.", - "operationId": "workingEnvironment_2", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpVsaWorkingEnvironmentResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Deletes an existing Cloud Volumes ONTAP system, including all cloud resources created for the system (unless the localDelete flag is set to true).", - "operationId": "deleteVsaWorkingEnvironment_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "localDelete", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "forceDelete", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/delete-cifs": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Deletes the CIFS configuration of an existing Cloud Volumes ONTAP system.", - "operationId": "setupCifsConfiguration_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CIFSDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Retrieves the CIFS configuration for an existing Cloud Volumes ONTAP system.", - "operationId": "cifsConfiguration_2", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svm", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CIFSConfigurationResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Sets up a new CIFS configuration for an existing Cloud Volumes ONTAP system.", - "operationId": "setupCifsConfiguration_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CIFSConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Validates the prerequisites for converting an existing Cloud Volumes ONTAP system.", - "operationId": "preValidateByolToCapacity_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreValidationResponse" - } - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/writing-speed": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Sets the writing speed for Cloud Volumes ONTAP.", - "operationId": "modifyWritingSpeed_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WritingSpeedRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/license-instance-type": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Retrieves all license types and their associated instance types for a specific Cloud Volumes ONTAP instance.", - "operationId": "licenseAndInstanceTypes_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseAndInstanceType" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Sets the instance type of a specific Cloud Volumes ONTAP system.", - "operationId": "changeLicenseAndInstanceType_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseAndInstanceTypeModificationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/ontap-available-images": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Retrieves images already installed on the Cloud Volumes ONTAP system.", - "operationId": "ontapAvailableImages_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/UpdateLocalImage" - } - } - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/update-image": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP system.", - "operationId": "updateSystemImage_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateSystemImageRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/update-eligibility": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Retrieves the eligibility support status of a Cloud Volumes ONTAP system. Valid values are NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED.", - "operationId": "occmUpgradeEligibilityChecks_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EligibilityResponse" - } - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/upload-license-file": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Uploads a cloud license file on the specified Cloud Volumes ONTAP system.", - "operationId": "uploadLicenseFile_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Retrieves a list of versions to which this Cloud Volumes ONTAP system can be upgraded.", - "operationId": "occmProvidedCloudOntapUpgradeVersions_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OntapUpdateImageMetadata" - } - } - } - } - } - } - } - }, - "/gcp/ha/working-environments/sync-subscription": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Manually triggers subscription synchronization for all Cloud Volumes ONTAP systems.", - "operationId": "syncVsaWorkingEnvironmentsSubscription_1", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/upload-licenses": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Uploads the content of a cloud license file on the specified Cloud Volumes ONTAP system.", - "operationId": "uploadLicenseFileContent_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseFileContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/offbox": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Activates an off-box configuration.", - "operationId": "activateOntapConfiguration_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/networkOptimization": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Modifies the network port broadcast domain MTU of the Cloud Volumes ONTAP system.", - "operationId": "changeNetworkOptimizationLevel_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeNetworkOptimizationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/create-request-parameters": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Retrieves the action parameters used in the create request for a specific Cloud Volumes ONTAP instance.", - "operationId": "createRequestParameters_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateRequestParametersResponse" - } - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Enables capacity tiering.", - "operationId": "enableCapacityTiering_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EnableCapacityTieringRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/cost-and-usage": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Retrieves the system cost and usage.", - "operationId": "workingEnvironmentCostAndUsage_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "start", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "end", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkingEnvironmentCostAndUsageResponse" - } - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/ontap-saving": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Retrieves system ONTAP savings.", - "operationId": "workingEnvironmentOntapSaving_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkingEnvironmentOntapSavingResponse" - } - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Retrieves extra capacity licenses for Cloud Volumes ONTAP.", - "operationId": "getExtraCapacityLicenses_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GetLicenseResponse" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": " Updates an extra capacity license.", - "operationId": "updateExtraCapacityLicenses_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Registers an extra capacity license.", - "operationId": "uploadExtraCapacityLicenses_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": " Updates an extra capacity license serial number.", - "operationId": "updateExtraCapacitySerials_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Registers an extra capacity serial number.", - "operationId": "uploadExtraCapacitySerials_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Deletes extra capacity licenses by serial numbers.", - "operationId": "deleteExtraCapacityLicenses_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/vscan-file-op": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Updates the default Vscan file operation profile. Profiles on existing CIFS shares will change only on writes-only mode.", - "operationId": "updateVscanFileOperation_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VscanFileOpRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/user-tags": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Retrieves the editable tags for the cloud resources in a specific Cloud Volumes ONTAP instance.", - "operationId": "userTags_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserTagsResponse" - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Modifies the user tags for cloud resources in a specific Cloud Volumes ONTAP instance.", - "operationId": "modifyUserTags_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ModifyUserTagsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/parse-license-file": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Parses an uploaded cloud license file.", - "operationId": "parseLicenseFile_1", - "parameters": [ - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProvidedLicenseResponse" - } - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Updates the NetApp Console password for a specific Cloud Volumes ONTAP system.", - "operationId": "updatePassword_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateCredentialsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/change-tier-level": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Updates the tier level.", - "operationId": "changeTierLevel_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeTierLevelRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/enable-worm": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Enables SnapLock for an existing Cloud Volumes ONTAP system.", - "operationId": "enableWorm_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WormRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/byol-to-capacity": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Updates a bring-your-own-license (BYOL) license to a capacity-based license for an existing Cloud Volumes ONTAP system.", - "operationId": "byolToCapacity_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseConversionRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RegisterCvoResponse" - } - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/ntp": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Sets up an NTP server.", - "operationId": "setupNtpServer_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NTPConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/start": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Starts a specific Cloud Volumes ONTAP instance.", - "operationId": "startVsa_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/support-registration": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Retrieves the support registration status of a Cloud Volumes ONTAP system.", - "operationId": "status_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportRegistrationResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Registers a Cloud Volumes ONTAP system with NetApp.", - "operationId": "registerSupport_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "nssAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportRegistrationResponse" - } - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/schedules": { - "get": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Lists the start/stop schedules for Cloud Volumes ONTAP.", - "operationId": "getSchedules_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaSchedule" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Sets schedules for Cloud Volumes ONTAP.", - "operationId": "setSchedules_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaSchedulesRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/activate-fpolicy": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Activates the FPolicy for ransomware files.", - "operationId": "activateFpolicy_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/disable-fpolicy": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Disables the FPolicy for ransomware files.", - "operationId": "disableFpolicy_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/fpolicy": { - "delete": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Deletes the FPolicy for ransomware files.", - "operationId": "deleteFpolicy_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Activates snapshot policy assignment for all unprotected read/write volumes.", - "operationId": "activateSnapshotPolicy_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/snapshot-policy": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Creates a snapshot policy.", - "operationId": "createSnapshotPolicy_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotPolicyCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/change-serial": { - "post": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Updates the serial number of a Cloud Volumes ONTAP system.", - "operationId": "changeSerialNumber_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeSerialNumberRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/ha/working-environments/{workingEnvironmentId}/set-password": { - "put": { - "tags": [ - "ONTAP Cloud GCP HA system operations - Systems" - ], - "description": "Sets the cluster password for a specific Cloud Volumes ONTAP system.", - "operationId": "setPassword_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "occmOnly", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordWrapper" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}/add-capacity": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Aggregates" - ], - "description": "Adds capacity to an existing elastic volume aggregate.", - "operationId": "addCapacityToEvAggregate", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddCapacityToEvAggregateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/aggregates": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Aggregates" - ], - "description": "Retrieves aggregates.", - "operationId": "aggregates_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AggregateResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Aggregates" - ], - "description": "Creates a new aggregate.", - "operationId": "createAggregate_4", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaAggregateCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}": { - "delete": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Aggregates" - ], - "description": "Deletes an existing aggregate.", - "operationId": "deleteAggregate_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Aggregates" - ], - "description": "Adds disks to an existing aggregate.", - "operationId": "addDisksToAggregate_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddDisksToAggregateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/discovery/discover": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Discovery" - ], - "description": "Retrieves a list of discovered systems visible to the current user in the specified AWS region.", - "operationId": "discover_3", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DiscoveredAwsHaResponse" - } - } - } - } - } - } - } - }, - "/aws/ha/discovery/recover": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Discovery" - ], - "description": "Saves a previously discovered Cloud Volumes ONTAP system to the NetApp Console database.", - "operationId": "recover_2", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecoverVsaRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "/aws/ha/encryption/{workingEnvironmentId}/update-key-manager-ca-certificate": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Encryption" - ], - "description": "Updates the key manager certificate authority (CA) certificate on the Cloud Volumes ONTAP system.", - "operationId": "updateKeyManagerCaCertificate", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateKeyManagerCaCertificateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - } - }, - "/aws/ha/encryption/{workingEnvironmentId}/update-client-certificate": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Encryption" - ], - "description": "Updates the client certificate on the Cloud Volumes ONTAP system.", - "operationId": "updateClientCertificate", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - } - }, - "/aws/ha/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Encryption" - ], - "description": "Adds a key manager to the Cloud Volumes ONTAP system.", - "operationId": "addKeyManagerToVsa", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "keyManagerIp", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Encryption" - ], - "description": "Deletes a key manager from the Cloud Volumes ONTAP system.", - "operationId": "deleteKeyManagerFromVsa", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "keyManagerIp", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/metadata/validate-floating-ips": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Validates HA floating IP addresses.", - "operationId": "validateFloatingIps", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AwsHaFloatingIpValidationData" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AwsHaFloatingIpValidationResponse" - } - } - } - } - } - } - }, - "/aws/ha/metadata/route-tables": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves route tables per VPC and their subnet associations.", - "operationId": "routeTables", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "vpcId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/RouteTableResponse" - } - } - } - } - } - } - } - }, - "/aws/ha/metadata/permutations": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves all Cloud Volumes ONTAP configurations.", - "operationId": "permutations_3", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Configuration" - } - } - } - } - } - } - } - }, - "/aws/ha/metadata/network-requirements": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves the minimum number of required IP addresses for a single Cloud Volumes ONTAP system, HA node, and HA mediator.", - "operationId": "networkRequirements_3", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NetworkRequirementsResponse" - } - } - } - } - } - } - }, - "/aws/ha/metadata/aws-encryption-keys": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves AWS encryption keys for a specific region.", - "operationId": "awsEncryptionKeys", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AwsEncryptionKey" - } - } - } - } - } - } - } - }, - "/aws/ha/metadata/validate-subscribed-to-ontap-cloud": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Validates that the current user is subscribed to the Cloud Volumes ONTAP product in Amazon marketplace.", - "operationId": "validateSubscribedToOntapCloud_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AwsValidateSubscribedToOntapCloudRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AwsValidateSubscribedToOntapCloudResponse" - } - } - } - } - } - } - }, - "/aws/ha/metadata/get-buckets-details": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves all S3 buckets with additional information.", - "operationId": "listDetailedBuckets", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/S3BucketsSummary" - } - } - } - } - } - } - }, - "/aws/ha/metadata/get-buckets-application-info": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves the S3 buckets policy status and tiering level.", - "operationId": "getBucketsPolicyAndTieringData", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BucketsPolicyAndTieringInfoRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/BucketAdditionalData" - } - } - } - } - } - } - } - }, - "/aws/ha/metadata/supported-capacity-tiers": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves supported capacity tiers for EBS volume types.", - "operationId": "supportedCapacityTiers_3", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ontapVersion", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "dataEncryptionType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "licenseType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "instanceType", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportedCapacityTiers" - } - } - } - } - } - } - }, - "/aws/ha/metadata/buckets": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves all S3 buckets.", - "operationId": "listBuckets_2", - "parameters": [ - { - "name": "tagsRequired", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/S3BucketInfo" - } - } - } - } - } - } - } - }, - "/aws/ha/metadata/instance-profiles": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves AWS instance profiles.", - "operationId": "instanceProfiles", - "parameters": [ - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceProfileResponse" - } - } - } - } - } - } - } - }, - "/aws/ha/metadata/key-pairs": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves AWS user Key Pairs for a specific region.", - "operationId": "keyPairs", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "/aws/ha/metadata/key-pairs-by-region": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves AWS user Key Pairs for all regions.", - "operationId": "keyPairsByRegion", - "parameters": [ - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeyPairsByRegionResponse" - } - } - } - } - } - } - }, - "/aws/ha/metadata/manifests": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves all NetApp Console manifests. Refer to the API Developers Guide in order to understand how to extract valid region codes, license types, instance types and Cloud Volumes ONTAP version parameters for the creation of a Cloud Volumes ONTAP system.", - "operationId": "manifests", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MetadataResponse" - } - } - } - } - } - } - }, - "/aws/ha/metadata/vpcs": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves VPCs.", - "operationId": "vpcs_1", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VpcExtendedResponse" - } - } - } - } - } - } - } - }, - "/aws/ha/metadata/s3-summary": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves the S3 buckets summary.", - "operationId": "s3summary", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/S3Summary" - } - } - } - } - } - } - }, - "/aws/ha/metadata/create-bucket": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Creates a new S3 bucket.", - "operationId": "createBucket_2", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "bucketName", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/metadata/ebs-volume-types": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves supported EBS volume types.", - "operationId": "disks_3", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/EbsVolumeType" - } - } - } - } - } - } - } - }, - "/aws/ha/metadata/tag-keys": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves all of the tag names.", - "operationId": "tagKeys_3", - "parameters": [ - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/TagKeyResponse" - } - } - } - } - } - } - } - }, - "/aws/ha/metadata/regions": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves AWS regions over which a Cloud Volumes ONTAP system can be created.", - "operationId": "regions_3", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Region" - } - } - } - } - } - } - } - }, - "/aws/ha/metadata/default-snapshot-policies": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves the default snapshot policies available on a cluster.", - "operationId": "defaultSnapshotPolicies_3", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicy" - } - } - } - } - } - } - } - }, - "/aws/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves the instance types that do not support acceleration and capacity tiering.", - "operationId": "instanceTypesNotSupportingAccelerationAndCapacityTiering_3", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse" - } - } - } - } - } - } - }, - "/aws/ha/metadata/supported-features": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves the supported features.", - "operationId": "supportedFeatures_3", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ontapVersion", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "dataEncryptionType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "licenseType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "instanceType", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportedFeaturesResponse" - } - } - } - } - } - } - }, - "/aws/ha/metadata/packages": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Metadata" - ], - "description": "Retrieves the packages configuration.", - "operationId": "packages_3", - "parameters": [ - { - "name": "deploymentModel", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "capacityPackage", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/PackageInfoResponse" - } - } - } - } - } - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Modifies an existing volume.", - "operationId": "modifyVolume_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Deletes an existing volume.", - "operationId": "deleteVolume_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/volumes/volumes-for-backup": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Retrieves all volumes for backup activation.", - "operationId": "volumesForBackup_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "offset", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "limit", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "search", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filterBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListFilterByParam" - } - }, - { - "name": "sortBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListSortByParam" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumesListForBackup" - } - } - } - } - } - } - }, - "/aws/ha/volumes/quote": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Retrieves quotes for a new volume. Returns the resource quote required for the requested volume.", - "operationId": "quoteVolume_4", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeQuoteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeQuoteResponse" - } - } - } - } - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Updates the underlying volume tier.", - "operationId": "changeVolumeTier_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeVolumeTierRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/volumes/igroups/{workingEnvironmentId}/{svmName}": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Retrieves all igroups.", - "operationId": "getIgroups_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/IGroup" - } - } - } - } - } - } - } - }, - "/aws/ha/volumes/initiator": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Retrieves all iSCSI initiators.", - "operationId": "getInitiators_5", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Initiator" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Adds an iSCSI initiator.", - "operationId": "saveInitiator_5", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Initiator" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Returns a list of snapshot descriptions for the volume.", - "operationId": "volumeSnapshots_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotResponse" - } - } - } - } - } - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Adds an export policy rule.", - "operationId": "addExportPolicyRule_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Clones an existing volume.", - "operationId": "cloneVolume_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeCloneRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Creates a snapshot manually.", - "operationId": "createSnapshot_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Deletes a snapshot manually.", - "operationId": "deleteSnapshot_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Moves an existing volume.", - "operationId": "moveVolume_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeMoveRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/volumes": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Retrieves all volumes.", - "operationId": "volumes_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Volumes" - ], - "description": "Creates a new volume. If the aggregateName and maxNumOfDisksApprovedToAdd properties are not populated, the response fails with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.", - "operationId": "createVolume_5", - "parameters": [ - { - "name": "createAggregateIfNotFound", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/delete-cifs": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Deletes the CIFS configuration of an existing Cloud Volumes ONTAP system.", - "operationId": "setupCifsConfiguration_13", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CIFSDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Retrieves the CIFS configuration for an existing Cloud Volumes ONTAP system.", - "operationId": "cifsConfiguration_8", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svm", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CIFSConfigurationResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Sets up a new CIFS configuration for an existing Cloud Volumes ONTAP system.", - "operationId": "setupCifsConfiguration_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CIFSConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Validates the prerequisites for converting an existing Cloud Volumes ONTAP system.", - "operationId": "preValidateByolToCapacity_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreValidationResponse" - } - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Retrieves a Cloud Volumes ONTAP system.", - "operationId": "workingEnvironment_7", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaWorkingEnvironmentResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Deletes an existing Cloud Volumes ONTAP system, including all cloud resources created for the system (unless the localDelete flag is set to true).", - "operationId": "deleteVsaWorkingEnvironment_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "localDelete", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "forceDelete", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/writing-speed": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Sets the writing speed for Cloud Volumes ONTAP.", - "operationId": "modifyWritingSpeed_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WritingSpeedRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/license-instance-type": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Retrieves all license types and their associated instance types for a specific Cloud Volumes ONTAP instance.", - "operationId": "licenseAndInstanceTypes_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseAndInstanceType" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Sets the instance type of a specific Cloud Volumes ONTAP system.", - "operationId": "changeLicenseAndInstanceType_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseAndInstanceTypeModificationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/ontap-available-images": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Retrieves images already installed on the Cloud Volumes ONTAP system.", - "operationId": "ontapAvailableImages_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/UpdateLocalImage" - } - } - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/update-image": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP system.", - "operationId": "updateSystemImage_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateSystemImageRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/update-eligibility": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Retrieves the eligibility support status of a Cloud Volumes ONTAP system. Valid values are NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED.", - "operationId": "occmUpgradeEligibilityChecks_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EligibilityResponse" - } - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/upload-license-file": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Uploads a cloud license file on the specified Cloud Volumes ONTAP system.", - "operationId": "uploadLicenseFile_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Retrieves a list of versions to which this Cloud Volumes ONTAP system can be upgraded.", - "operationId": "occmProvidedCloudOntapUpgradeVersions_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OntapUpdateImageMetadata" - } - } - } - } - } - } - } - }, - "/vsa/working-environments/sync-subscription": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Manually triggers subscription synchronization for all Cloud Volumes ONTAP systems.", - "operationId": "syncVsaWorkingEnvironmentsSubscription_6", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/upload-licenses": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Uploads the content of a cloud license file on the specified Cloud Volumes ONTAP system.", - "operationId": "uploadLicenseFileContent_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseFileContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/offbox": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Activates an off-box configuration.", - "operationId": "activateOntapConfiguration_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/networkOptimization": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Modifies the network port broadcast domain MTU of the Cloud Volumes ONTAP system.", - "operationId": "changeNetworkOptimizationLevel_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeNetworkOptimizationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/create-request-parameters": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Retrieves the action parameters used in the create request for a specific Cloud Volumes ONTAP instance.", - "operationId": "createRequestParameters_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateRequestParametersResponse" - } - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Enables capacity tiering.", - "operationId": "enableCapacityTiering_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EnableCapacityTieringRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/cost-and-usage": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Retrieves the system cost and usage.", - "operationId": "workingEnvironmentCostAndUsage_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "start", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "end", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkingEnvironmentCostAndUsageResponse" - } - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/ontap-saving": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Retrieves system ONTAP savings.", - "operationId": "workingEnvironmentOntapSaving_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkingEnvironmentOntapSavingResponse" - } - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Retrieves extra capacity licenses for Cloud Volumes ONTAP.", - "operationId": "getExtraCapacityLicenses_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GetLicenseResponse" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": " Updates an extra capacity license.", - "operationId": "updateExtraCapacityLicenses_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Registers an extra capacity license.", - "operationId": "uploadExtraCapacityLicenses_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": " Updates an extra capacity license serial number.", - "operationId": "updateExtraCapacitySerials_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Registers an extra capacity serial number.", - "operationId": "uploadExtraCapacitySerials_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Deletes extra capacity licenses by serial numbers.", - "operationId": "deleteExtraCapacityLicenses_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/vscan-file-op": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Updates the default Vscan file operation profile. Profiles on existing CIFS shares will change only on writes-only mode.", - "operationId": "updateVscanFileOperation_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VscanFileOpRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/user-tags": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Retrieves the editable tags for the cloud resources in a specific Cloud Volumes ONTAP instance.", - "operationId": "userTags_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserTagsResponse" - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Modifies the user tags for cloud resources in a specific Cloud Volumes ONTAP instance.", - "operationId": "modifyUserTags_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ModifyUserTagsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/parse-license-file": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Parses an uploaded cloud license file.", - "operationId": "parseLicenseFile_6", - "parameters": [ - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProvidedLicenseResponse" - } - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Updates the NetApp Console password for a specific Cloud Volumes ONTAP system.", - "operationId": "updatePassword_7", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateCredentialsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/change-tier-level": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Updates the tier level.", - "operationId": "changeTierLevel_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeTierLevelRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/enable-worm": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Enables SnapLock for an existing Cloud Volumes ONTAP system.", - "operationId": "enableWorm_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WormRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Updates a bring-your-own-license (BYOL) license to a capacity-based license for an existing Cloud Volumes ONTAP system.", - "operationId": "byolToCapacity_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseConversionRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RegisterCvoResponse" - } - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/ntp": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Sets up an NTP server.", - "operationId": "setupNtpServer_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NTPConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/start": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Starts a specific Cloud Volumes ONTAP instance.", - "operationId": "startVsa_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/stop": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Stops a specific Cloud Volumes ONTAP instance.", - "operationId": "stopVsa_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "takeSnapshots", - "in": "query", - "schema": { - "type": "boolean", - "default": true - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/support-registration": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Retrieves the support registration status of a Cloud Volumes ONTAP system.", - "operationId": "status_7", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportRegistrationResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Registers a Cloud Volumes ONTAP system with NetApp.", - "operationId": "registerSupport_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "nssAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportRegistrationResponse" - } - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/schedules": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Lists the start/stop schedules for Cloud Volumes ONTAP.", - "operationId": "getSchedules_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaSchedule" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Sets schedules for Cloud Volumes ONTAP.", - "operationId": "setSchedules_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaSchedulesRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/svm": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Modifies the SVM name of the Cloud Volumes ONTAP system.", - "operationId": "changeSvmName_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SvmNameModificationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Activates the FPolicy for ransomware files.", - "operationId": "activateFpolicy_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Disables the FPolicy for ransomware files.", - "operationId": "disableFpolicy_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/fpolicy": { - "delete": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Deletes the FPolicy for ransomware files.", - "operationId": "deleteFpolicy_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Activates snapshot policy assignment for all unprotected read/write volumes.", - "operationId": "activateSnapshotPolicy_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/snapshot-policy": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Creates a snapshot policy.", - "operationId": "createSnapshotPolicy_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotPolicyCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/change-serial": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Updates the serial number of a Cloud Volumes ONTAP system.", - "operationId": "changeSerialNumber_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeSerialNumberRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments/{workingEnvironmentId}/set-password": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Sets the cluster password for a specific Cloud Volumes ONTAP system.", - "operationId": "setPassword_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "occmOnly", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordWrapper" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Retrieves Cloud Volumes ONTAP systems visible to the current user.", - "operationId": "workingEnvironments_3", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "tenantId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Creates a new AWS HA Cloud Volumes ONTAP system.", - "operationId": "createAwsHaWorkingEnvironment", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateAwsHaWorkingEnvironmentRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/route-tables": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Updates the route tables of an HA Cloud Volumes ONTAP system.", - "operationId": "updateRouteTables", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateRouteTablesRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Checks for non-persistent locks held on CIFS sessions.", - "operationId": "cifsLocksExist_2", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/update-mediator": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Updates the mediator of the specified Cloud Volumes ONTAP system with the provided version.", - "operationId": "updateMediator", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Retrieves an HA Cloud Volumes ONTAP system.", - "operationId": "workingEnvironment_3", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaWorkingEnvironmentResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Deletes an existing Cloud Volumes ONTAP system, including all cloud resources created for the system (unless the localDelete flag is set to true).", - "operationId": "deleteVsaWorkingEnvironment_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "localDelete", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "forceDelete", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/delete-cifs": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Deletes the CIFS configuration of an existing Cloud Volumes ONTAP system.", - "operationId": "setupCifsConfiguration_7", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CIFSDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Retrieves the CIFS configuration for an existing Cloud Volumes ONTAP system.", - "operationId": "cifsConfiguration_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svm", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CIFSConfigurationResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Sets up a new CIFS configuration for an existing Cloud Volumes ONTAP system.", - "operationId": "setupCifsConfiguration_8", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CIFSConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Validates the prerequisites for converting an existing Cloud Volumes ONTAP system.", - "operationId": "preValidateByolToCapacity_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreValidationResponse" - } - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/writing-speed": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Sets the writing speed for Cloud Volumes ONTAP.", - "operationId": "modifyWritingSpeed_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WritingSpeedRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/license-instance-type": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Retrieves all license types and their associated instance types for a specific Cloud Volumes ONTAP instance.", - "operationId": "licenseAndInstanceTypes_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseAndInstanceType" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Sets the instance type of a specific Cloud Volumes ONTAP system.", - "operationId": "changeLicenseAndInstanceType_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseAndInstanceTypeModificationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/ontap-available-images": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Retrieves images already installed on the Cloud Volumes ONTAP system.", - "operationId": "ontapAvailableImages_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/UpdateLocalImage" - } - } - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/update-image": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP system.", - "operationId": "updateSystemImage_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateSystemImageRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/update-eligibility": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Retrieves the eligibility support status of a Cloud Volumes ONTAP system. Valid values are NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED.", - "operationId": "occmUpgradeEligibilityChecks_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EligibilityResponse" - } - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/upload-license-file": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Uploads a cloud license file on the specified Cloud Volumes ONTAP system.", - "operationId": "uploadLicenseFile_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Retrieves a list of versions to which this Cloud Volumes ONTAP system can be upgraded.", - "operationId": "occmProvidedCloudOntapUpgradeVersions_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OntapUpdateImageMetadata" - } - } - } - } - } - } - } - }, - "/aws/ha/working-environments/sync-subscription": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Manually triggers subscription synchronization for all Cloud Volumes ONTAP systems.", - "operationId": "syncVsaWorkingEnvironmentsSubscription_3", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/upload-licenses": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Uploads the content of a cloud license file on the specified Cloud Volumes ONTAP system.", - "operationId": "uploadLicenseFileContent_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseFileContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/offbox": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Activates an off-box configuration.", - "operationId": "activateOntapConfiguration_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/networkOptimization": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Modifies the network port broadcast domain MTU of the Cloud Volumes ONTAP system.", - "operationId": "changeNetworkOptimizationLevel_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeNetworkOptimizationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/create-request-parameters": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Retrieves the action parameters used in the create request for a specific Cloud Volumes ONTAP instance.", - "operationId": "createRequestParameters_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateRequestParametersResponse" - } - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Enables capacity tiering.", - "operationId": "enableCapacityTiering_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EnableCapacityTieringRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/cost-and-usage": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Retrieves the system cost and usage.", - "operationId": "workingEnvironmentCostAndUsage_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "start", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "end", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkingEnvironmentCostAndUsageResponse" - } - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/ontap-saving": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Retrieves system ONTAP savings.", - "operationId": "workingEnvironmentOntapSaving_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkingEnvironmentOntapSavingResponse" - } - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Retrieves extra capacity licenses for Cloud Volumes ONTAP.", - "operationId": "getExtraCapacityLicenses_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GetLicenseResponse" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": " Updates an extra capacity license.", - "operationId": "updateExtraCapacityLicenses_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Registers an extra capacity license.", - "operationId": "uploadExtraCapacityLicenses_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": " Updates an extra capacity license serial number.", - "operationId": "updateExtraCapacitySerials_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Registers an extra capacity serial number.", - "operationId": "uploadExtraCapacitySerials_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Deletes extra capacity licenses by serial numbers.", - "operationId": "deleteExtraCapacityLicenses_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/vscan-file-op": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Updates the default Vscan file operation profile. Profiles on existing CIFS shares will change only on writes-only mode.", - "operationId": "updateVscanFileOperation_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VscanFileOpRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/user-tags": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Retrieves the editable tags for the cloud resources in a specific Cloud Volumes ONTAP instance.", - "operationId": "userTags_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserTagsResponse" - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Modifies the user tags for cloud resources in a specific Cloud Volumes ONTAP instance.", - "operationId": "modifyUserTags_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ModifyUserTagsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/parse-license-file": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Parses an uploaded cloud license file.", - "operationId": "parseLicenseFile_3", - "parameters": [ - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProvidedLicenseResponse" - } - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Updates the NetApp Console password for a specific Cloud Volumes ONTAP system.", - "operationId": "updatePassword_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateCredentialsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/change-tier-level": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Updates the tier level.", - "operationId": "changeTierLevel_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeTierLevelRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/enable-worm": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Enables SnapLock for an existing Cloud Volumes ONTAP system.", - "operationId": "enableWorm_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WormRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/byol-to-capacity": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Updates a bring-your-own-license (BYOL) license to a capacity-based license for an existing Cloud Volumes ONTAP system.", - "operationId": "byolToCapacity_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseConversionRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RegisterCvoResponse" - } - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/ntp": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Sets up an NTP server.", - "operationId": "setupNtpServer_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NTPConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/start": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Starts a specific Cloud Volumes ONTAP instance.", - "operationId": "startVsa_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/stop": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Stops a specific Cloud Volumes ONTAP instance.", - "operationId": "stopVsa_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "takeSnapshots", - "in": "query", - "schema": { - "type": "boolean", - "default": true - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/support-registration": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Retrieves the support registration status of a Cloud Volumes ONTAP system.", - "operationId": "status_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportRegistrationResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Registers a Cloud Volumes ONTAP system with NetApp.", - "operationId": "registerSupport_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "nssAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportRegistrationResponse" - } - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/schedules": { - "get": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Lists the start/stop schedules for Cloud Volumes ONTAP.", - "operationId": "getSchedules_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaSchedule" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Sets schedules for Cloud Volumes ONTAP.", - "operationId": "setSchedules_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaSchedulesRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/svm": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Modifies the SVM name of the Cloud Volumes ONTAP system.", - "operationId": "changeSvmName_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SvmNameModificationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/activate-fpolicy": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Activates the FPolicy for ransomware files.", - "operationId": "activateFpolicy_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/disable-fpolicy": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Disables the FPolicy for ransomware files.", - "operationId": "disableFpolicy_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/fpolicy": { - "delete": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Deletes the FPolicy for ransomware files.", - "operationId": "deleteFpolicy_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Activates snapshot policy assignment for all unprotected read/write volumes.", - "operationId": "activateSnapshotPolicy_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/snapshot-policy": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Creates a snapshot policy.", - "operationId": "createSnapshotPolicy_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotPolicyCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/change-serial": { - "post": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Updates the serial number of a Cloud Volumes ONTAP system.", - "operationId": "changeSerialNumber_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeSerialNumberRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/aws/ha/working-environments/{workingEnvironmentId}/set-password": { - "put": { - "tags": [ - "ONTAP Cloud AWS HA system operations - Systems" - ], - "description": "Sets the cluster password for a specific Cloud Volumes ONTAP system.", - "operationId": "setPassword_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "occmOnly", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordWrapper" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/key-store": { - "post": { - "tags": [ - "Cloud Manager system operations - Encryption - Key store operations" - ], - "description": "Generates a new key pair and self-signed certificate at the key store and returns a certificate signing request (CSR). ", - "operationId": "generateKeysAndCertificateRequest", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateSigningRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CsrResponse" - } - } - } - } - } - } - }, - "/occm/key-store/external-certificate-file": { - "post": { - "tags": [ - "Cloud Manager system operations - Encryption - Key store operations" - ], - "description": "Generates a new key pair and self-signed certificate at the key store and returns a certificate signing request (CSR).", - "operationId": "installExternalSignedCertificateFile", - "parameters": [ - { - "name": "certificateFilename", - "in": "header", - "schema": { - "type": "string" - } - }, - { - "name": "privateKeyFilename", - "in": "header", - "schema": { - "type": "string" - } - }, - { - "name": "algorithm", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - } - }, - "/occm/key-store/signed-certificate-file": { - "post": { - "tags": [ - "Cloud Manager system operations - Encryption - Key store operations" - ], - "description": "Validates and installs the provided root certificate authority (CA) chain. Successive calls will overwrite any previously installed root certificate authority (CA) chain.", - "operationId": "installSignedCertificateFile", - "parameters": [ - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - } - }, - "/occm/key-store/external-certificate": { - "post": { - "tags": [ - "Cloud Manager system operations - Encryption - Key store operations" - ], - "description": "Generates a new key pair and self-signed certificate at the key store and returns a certificate signing request (CSR). ", - "operationId": "installExternalSignedCertificate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InstallCertificatesAndPrivateKeyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - } - }, - "/occm/key-store/trusted-certificate-file": { - "post": { - "tags": [ - "Cloud Manager system operations - Encryption - Key store operations" - ], - "description": "Validates and installs the provided certificate in the trust store.", - "operationId": "installTrustedCertificateFile", - "parameters": [ - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - } - } - }, - "/occm/key-store/signed-certificate": { - "get": { - "tags": [ - "Cloud Manager system operations - Encryption - Key store operations" - ], - "description": "Retrieves the certificate authority (CA) signed certificate of the NetApp Console key store, if one exists.", - "operationId": "signedCertificate", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "Cloud Manager system operations - Encryption - Key store operations" - ], - "description": "Validates and installs the provided root certificate authority (CA) chain. Successive calls will overwrite any previously installed root certificate authority (CA) chain.", - "operationId": "installSignedCertificate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InstallCertificatesRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - } - }, - "/occm/key-store/self-certificate": { - "get": { - "tags": [ - "Cloud Manager system operations - Encryption - Key store operations" - ], - "description": "Retrieves the self-signed certificate of NetApp Console key store, if one exists.", - "operationId": "selfCertificate", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - } - }, - "/occm/key-store/user-trusted-certificates": { - "get": { - "tags": [ - "Cloud Manager system operations - Encryption - Key store operations" - ], - "description": "Returns the existing trusted certificates added by the user from the trust store.", - "operationId": "userTrustedCertificates", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/TrustedCertificateResponse" - } - } - } - } - } - } - } - }, - "/occm/key-store/trusted-certificate/{certificateId}": { - "delete": { - "tags": [ - "Cloud Manager system operations - Encryption - Key store operations" - ], - "description": "Deletes an existing trusted certificate from the trust store.", - "operationId": "deleteTrustedCertificate", - "parameters": [ - { - "name": "certificateId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/monitoring/deploy-by-working-environments": { - "post": { - "tags": [ - "Monitoring Operations" - ], - "description": "Deploys a monitoring instance by systems.", - "operationId": "deployMonitoringInstance", - "requestBody": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/EnableMonitoringRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/monitoring/info": { - "get": { - "tags": [ - "Monitoring Operations" - ], - "description": "Retrieves monitoring information.", - "operationId": "getMonitoringInfo", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MonitoringInfoResponse" - } - } - } - } - } - } - }, - "/monitoring/{workingEnvironmentId}/disable-monitoring": { - "post": { - "tags": [ - "Monitoring Operations" - ], - "description": "Disables monitoring.", - "operationId": "disableMonitoring", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/monitoring/{workingEnvironmentId}/enable-monitoring": { - "post": { - "tags": [ - "Monitoring Operations" - ], - "description": "Enables monitoring.", - "operationId": "enableMonitoring", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/asup/download-signed": { - "get": { - "tags": [ - "Cloud Manager system operations - ASUP" - ], - "description": "Retrieves the signed URL for NetApp Console support data.", - "operationId": "downloadSignedAsupFile", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/occm/asup": { - "get": { - "tags": [ - "Cloud Manager system operations - ASUP" - ], - "description": "Retrieves the AutoSupport configuration.", - "operationId": "asupConfiguration", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AsupConfiguration" - } - } - } - } - } - }, - "put": { - "tags": [ - "Cloud Manager system operations - ASUP" - ], - "description": "Updates the AutoSupport configuration.", - "operationId": "saveAsupConfiguration", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AsupConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/asup/download-ontap-cloud-asups": { - "get": { - "tags": [ - "Cloud Manager system operations - ASUP" - ], - "description": "Downloads a compressed file of all AutoSupport files from all VSAs.", - "operationId": "downloadOntapCloudAsups", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/asup/send-Cot-performance-Asup/{workingEnvironmentId}": { - "post": { - "tags": [ - "Cloud Manager system operations - ASUP" - ], - "description": "Sends Cloud Volumes ONTAP performance archive support data to NetApp Support.", - "operationId": "sendOntapCloudPerformanceAsup", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/asup/download": { - "get": { - "tags": [ - "Cloud Manager system operations - ASUP" - ], - "description": "Downloads NetApp Console support data.", - "operationId": "downloadAsupFile", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/asup/send": { - "post": { - "tags": [ - "Cloud Manager system operations - ASUP" - ], - "description": "Sends NetApp Console support data to NetApp Support.", - "operationId": "sendAsup", - "parameters": [ - { - "name": "serial", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/asup/send-Cot-Asup": { - "post": { - "tags": [ - "Cloud Manager system operations - ASUP" - ], - "description": "Sends Cloud Volumes ONTAP support data to NetApp Support.", - "operationId": "sendOntapCloudAsup", - "parameters": [ - { - "name": "sendToOccm", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/config": { - "get": { - "tags": [ - "Cloud Manager system operations - Configuration" - ], - "description": "Retrieves NetApp Console configuration parameters.", - "operationId": "config", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConfigValuesResponse" - } - } - } - } - } - }, - "put": { - "tags": [ - "Cloud Manager system operations - Configuration" - ], - "description": "Configures modifiable NetApp Console parameters.", - "operationId": "updateConfig", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConfigValuesUpdateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConfigValuesResponse" - } - } - } - } - } - } - }, - "/occm/system/available-update-versions": { - "get": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Checks for a new version of the NetApp Console.", - "operationId": "listAvailableUpdates", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/UpdateInfo" - } - } - } - } - } - } - } - }, - "/occm/system/cloud-ontap-update-image-metadata": { - "post": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Retrieves and processes Cloud Volumes ONTAP image update metadata files.", - "operationId": "updateImageCloudOntapMetadata", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/system/cloud-ontap-update-metadata": { - "post": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Performs fetch and cache of Cloud Volumes ONTAP and NetApp Console version information files from S3.", - "operationId": "updateCloudOntapMetadata", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/system/cloud-provider-regions": { - "get": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Retrieves the supported regions for cloud providers.", - "operationId": "CloudProviderRegions", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProviderSupportedRegions" - } - } - } - } - } - } - }, - "/occm/system/manually-activate-auto-vsa-capacity-management-cycle": { - "post": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Activates the Cloud Volumes ONTAP capacity automatic management cycle manually.", - "operationId": "manuallyActivateAutoVsaCapacityManagementCycle", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/system/manually-trigger-send-daily-notification": { - "post": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Triggers daily notification sending manually.", - "operationId": "manuallyTriggerSendDailyNotification", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/system/update": { - "post": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Updates the NetApp Console to the specified version.", - "operationId": "updateVersion", - "requestBody": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/VersionWrapper" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/system/restart-server": { - "post": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Restarts the server.", - "operationId": "restartServer", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/system/feature-flags": { - "get": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Retrieves feature flags.", - "operationId": "featureFlags", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeatureFlag" - } - } - } - } - } - } - }, - "/occm/system/external-config": { - "get": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Retrieves NetApp Console feedback configuration.", - "operationId": "occmConfig", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OccmExternalConfiguration" - } - } - } - } - } - } - }, - "/occm/system/about": { - "get": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Retrieves NetApp Console server information.", - "operationId": "getAbout", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/About" - } - } - } - } - } - } - }, - "/occm/system/support-services": { - "get": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Retrieves NetApp Console support services information.", - "operationId": "supportServices", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportServices" - } - } - } - } - } - } - }, - "/occm/system/patch": { - "post": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Updates the NetApp Console with the specified patch version. Backups should be provided in multipart/form-data, with the file at a part named 'patch'.", - "operationId": "patch", - "parameters": [ - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/system/occm-instance-placement": { - "get": { - "tags": [ - "Cloud Manager system operations - System" - ], - "description": "Retrieves the region, VPC, and subnet in which the NetApp Console instance is running.", - "operationId": "instancePlacement", - "parameters": [ - { - "name": "clearCache", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InstancePlacementResponse" - } - } - } - } - } - } - }, - "/occm/tenancy-service/workspaces/{workspaceId}/associate": { - "post": { - "tags": [ - "Cloud Manager system operations - Tenancy service" - ], - "description": "Associates a a console agent with a workspace.", - "operationId": "associateToWorkspace", - "parameters": [ - { - "name": "workspaceId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/tenancy-service/users/update-current-user": { - "put": { - "tags": [ - "Cloud Manager system operations - Tenancy service" - ], - "description": "Updates the current NetApp Console service user.", - "operationId": "updateCurrentServiceUser", - "requestBody": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/UpdateServiceUser" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/tenancy-service/workspaces": { - "get": { - "tags": [ - "Cloud Manager system operations - Tenancy service" - ], - "description": "Retrieves workspaces that are visible to the current user.", - "operationId": "workspaces", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/WorkspaceResponse" - } - } - } - } - } - } - } - }, - "/onprem/aggregates": { - "get": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Aggregates" - ], - "description": "Retrieves aggregates.", - "operationId": "list", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "checkTieringRestrictions", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OnPremAggregateResponse" - } - } - } - } - } - } - } - }, - "/onprem/metadata/cluster-info": { - "get": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Metadata" - ], - "description": "Verifies the address and credentials of the specified cluster by retrieving the cluster information.", - "operationId": "clusterInfo", - "parameters": [ - { - "name": "clusterAddress", - "in": "header", - "schema": { - "type": "string" - } - }, - { - "name": "clusterUsername", - "in": "header", - "schema": { - "type": "string" - } - }, - { - "name": "clusterPassword", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClusterInfoResponse" - } - } - } - } - } - } - }, - "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Modifies an existing volume.", - "operationId": "modifyVolume_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OnPremVolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Deletes an existing volume.", - "operationId": "deleteVolume_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/onprem/volumes/volumes-for-backup": { - "get": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Retrieves all volumes for backup activation.", - "operationId": "volumesForBackup_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "offset", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "limit", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "search", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filterBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListFilterByParam" - } - }, - { - "name": "sortBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListSortByParam" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumesListForBackup" - } - } - } - } - } - } - }, - "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Returns a list of snapshot descriptions for the volume.", - "operationId": "volumeSnapshots_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotResponse" - } - } - } - } - } - } - } - }, - "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Clones an existing volume.", - "operationId": "cloneVolume_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeCloneRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Creates a snapshot manually.", - "operationId": "createSnapshot_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Deletes a snapshot manually.", - "operationId": "deleteSnapshot_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/onprem/volumes": { - "get": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Retrieves all volumes.", - "operationId": "volumes_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "withMinimumCoolingDays", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Volumes" - ], - "description": "Creates a new volume.", - "operationId": "createVolume_6", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OnPremVolumeCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/azure-cloud-backup-setup": { - "post": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Systems" - ], - "description": "Sets up Azure backup to cloud on an on-premises system.", - "operationId": "azureCloudBackupSetup", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureCloudBackupSetupRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/aws-cloud-backup-setup": { - "post": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Systems" - ], - "description": "Sets up AWS backup to cloud on an on-premises system.", - "operationId": "awsCloudBackupSetup", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AwsCloudBackupSetupRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/gcp-cloud-backup-setup": { - "post": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Systems" - ], - "description": "Sets up Google Cloud backup to cloud on an on-premises system.", - "operationId": "gcpCloudBackupSetup", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpCloudBackupSetupRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/sgws-cloud-backup-setup": { - "post": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Systems" - ], - "description": "Sets up StorageGRID backup to cloud on an on-premises system.", - "operationId": "sgwsCloudBackupSetup", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SgwsCloudBackupSetupRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Systems" - ], - "description": "Retrieves CIFS configuration for an existing Cloud Volumes ONTAP system.", - "operationId": "cifsConfiguration_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "vserver", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CIFSConfigurationResponse" - } - } - } - } - } - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}": { - "get": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Systems" - ], - "description": "Retrieves an on-premises ONTAP system.", - "operationId": "workingEnvironment_4", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OnPremWorkingEnvironmentResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Systems" - ], - "description": "Removes an on-premises ONTAP system from the NetApp Console. The Console will no longer manage the system, but ONTAP is not affected.", - "operationId": "removeOnPrem", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Systems" - ], - "description": "Updates the NetApp Console password for an on-premises system.", - "operationId": "updatePassword_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateCredentialsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/onprem/working-environments/{workingEnvironmentId}/ip-spaces": { - "get": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Systems" - ], - "description": "Retrieves an IPspace list for an existing Cloud Volumes ONTAP system.", - "operationId": "IpSpaces", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "vserver", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/IpSpaceResponse" - } - } - } - } - } - } - } - }, - "/onprem/working-environments": { - "get": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Systems" - ], - "description": "Retrieves on-premises systems visible to the current user.", - "operationId": "workingEnvironments_4", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "tenantId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OnPremWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "On-premises (Data ONTAP cluster) system operations - Systems" - ], - "description": "Discovers an on-premises system in the NetApp Console.", - "operationId": "discoverOnPrem", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OnPremWorkingEnvironmentDiscoverRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OnPremWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "/replication/metadata/snapmirror-svm-policies/{sourceWorkingEnvironmentId}/{svmName}/{targetWorkingEnvironmentId}": { - "get": { - "tags": [ - "Replication operations - Metadata" - ], - "description": "Retrieves SnapMirror policies based on the source and destination Cloud Volumes ONTAP systems.", - "operationId": "describeSnapmirrorPolicies", - "parameters": [ - { - "name": "sourceWorkingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "targetWorkingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapMirrorPolicyResponse" - } - } - } - } - } - } - } - }, - "/replication/metadata/snapmirror-policies/{sourceWorkingEnvironmentId}/{targetWorkingEnvironmentId}": { - "get": { - "tags": [ - "Replication operations - Metadata" - ], - "description": "Retrieves SnapMirror policies based on the source and destination Cloud Volumes ONTAP systems.", - "operationId": "describeSnapmirrorPolicies_1", - "parameters": [ - { - "name": "sourceWorkingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "targetWorkingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapMirrorPolicyResponse" - } - } - } - } - } - } - } - }, - "/replication/metadata/snapshot-labels/{workingEnvironmentId}/{svmName}/{volumeName}": { - "get": { - "tags": [ - "Replication operations - Metadata" - ], - "description": "Returns a list of snapshot labels from the volume that match labels in the provided list.", - "operationId": "snapshotsLabelFlags", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "labels", - "in": "query", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "/replication/resync/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "post": { - "tags": [ - "Replication operations" - ], - "description": "Resyncs a SnapMirror replication relationship.", - "operationId": "resyncReplication", - "parameters": [ - { - "name": "destinationWorkingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationSvmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationVolumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/replication/update/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "post": { - "tags": [ - "Replication operations" - ], - "description": "Updates the destination endpoint of the SnapMirror relationship.", - "operationId": "uptodateReplication", - "parameters": [ - { - "name": "destinationWorkingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationSvmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationVolumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/replication/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "delete": { - "tags": [ - "Replication operations" - ], - "description": "Removes a replication relationship.", - "operationId": "deleteReplication", - "parameters": [ - { - "name": "destinationWorkingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationSvmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationVolumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/replication/fsx": { - "post": { - "tags": [ - "Replication operations" - ], - "description": "Creates a new replication to an FSx system.", - "operationId": "createReplicationFsx", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateReplicationRequestToFsx" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/replication/onprem": { - "post": { - "tags": [ - "Replication operations" - ], - "description": "Creates a new replication to an on-premises system.", - "operationId": "createReplicationOnPrem", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateReplicationRequestToOnPrem" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/replication/vsa": { - "post": { - "tags": [ - "Replication operations" - ], - "description": "Creates a new replication to a Cloud Volumes ONTAP system.", - "operationId": "createReplicationVsa", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateReplicationRequestToVsa" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/replication/initialize/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "post": { - "tags": [ - "Replication operations" - ], - "description": "Initializes an existing SnapMirror relationship. This method can only be performed when the relationship has already been established and is healthy, idle, and uninitialized. For example, if the initial transfer were interrupted, it can be restarted with this request.", - "operationId": "initializeReplication", - "parameters": [ - { - "name": "destinationWorkingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationSvmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationVolumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/replication/reverse/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "post": { - "tags": [ - "Replication operations" - ], - "description": "Reverses an existing SnapMirror relationship. This method can only be performed when the relationship has already been established and is healthy and idle.", - "operationId": "reverseResyncReplication", - "parameters": [ - { - "name": "destinationWorkingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationSvmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationVolumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SourceSnapmirrorEndpoint" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/replication/{workingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "put": { - "tags": [ - "Replication operations" - ], - "description": "Updates a SnapMirror replication relationship.", - "operationId": "updateReplication", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationSvmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationVolumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReplicationUpdateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/replication/schedules/{workingEnvironmentId}": { - "get": { - "tags": [ - "Replication operations" - ], - "description": "Retrieves the replication schedules of a specific system.", - "operationId": "schedules", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ReplicationSchedule" - } - } - } - } - } - } - } - }, - "/replication/intercluster-lifs": { - "get": { - "tags": [ - "Replication operations" - ], - "description": "Retrieves the intercluster LIFs used in a cluster peering relationship.", - "operationId": "interClusterLifs", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "peerWorkingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReplicationInterClusterLifs" - } - } - } - } - } - } - }, - "/replication/break/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}": { - "post": { - "tags": [ - "Replication operations" - ], - "description": "Breaks a SnapMirror replication relationship.", - "operationId": "breakReplication", - "parameters": [ - { - "name": "destinationWorkingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationSvmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "destinationVolumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/replication/all-relationships": { - "get": { - "tags": [ - "Replication operations" - ], - "description": "Returns pairs of relationships.", - "operationId": "allRelationShips", - "parameters": [ - { - "name": "workspaceId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AllRelationships" - } - } - } - } - } - } - }, - "/replication/status": { - "get": { - "tags": [ - "Replication operations" - ], - "description": "Retrieves the status of all SnapMirror relationships.", - "operationId": "statuses", - "parameters": [ - { - "name": "tenantId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ReplicationStatusResponse" - } - } - } - } - } - } - } - }, - "/replication/status/{workingEnvironmentId}": { - "get": { - "tags": [ - "Replication operations" - ], - "description": "Retrieves the SnapMirror replication relationship status of a specific system.", - "operationId": "status_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ReplicationStatusResponse" - } - } - } - } - } - } - } - }, - "/occm/saas-mp-service/attach-subscription/{provider}/{cloudAccountId}": { - "put": { - "tags": [ - "Cloud Manager system operations - SaaS MP service" - ], - "description": "Attaches a SaaS subscription to a cloud provider account.", - "operationId": "AttachSubscriptionToCloudAccount", - "parameters": [ - { - "name": "cloudAccountId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "provider", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/UpdateSubscriptionRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/saas-mp-service/{workingEnvironmentId}/subscription": { - "get": { - "tags": [ - "Cloud Manager system operations - SaaS MP service" - ], - "description": "Retrieves the SaaS marketplace subscriptions for Cloud Volumes ONTAP.", - "operationId": "describeCvoSubscription", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DescribeCvoSubscriptionResponse" - } - } - } - } - } - } - }, - "/occm/saas-mp-service/account": { - "get": { - "tags": [ - "Cloud Manager system operations - SaaS MP service" - ], - "description": "Retrieves the current SaaS marketplace account and subscriptions.", - "operationId": "account", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SaasMpAccountResponse" - } - } - } - } - } - } - }, - "/occm/setup/validate/proxy": { - "post": { - "tags": [ - "Cloud Manager system operations - Initial Setup" - ], - "description": "Validates the specified proxy URL.", - "operationId": "validateProxy", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProxyUri" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/setup/validate/connectivity": { - "post": { - "tags": [ - "Cloud Manager system operations - Initial Setup" - ], - "description": "Validates that the NetApp Console has an active internet connection.", - "operationId": "validateConnectivity", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/setup-portal/init": { - "post": { - "tags": [ - "Cloud Manager system operations - Initial Setup operations using NetApp Cloud Central" - ], - "description": "Performs initial setup with NetApp Cloud Central.", - "operationId": "initialSetupWithPortal", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PortalSetupAsServiceConnectorRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InitialSetupResponse" - } - } - } - } - } - } - }, - "/occm/setup-portal/init-standalone-local-auth": { - "post": { - "tags": [ - "Cloud Manager system operations - Initial Setup operations using NetApp Cloud Central" - ], - "description": "Performs initial standalone setup with a local identity provider.", - "operationId": "initialStandaloneSetupWithLocalAuth", - "parameters": [ - { - "name": "Authorization", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LocalAuthSetupRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InitialSetupResponse" - } - } - } - } - } - } - }, - "/occm/setup-portal/register-in-local-auth": { - "post": { - "tags": [ - "Cloud Manager system operations - Initial Setup operations using NetApp Cloud Central" - ], - "description": "Registers NetApp Console in a dark site.", - "operationId": "darkSiteRegistration", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RegistrationResponse" - } - } - } - } - } - } - }, - "/occm/setup-portal/complete-connectivity-pending-setup": { - "post": { - "tags": [ - "Cloud Manager system operations - Initial Setup operations using NetApp Cloud Central" - ], - "description": "Completes the setup that is pending connectivity.", - "operationId": "completeConnectivityPendingSetup", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InitialSetupResponse" - } - } - } - } - } - } - }, - "/occm/setup-portal/register": { - "post": { - "tags": [ - "Cloud Manager system operations - Initial Setup operations using NetApp Cloud Central" - ], - "description": "Registers the NetApp Console to NetApp Cloud Central.", - "operationId": "portalRegistration", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RegistrationResponse" - } - } - } - } - } - } - }, - "/occm/setup-portal/proxy/setup": { - "post": { - "tags": [ - "Cloud Manager system operations - Initial Setup operations using NetApp Cloud Central" - ], - "description": "Sets up a specified proxy URL.", - "operationId": "setProxy", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetProxyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/occm/setup-portal/validate/connectivity": { - "post": { - "tags": [ - "Cloud Manager system operations - Initial Setup operations using NetApp Cloud Central" - ], - "description": "Validates that the NetApp Console has an active internet connection.", - "operationId": "validateConnectivity_1", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/tenants/{tenantId}": { - "get": { - "tags": [ - "Tenant operations" - ], - "description": "Retrieves a tenant.", - "operationId": "tenantById", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "tenantId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantResponse" - } - } - } - } - } - }, - "put": { - "tags": [ - "Tenant operations" - ], - "description": "Updates an existing tenant.", - "operationId": "updateTenant", - "parameters": [ - { - "name": "tenantId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateTenantRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "Tenant operations" - ], - "description": "Deletes an existing tenant. It is not possible to delete a tenant over which systems exist.", - "operationId": "deleteTenant", - "parameters": [ - { - "name": "tenantId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/tenants/{tenantId}/nss-keys": { - "put": { - "tags": [ - "Tenant operations" - ], - "description": "Links an existing tenant to a NetApp Support Site account.", - "operationId": "setTenantNssKeys", - "parameters": [ - { - "name": "tenantId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetNssKeysRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantResponse" - } - } - } - } - } - } - }, - "/tenants": { - "get": { - "tags": [ - "Tenant operations" - ], - "description": "Retrieves tenants that are visible to the current user.", - "operationId": "list_1", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/TenantResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "Tenant operations" - ], - "description": "Creates a new tenant.", - "operationId": "addTenant", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddTenantRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantResponse" - } - } - } - } - } - } - }, - "/users/{userId}": { - "get": { - "tags": [ - "User management operations - Users" - ], - "description": "Retrieves a specific user.", - "operationId": "userById", - "parameters": [ - { - "name": "userId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserResponse" - } - } - } - } - } - }, - "put": { - "tags": [ - "User management operations - Users" - ], - "description": "Updates an existing user.", - "operationId": "updateUser", - "parameters": [ - { - "name": "userId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateUserRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "User management operations - Users" - ], - "description": "Deletes an existing user. It is not possible to delete a user that has created existing systems. It is not possible to delete the logged in user.", - "operationId": "deleteUser", - "parameters": [ - { - "name": "userId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/users/{userId}/working-environments-grant-revoke": { - "post": { - "tags": [ - "User management operations - Users" - ], - "description": "Grants or revokes permissions to the specified user for performing operations over the specified systems.", - "operationId": "grantPermission", - "parameters": [ - { - "name": "userId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GrantPermission" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/users/{userId}/reset-password": { - "put": { - "tags": [ - "User management operations - Users" - ], - "description": "Resets the password for the specified user.", - "operationId": "resetPassword", - "parameters": [ - { - "name": "userId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResetUserPasswordRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/users/add-user": { - "post": { - "tags": [ - "User management operations - Users" - ], - "description": "Adds an existing NetApp Cloud Central user to the NetApp Console.", - "operationId": "addUser", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddPortalUserRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserResponse" - } - } - } - } - } - } - }, - "/users/{userId}/remove-user": { - "delete": { - "tags": [ - "User management operations - Users" - ], - "description": "Removes a user from the NetApp Console.", - "operationId": "removeUser", - "parameters": [ - { - "name": "userId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/users": { - "get": { - "tags": [ - "User management operations - Users" - ], - "description": "Retrieves all users visible to the current user.", - "operationId": "list_2", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/UserResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "User management operations - Users" - ], - "description": "Creates a new user.", - "operationId": "createUser", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserResponse" - } - } - } - } - } - } - }, - "/azure/vsa/recover": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Discovery" - ], - "description": "Saves a previously discovered Cloud Volumes ONTAP system to the NetApp Console database.", - "operationId": "discoverAzure_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecoverAzureVSARequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureVsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "/azure/vsa/discover": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Discovery" - ], - "description": "Retrieves a list of discovered systems visible to the current user in the specified Azure region.", - "operationId": "discover_4", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DiscoveredAzureVSAResponse" - } - } - } - } - } - } - } - }, - "/azure/vsa/metadata/network-requirements": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves the minimum number of required IP addresses for a Cloud Volumes ONTAP system.", - "operationId": "networkRequirements_4", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureNetworkRequirementsResponse" - } - } - } - } - } - } - }, - "/azure/vsa/metadata/validate-subscribed-to-ontap-cloud": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Validates that the current user is subscribed to the Cloud Volumes ONTAP product in the Azure marketplace.", - "operationId": "validateSubscribedToOntapCloud_2", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureValidateSubscribedToOntapCloudRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureValidateSubscribedToOntapCloudResponse" - } - } - } - } - } - } - }, - "/azure/vsa/metadata/associated-subscriptions": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves associated subscriptions.", - "operationId": "associatedSubscriptions_1", - "parameters": [ - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AssociatedSubscription" - } - } - } - } - } - } - } - }, - "/azure/vsa/metadata/supported-capacity-tiers": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves the supported capacity tiers for Azure disk types.", - "operationId": "supportedCapacityTiers_4", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ontapVersion", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "dataEncryptionType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "licenseType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "instanceType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportedCapacityTiers" - } - } - } - } - } - } - }, - "/azure/vsa/metadata/create-container": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Creates a new blob container.", - "operationId": "createBlobContainer_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateBlobContainerRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/metadata/availability-zones": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves Azure availability zones by region.", - "operationId": "availabilityZones_1", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureAvailabilityZoneResponse" - } - } - } - } - } - } - }, - "/azure/vsa/metadata/vnets": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves network extended information.", - "operationId": "vpcs_2", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureNetworkExtendedResponse" - } - } - } - } - } - } - }, - "/azure/vsa/metadata/vaults": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves all vaults.", - "operationId": "listVaults_1", - "parameters": [ - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureKeyVault" - } - } - } - } - } - } - } - }, - "/azure/vsa/metadata/keys-vault": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves all keys in a vault.", - "operationId": "listKeysInVault_1", - "parameters": [ - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "resourceGroupName", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "vaultName", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureKey" - } - } - } - } - } - } - } - }, - "/azure/vsa/metadata/resource-groups": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves Azure resource groups by region.", - "operationId": "resourceGroups_1", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureResourceGroupByRegionResponse" - } - } - } - } - } - } - } - }, - "/azure/vsa/metadata/storage-account-types": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves supported Azure storage account types.", - "operationId": "disks_4", - "parameters": [ - { - "name": "isMultiZone", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "isFlashcacheInstance", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "isManagedDiskSupported", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureStorageAccountTypeResponse" - } - } - } - } - } - } - } - }, - "/azure/vsa/metadata/tag-keys": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves all of the tag names.", - "operationId": "tagKeys_4", - "parameters": [ - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/TagKeyResponse" - } - } - } - } - } - } - } - }, - "/azure/vsa/metadata/containers": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves all blob containers.", - "operationId": "listContainers_1", - "parameters": [ - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "resourceGroupName", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "storageAccountName", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureBlobContainer" - } - } - } - } - } - } - } - }, - "/azure/vsa/metadata/regions": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves the Azure regions where a Cloud Volumes ONTAP system can be created.", - "operationId": "regions_4", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureRegionResponse" - } - } - } - } - } - } - } - }, - "/azure/vsa/metadata/permutations": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves all Cloud Volumes ONTAP configurations.", - "operationId": "permutations_4", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Configuration" - } - } - } - } - } - } - } - }, - "/azure/vsa/metadata/default-snapshot-policies": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves the default snapshot policies available on a cluster.", - "operationId": "defaultSnapshotPolicies_4", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicy" - } - } - } - } - } - } - } - }, - "/azure/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves the instance types that do not support acceleration and capacity tiering.", - "operationId": "instanceTypesNotSupportingAccelerationAndCapacityTiering_4", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse" - } - } - } - } - } - } - }, - "/azure/vsa/metadata/supported-features": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves the supported features.", - "operationId": "supportedFeatures_4", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ontapVersion", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "dataEncryptionType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "licenseType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "instanceType", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportedFeaturesResponse" - } - } - } - } - } - } - }, - "/azure/vsa/metadata/packages": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Metadata" - ], - "description": "Retrieves the packages configuration.", - "operationId": "packages_4", - "parameters": [ - { - "name": "deploymentModel", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "capacityPackage", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/PackageInfoResponse" - } - } - } - } - } - } - } - }, - "/azure/vsa/working-environments": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves Cloud Volumes ONTAP systems visible to the current user.", - "operationId": "workingEnvironments_5", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "tenantId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureVsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Creates a new Cloud Volumes ONTAP system.", - "operationId": "createVsaWorkingEnvironment_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateAzureVSAWorkingEnvironmentRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureVsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/svm/{svmName}": { - "delete": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Deletes an SVM.", - "operationId": "deleteSvm_2", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/svm": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Modifies the SVM name of the Cloud Volumes ONTAP system.", - "operationId": "changeSvmName_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SvmNameModificationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Creates a new SVM.", - "operationId": "createSvm_2", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateAzureSvmRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves Azure VMware Solution private cloud clusters for the existing subscription.", - "operationId": "privateCloudClusters_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "privateCloudName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AvsPrivateCloudCluster" - } - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters/{clusterName}/hosts": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves Azure VMware Solution cluster hosts for the existing subscription.", - "operationId": "privateCloudClusterHosts_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "privateCloudName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "clusterName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AvsPrivateCloudClusterHost" - } - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/available-ips-in-subnet": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves the number of available IP addresses in the Cloud Volumes ONTAP system's subnet.", - "operationId": "availableIpsInVsaSubnet_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AvailableIpsResponse" - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/resource-group-exists/{resourceGroupName}": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Checks if a resource group with the specified name already exists. Returns true if a resource group with that name already exists, false otherwise.", - "operationId": "resourceGroupExists_1", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "subscriptionId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/avs-private-clouds": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves an Azure VMware Solution private cloud for the existing subscription.", - "operationId": "privateClouds_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AvsPrivateCloud" - } - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves a Cloud Volumes ONTAP system.", - "operationId": "workingEnvironment_5", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AzureVsaWorkingEnvironmentResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Deletes an existing Cloud Volumes ONTAP system, including all cloud resources created for the system (unless the localDelete flag is set to true).", - "operationId": "deleteVsaWorkingEnvironment_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "localDelete", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "forceDelete", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/delete-cifs": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Deletes the CIFS configuration of an existing Cloud Volumes ONTAP system.", - "operationId": "setupCifsConfiguration_9", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CIFSDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves the CIFS configuration for an existing Cloud Volumes ONTAP system.", - "operationId": "cifsConfiguration_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svm", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CIFSConfigurationResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Sets up a new CIFS configuration for an existing Cloud Volumes ONTAP system.", - "operationId": "setupCifsConfiguration_10", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CIFSConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Validates the prerequisites for converting an existing Cloud Volumes ONTAP system.", - "operationId": "preValidateByolToCapacity_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreValidationResponse" - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/writing-speed": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Sets the writing speed for Cloud Volumes ONTAP.", - "operationId": "modifyWritingSpeed_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WritingSpeedRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/license-instance-type": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves all license types and their associated instance types for a specific Cloud Volumes ONTAP instance.", - "operationId": "licenseAndInstanceTypes_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseAndInstanceType" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Sets the instance type of a specific Cloud Volumes ONTAP system.", - "operationId": "changeLicenseAndInstanceType_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseAndInstanceTypeModificationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/ontap-available-images": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves images already installed on the Cloud Volumes ONTAP system.", - "operationId": "ontapAvailableImages_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/UpdateLocalImage" - } - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/update-image": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP system.", - "operationId": "updateSystemImage_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateSystemImageRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/update-eligibility": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves the eligibility support status of a Cloud Volumes ONTAP system. Valid values are NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED.", - "operationId": "occmUpgradeEligibilityChecks_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EligibilityResponse" - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/upload-license-file": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Uploads a cloud license file on the specified Cloud Volumes ONTAP system.", - "operationId": "uploadLicenseFile_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves a list of versions to which this Cloud Volumes ONTAP system can be upgraded.", - "operationId": "occmProvidedCloudOntapUpgradeVersions_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OntapUpdateImageMetadata" - } - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/sync-subscription": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Manually triggers subscription synchronization for all Cloud Volumes ONTAP systems.", - "operationId": "syncVsaWorkingEnvironmentsSubscription_4", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/upload-licenses": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Uploads the content of a cloud license file on the specified Cloud Volumes ONTAP system.", - "operationId": "uploadLicenseFileContent_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseFileContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/offbox": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Activates an off-box configuration.", - "operationId": "activateOntapConfiguration_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/networkOptimization": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Modifies the network port broadcast domain MTU of the Cloud Volumes ONTAP system.", - "operationId": "changeNetworkOptimizationLevel_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeNetworkOptimizationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/create-request-parameters": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves the action parameters used in the create request for a specific Cloud Volumes ONTAP instance.", - "operationId": "createRequestParameters_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateRequestParametersResponse" - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Enables capacity tiering.", - "operationId": "enableCapacityTiering_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EnableCapacityTieringRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/cost-and-usage": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves the system cost and usage.", - "operationId": "workingEnvironmentCostAndUsage_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "start", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "end", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkingEnvironmentCostAndUsageResponse" - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/ontap-saving": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves system ONTAP savings.", - "operationId": "workingEnvironmentOntapSaving_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkingEnvironmentOntapSavingResponse" - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves extra capacity licenses for Cloud Volumes ONTAP.", - "operationId": "getExtraCapacityLicenses_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GetLicenseResponse" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": " Updates an extra capacity license.", - "operationId": "updateExtraCapacityLicenses_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Registers an extra capacity license.", - "operationId": "uploadExtraCapacityLicenses_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": " Updates an extra capacity license serial number.", - "operationId": "updateExtraCapacitySerials_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Registers an extra capacity serial number.", - "operationId": "uploadExtraCapacitySerials_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Deletes extra capacity licenses by serial numbers.", - "operationId": "deleteExtraCapacityLicenses_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/vscan-file-op": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Updates the default Vscan file operation profile. Profiles on existing CIFS shares will change only on writes-only mode.", - "operationId": "updateVscanFileOperation_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VscanFileOpRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/user-tags": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves the editable tags for the cloud resources in a specific Cloud Volumes ONTAP instance.", - "operationId": "userTags_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserTagsResponse" - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Modifies the user tags for cloud resources in a specific Cloud Volumes ONTAP instance.", - "operationId": "modifyUserTags_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ModifyUserTagsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/parse-license-file": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Parses an uploaded cloud license file.", - "operationId": "parseLicenseFile_4", - "parameters": [ - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProvidedLicenseResponse" - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Updates the NetApp Console password for a specific Cloud Volumes ONTAP system.", - "operationId": "updatePassword_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateCredentialsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/change-tier-level": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Updates the tier level.", - "operationId": "changeTierLevel_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeTierLevelRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/enable-worm": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Enables SnapLock for an existing Cloud Volumes ONTAP system.", - "operationId": "enableWorm_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WormRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Updates a bring-your-own-license (BYOL) license to a capacity-based license for an existing Cloud Volumes ONTAP system.", - "operationId": "byolToCapacity_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseConversionRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RegisterCvoResponse" - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/ntp": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Sets up an NTP server.", - "operationId": "setupNtpServer_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NTPConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/start": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Starts a specific Cloud Volumes ONTAP instance.", - "operationId": "startVsa_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/stop": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Stops a specific Cloud Volumes ONTAP instance.", - "operationId": "stopVsa_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "takeSnapshots", - "in": "query", - "schema": { - "type": "boolean", - "default": true - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/support-registration": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Retrieves the support registration status of a Cloud Volumes ONTAP system.", - "operationId": "status_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportRegistrationResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Registers a Cloud Volumes ONTAP system with NetApp.", - "operationId": "registerSupport_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "nssAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportRegistrationResponse" - } - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/schedules": { - "get": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Lists the start/stop schedules for Cloud Volumes ONTAP.", - "operationId": "getSchedules_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaSchedule" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Sets schedules for Cloud Volumes ONTAP.", - "operationId": "setSchedules_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaSchedulesRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Activates the FPolicy for ransomware files.", - "operationId": "activateFpolicy_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Disables the FPolicy for ransomware files.", - "operationId": "disableFpolicy_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/fpolicy": { - "delete": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Deletes the FPolicy for ransomware files.", - "operationId": "deleteFpolicy_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Activates snapshot policy assignment for all unprotected read/write volumes.", - "operationId": "activateSnapshotPolicy_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/snapshot-policy": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Creates a snapshot policy.", - "operationId": "createSnapshotPolicy_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotPolicyCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/change-serial": { - "post": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Updates the serial number of a Cloud Volumes ONTAP system.", - "operationId": "changeSerialNumber_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeSerialNumberRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/azure/vsa/working-environments/{workingEnvironmentId}/set-password": { - "put": { - "tags": [ - "ONTAP Cloud Azure system operations - Systems" - ], - "description": "Sets the cluster password for a specific Cloud Volumes ONTAP system.", - "operationId": "setPassword_4", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "occmOnly", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordWrapper" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Retrieves Cloud Volumes ONTAP systems visible to the current user.", - "operationId": "workingEnvironments_6", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "tenantId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpVsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Creates a new Cloud Volumes ONTAP system.", - "operationId": "createVsaWorkingEnvironment_2", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateGcpVsaWorkingEnvironmentRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpVsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/svm/{svmName}": { - "delete": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Deletes an SVM.", - "operationId": "deleteSvm_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/svm": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Modifies the SVM name of the Cloud Volumes ONTAP system.", - "operationId": "changeSvmName_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SvmNameModificationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Creates a new SVM.", - "operationId": "createSvm_3", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateSvmRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Retrieves a Cloud Volumes ONTAP system.", - "operationId": "workingEnvironment_6", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GcpVsaWorkingEnvironmentResponse" - } - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Deletes an existing Cloud Volumes ONTAP system, including all cloud resources created for the system (unless the localDelete flag is set to true).", - "operationId": "deleteVsaWorkingEnvironment_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "localDelete", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "forceDelete", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/delete-cifs": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Deletes the CIFS configuration of an existing Cloud Volumes ONTAP system.", - "operationId": "setupCifsConfiguration_11", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CIFSDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/cifs": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Retrieves the CIFS configuration for an existing Cloud Volumes ONTAP system.", - "operationId": "cifsConfiguration_7", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svm", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CIFSConfigurationResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Sets up a new CIFS configuration for an existing Cloud Volumes ONTAP system.", - "operationId": "setupCifsConfiguration_12", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CIFSConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Validates the prerequisites for converting an existing Cloud Volumes ONTAP system.", - "operationId": "preValidateByolToCapacity_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreValidationResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/writing-speed": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Sets the writing speed for Cloud Volumes ONTAP.", - "operationId": "modifyWritingSpeed_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WritingSpeedRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/license-instance-type": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Retrieves all license types and their associated instance types for a specific Cloud Volumes ONTAP instance.", - "operationId": "licenseAndInstanceTypes_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseAndInstanceType" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Sets the instance type of a specific Cloud Volumes ONTAP system.", - "operationId": "changeLicenseAndInstanceType_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseAndInstanceTypeModificationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/ontap-available-images": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Retrieves images already installed on the Cloud Volumes ONTAP system.", - "operationId": "ontapAvailableImages_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/UpdateLocalImage" - } - } - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/update-image": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP system.", - "operationId": "updateSystemImage_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateSystemImageRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/update-eligibility": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Retrieves the eligibility support status of a Cloud Volumes ONTAP system. Valid values are NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED.", - "operationId": "occmUpgradeEligibilityChecks_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EligibilityResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/upload-license-file": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Uploads a cloud license file on the specified Cloud Volumes ONTAP system.", - "operationId": "uploadLicenseFile_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Retrieves a list of versions to which this Cloud Volumes ONTAP system can be upgraded.", - "operationId": "occmProvidedCloudOntapUpgradeVersions_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OntapUpdateImageMetadata" - } - } - } - } - } - } - } - }, - "/gcp/vsa/working-environments/sync-subscription": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Manually triggers subscription synchronization for all Cloud Volumes ONTAP systems.", - "operationId": "syncVsaWorkingEnvironmentsSubscription_5", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/upload-licenses": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Uploads the content of a cloud license file on the specified Cloud Volumes ONTAP system.", - "operationId": "uploadLicenseFileContent_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseFileContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/offbox": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Activates an off-box configuration.", - "operationId": "activateOntapConfiguration_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/networkOptimization": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Modifies the network port broadcast domain MTU of the Cloud Volumes ONTAP system.", - "operationId": "changeNetworkOptimizationLevel_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeNetworkOptimizationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/create-request-parameters": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Retrieves the action parameters used in the create request for a specific Cloud Volumes ONTAP instance.", - "operationId": "createRequestParameters_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateRequestParametersResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Enables capacity tiering.", - "operationId": "enableCapacityTiering_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EnableCapacityTieringRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/cost-and-usage": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Retrieves the system cost and usage.", - "operationId": "workingEnvironmentCostAndUsage_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "start", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "end", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkingEnvironmentCostAndUsageResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/ontap-saving": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Retrieves system ONTAP savings.", - "operationId": "workingEnvironmentOntapSaving_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkingEnvironmentOntapSavingResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Retrieves extra capacity licenses for Cloud Volumes ONTAP.", - "operationId": "getExtraCapacityLicenses_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GetLicenseResponse" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": " Updates an extra capacity license.", - "operationId": "updateExtraCapacityLicenses_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Registers an extra capacity license.", - "operationId": "uploadExtraCapacityLicenses_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesContent" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": " Updates an extra capacity license serial number.", - "operationId": "updateExtraCapacitySerials_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Registers an extra capacity serial number.", - "operationId": "uploadExtraCapacitySerials_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Deletes extra capacity licenses by serial numbers.", - "operationId": "deleteExtraCapacityLicenses_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicensesSerials" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/vscan-file-op": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Updates the default Vscan file operation profile. Profiles on existing CIFS shares will change only on writes-only mode.", - "operationId": "updateVscanFileOperation_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VscanFileOpRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/user-tags": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Retrieves the editable tags for the cloud resources in a specific Cloud Volumes ONTAP instance.", - "operationId": "userTags_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserTagsResponse" - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Modifies the user tags for cloud resources in a specific Cloud Volumes ONTAP instance.", - "operationId": "modifyUserTags_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ModifyUserTagsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/parse-license-file": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Parses an uploaded cloud license file.", - "operationId": "parseLicenseFile_5", - "parameters": [ - { - "name": "filename", - "in": "header", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/MultipartFormDataInput" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProvidedLicenseResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/update-credentials": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Updates the NetApp Console password for a specific Cloud Volumes ONTAP system.", - "operationId": "updatePassword_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateCredentialsRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/change-tier-level": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Updates the tier level.", - "operationId": "changeTierLevel_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeTierLevelRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/enable-worm": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Enables SnapLock for an existing Cloud Volumes ONTAP system.", - "operationId": "enableWorm_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WormRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Updates a bring-your-own-license (BYOL) license to a capacity-based license for an existing Cloud Volumes ONTAP system.", - "operationId": "byolToCapacity_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LicenseConversionRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RegisterCvoResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/ntp": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Sets up an NTP server.", - "operationId": "setupNtpServer_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NTPConfigurationRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/start": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Starts a specific Cloud Volumes ONTAP instance.", - "operationId": "startVsa_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/stop": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Stops a specific Cloud Volumes ONTAP instance.", - "operationId": "stopVsa_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "takeSnapshots", - "in": "query", - "schema": { - "type": "boolean", - "default": true - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/support-registration": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Retrieves the support registration status of a Cloud Volumes ONTAP system.", - "operationId": "status_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportRegistrationResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Registers a Cloud Volumes ONTAP system with NetApp.", - "operationId": "registerSupport_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "nssAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportRegistrationResponse" - } - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/schedules": { - "get": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Lists the start/stop schedules for Cloud Volumes ONTAP.", - "operationId": "getSchedules_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaSchedule" - } - } - } - } - } - } - }, - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Sets schedules for Cloud Volumes ONTAP.", - "operationId": "setSchedules_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaSchedulesRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Activates the FPolicy for ransomware files.", - "operationId": "activateFpolicy_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Disables the FPolicy for ransomware files.", - "operationId": "disableFpolicy_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/fpolicy": { - "delete": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Deletes the FPolicy for ransomware files.", - "operationId": "deleteFpolicy_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Activates snapshot policy assignment for all unprotected read/write volumes.", - "operationId": "activateSnapshotPolicy_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/snapshot-policy": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Creates a snapshot policy.", - "operationId": "createSnapshotPolicy_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotPolicyCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/change-serial": { - "post": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Updates the serial number of a Cloud Volumes ONTAP system.", - "operationId": "changeSerialNumber_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeSerialNumberRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/gcp/vsa/working-environments/{workingEnvironmentId}/set-password": { - "put": { - "tags": [ - "ONTAP Cloud GCP system operations - Systems" - ], - "description": "Sets the cluster password for a specific Cloud Volumes ONTAP system.", - "operationId": "setPassword_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "occmOnly", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PasswordWrapper" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/add-capacity": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Aggregates" - ], - "description": "Adds capacity to an existing elastic volume aggregate.", - "operationId": "addCapacityToEvAggregate_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddCapacityToEvAggregateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/aggregates": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Aggregates" - ], - "description": "Retrieves aggregates.", - "operationId": "aggregates_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AggregateResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Aggregates" - ], - "description": "Creates a new aggregate.", - "operationId": "createAggregate_5", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaAggregateCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/aggregates/{workingEnvironmentId}/{aggregateName}": { - "delete": { - "tags": [ - "ONTAP Cloud AWS system operations - Aggregates" - ], - "description": "Deletes an existing aggregate.", - "operationId": "deleteAggregate_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Aggregates" - ], - "description": "Adds disks to an existing aggregate.", - "operationId": "addDisksToAggregate_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "aggregateName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddDisksToAggregateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/discover": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Discovery" - ], - "description": "Retrieves a list of discovered systems visible to the current user in the specified AWS region.", - "operationId": "discover_5", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DiscoveredVsaResponse" - } - } - } - } - } - } - } - }, - "/vsa/recover": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Discovery" - ], - "description": "Saves a previously discovered Cloud Volumes ONTAP system to the NetApp Console database.", - "operationId": "recover_3", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecoverVsaRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "/vsa/encryption/{workingEnvironmentId}/update-key-manager-ca-certificate": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Encryption" - ], - "description": "Updates the key manager certificate authority (CA) certificate on the Cloud Volumes ONTAP system.", - "operationId": "updateKeyManagerCaCertificate_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateKeyManagerCaCertificateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - } - }, - "/vsa/encryption/{workingEnvironmentId}/update-client-certificate": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Encryption" - ], - "description": "Updates the client certificate on the Cloud Volumes ONTAP system.", - "operationId": "updateClientCertificate_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - } - } - } - } - }, - "/vsa/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Encryption" - ], - "description": "Adds a key manager to the Cloud Volumes ONTAP system.", - "operationId": "addKeyManagerToVsa_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "keyManagerIp", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud AWS system operations - Encryption" - ], - "description": "Deletes a key manager from the Cloud Volumes ONTAP system.", - "operationId": "deleteKeyManagerFromVsa_1", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "keyManagerIp", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/metadata/permutations": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves all Cloud Volumes ONTAP configurations.", - "operationId": "permutations_5", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Configuration" - } - } - } - } - } - } - } - }, - "/vsa/metadata/network-requirements": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves the minimum number of required IP addresses for a single Cloud Volumes ONTAP system, HA node, and HA mediator.", - "operationId": "networkRequirements_5", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NetworkRequirementsResponse" - } - } - } - } - } - } - }, - "/vsa/metadata/aws-encryption-keys": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves AWS encryption keys for a specific region.", - "operationId": "awsEncryptionKeys_1", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AwsEncryptionKey" - } - } - } - } - } - } - } - }, - "/vsa/metadata/validate-subscribed-to-ontap-cloud": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Validates that the current user is subscribed to the Cloud Volumes ONTAP product in Amazon marketplace.", - "operationId": "validateSubscribedToOntapCloud_3", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AwsValidateSubscribedToOntapCloudRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AwsValidateSubscribedToOntapCloudResponse" - } - } - } - } - } - } - }, - "/vsa/metadata/get-buckets-details": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves all S3 buckets with additional information.", - "operationId": "listDetailedBuckets_1", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/S3BucketsSummary" - } - } - } - } - } - } - }, - "/vsa/metadata/get-buckets-application-info": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves the S3 buckets policy status and tiering level.", - "operationId": "getBucketsPolicyAndTieringData_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BucketsPolicyAndTieringInfoRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/BucketAdditionalData" - } - } - } - } - } - } - } - }, - "/vsa/metadata/supported-capacity-tiers": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves supported capacity tiers for EBS volume types.", - "operationId": "supportedCapacityTiers_5", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ontapVersion", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "dataEncryptionType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "licenseType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "instanceType", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportedCapacityTiers" - } - } - } - } - } - } - }, - "/vsa/metadata/buckets": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves all S3 buckets.", - "operationId": "listBuckets_3", - "parameters": [ - { - "name": "tagsRequired", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/S3BucketInfo" - } - } - } - } - } - } - } - }, - "/vsa/metadata/instance-profiles": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves AWS instance profiles.", - "operationId": "instanceProfiles_1", - "parameters": [ - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceProfileResponse" - } - } - } - } - } - } - } - }, - "/vsa/metadata/key-pairs": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves AWS user Key Pairs for a specific region.", - "operationId": "keyPairs_1", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "/vsa/metadata/key-pairs-by-region": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves AWS user Key Pairs for all regions.", - "operationId": "keyPairsByRegion_1", - "parameters": [ - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeyPairsByRegionResponse" - } - } - } - } - } - } - }, - "/vsa/metadata/manifests": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves all NetApp Console manifests. Refer to the API Developers Guide in order to understand how to extract valid region codes, license types, instance types and Cloud Volumes ONTAP version parameters for the creation of a Cloud Volumes ONTAP system.", - "operationId": "manifests_1", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MetadataResponse" - } - } - } - } - } - } - }, - "/vsa/metadata/vpcs": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves VPCs.", - "operationId": "vpcs_3", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VpcExtendedResponse" - } - } - } - } - } - } - } - }, - "/vsa/metadata/s3-summary": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves the S3 buckets summary.", - "operationId": "s3summary_1", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/S3Summary" - } - } - } - } - } - } - }, - "/vsa/metadata/create-bucket": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Creates a new S3 bucket.", - "operationId": "createBucket_3", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "bucketName", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/metadata/ebs-volume-types": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves supported EBS volume types.", - "operationId": "disks_5", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/EbsVolumeType" - } - } - } - } - } - } - } - }, - "/vsa/metadata/tag-keys": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves all of the tag names.", - "operationId": "tagKeys_5", - "parameters": [ - { - "name": "roleArn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cloudProviderAccountId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/TagKeyResponse" - } - } - } - } - } - } - } - }, - "/vsa/metadata/regions": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves AWS regions over which a Cloud Volumes ONTAP system can be created.", - "operationId": "regions_5", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Region" - } - } - } - } - } - } - } - }, - "/vsa/metadata/default-snapshot-policies": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves the default snapshot policies available on a cluster.", - "operationId": "defaultSnapshotPolicies_5", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicy" - } - } - } - } - } - } - } - }, - "/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves the instance types that do not support acceleration and capacity tiering.", - "operationId": "instanceTypesNotSupportingAccelerationAndCapacityTiering_5", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse" - } - } - } - } - } - } - }, - "/vsa/metadata/supported-features": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves the supported features.", - "operationId": "supportedFeatures_5", - "parameters": [ - { - "name": "region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ontapVersion", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "dataEncryptionType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "licenseType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "instanceType", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportedFeaturesResponse" - } - } - } - } - } - } - }, - "/vsa/metadata/packages": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Metadata" - ], - "description": "Retrieves the packages configuration.", - "operationId": "packages_5", - "parameters": [ - { - "name": "deploymentModel", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "capacityPackage", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/PackageInfoResponse" - } - } - } - } - } - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Modifies an existing volume.", - "operationId": "modifyVolume_7", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Deletes an existing volume.", - "operationId": "deleteVolume_7", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/volumes/volumes-for-backup": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Retrieves all volumes for backup activation.", - "operationId": "volumesForBackup_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "offset", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "limit", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "search", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "filterBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListFilterByParam" - } - }, - { - "name": "sortBy", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ListSortByParam" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumesListForBackup" - } - } - } - } - } - } - }, - "/vsa/volumes/quote": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Retrieves quotes for a new volume. Returns the resource quote required for the requested volume.", - "operationId": "quoteVolume_5", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeQuoteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeQuoteResponse" - } - } - } - } - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Updates the underlying volume tier.", - "operationId": "changeVolumeTier_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeVolumeTierRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/volumes/igroups/{workingEnvironmentId}/{svmName}": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Retrieves all igroups.", - "operationId": "getIgroups_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/IGroup" - } - } - } - } - } - } - } - }, - "/vsa/volumes/initiator": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Retrieves all iSCSI initiators.", - "operationId": "getInitiators_6", - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Initiator" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Adds an iSCSI initiator.", - "operationId": "saveInitiator_6", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Initiator" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Returns a list of snapshot descriptions for the volume.", - "operationId": "volumeSnapshots_7", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotResponse" - } - } - } - } - } - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy": { - "put": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Adds an export policy rule.", - "operationId": "addExportPolicyRule_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/VolumeName" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeModifyRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Clones an existing volume.", - "operationId": "cloneVolume_7", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeCloneRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Creates a snapshot manually.", - "operationId": "createSnapshot_7", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - }, - "delete": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Deletes a snapshot manually.", - "operationId": "deleteSnapshot_7", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotDeleteRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move": { - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Moves an existing volume.", - "operationId": "moveVolume_5", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "svmName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "volumeName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VolumeMoveRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/volumes": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Retrieves all volumes.", - "operationId": "volumes_6", - "parameters": [ - { - "name": "workingEnvironmentId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Volumes" - ], - "description": "Creates a new volume. If the aggregateName and maxNumOfDisksApprovedToAdd properties are not populated, the response fails with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.", - "operationId": "createVolume_7", - "parameters": [ - { - "name": "createAggregateIfNotFound", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaVolumeCreateRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - - } - } - } - } - } - }, - "/vsa/working-environments": { - "get": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Retrieves Cloud Volumes ONTAP systems visible to the current user.", - "operationId": "workingEnvironments_7", - "parameters": [ - { - "name": "fields", - "in": "query", - "schema": { - "$ref": "#/components/schemas/Expands" - } - }, - { - "name": "tenantId", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaWorkingEnvironmentResponse" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "ONTAP Cloud AWS system operations - Systems" - ], - "description": "Creates a new Cloud Volumes ONTAP system. Refer to the API Developers Guide in order to understand how to populate the values for the region, licenseType, instanceType, and version.", - "operationId": "createVsaWorkingEnvironment_3", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateVSAWorkingEnvironmentRequest" - } - } - } - }, - "responses": { - "default": { - "description": "default response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VsaWorkingEnvironmentResponse" - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "DiscoveredGcpHaResponse": { - "required": [ - "name", - "recoverable", - "zones" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - }, - "publicId": { - "type": "string" - }, - "zones": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "vpcs": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "subnetIds": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "projectName": { - "type": "string" - }, - "clusterAddress": { - "type": "string" - }, - "recoverable": { - "type": "boolean" - } - } - }, - "SeqDiscoveredGcpHaResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DiscoveredGcpHaResponse" - } - }, - "SeqString": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "ActionRequired": { - "required": [ - "actionType", - "parameters", - "severity" - ], - "type": "object", - "properties": { - "actionType": { - "type": "string" - }, - "parameters": { - "$ref": "#/components/schemas/ActionRequiredParameters" - }, - "severity": { - "type": "string" - } - } - }, - "ActionRequiredParameters": { - "required": [ - "aggregateName", - "instances", - "isCapacityBased", - "isComposite", - "licenseExpiryDate", - "maxCapacity", - "numOfDisks", - "serialNumber", - "totalCapacity", - "volumeNames", - "workingEnvironmentId" - ], - "type": "object", - "properties": { - "aggregateName": { - "type": "string" - }, - "numOfDisks": { - "type": "integer", - "format": "int32" - }, - "totalCapacity": { - "$ref": "#/components/schemas/Capacity" - }, - "evCapacityDetails": { - "$ref": "#/components/schemas/ElasticVolumeQuoteInfo" - }, - "volumeNames": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "maxCapacity": { - "$ref": "#/components/schemas/Capacity" - }, - "licenseExpiryDate": { - "type": "integer", - "format": "int64" - }, - "serialNumber": { - "type": "string" - }, - "volumeMoveParameters": { - "$ref": "#/components/schemas/VolumeMoveParameters" - }, - "workingEnvironmentId": { - "type": "string" - }, - "licenseParameters": { - "$ref": "#/components/schemas/ChangeLicenseParameters" - }, - "resourcesToDelete": { - "$ref": "#/components/schemas/ResourcesToDelete" - }, - "instances": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceNameIdAndType" - } - }, - "moreInfo": { - "type": "string" - }, - "providerVolumeType": { - "type": "string" - }, - "volumeInfo": { - "$ref": "#/components/schemas/VolumeInfo" - }, - "currentInstanceType": { - "type": "string" - }, - "isComposite": { - "type": "boolean" - }, - "isCapacityBased": { - "type": "boolean" - } - } - }, - "AwsEncryptionKey": { - "type": "object", - "properties": { - "alias": { - "type": "string" - }, - "keyId": { - "type": "string" - }, - "status": { - "type": "string" - }, - "validTo": { - "type": "object" - }, - "origin": { - "type": "string" - }, - "default": { - "type": "boolean" - } - } - }, - "BroadcastDomainInfo": { - "required": [ - "mtu" - ], - "type": "object", - "properties": { - "broadcastDomain": { - "type": "string" - }, - "ipSpace": { - "type": "string" - }, - "mtu": { - "type": "integer", - "format": "int32" - } - } - }, - "Capacity": { - "required": [ - "size", - "unit" - ], - "type": "object", - "properties": { - "size": { - "type": "number", - "format": "double" - }, - "unit": { - "type": "string" - } - } - }, - "CapacityFeatures": { - "type": "object", - "properties": { - "providerVolumesType": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ProviderVolumeTypeResponse" - } - }, - "defaultProviderVolumeType": { - "$ref": "#/components/schemas/DefaultProviderVolume" - }, - "supportedCapacityTiers": { - "$ref": "#/components/schemas/SupportedCapacityTiers" - }, - "maxDisksPerAggregate": { - "type": "integer", - "format": "int32" - }, - "existingIops": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "object" - } - } - } - }, - "CapacityTierInfo": { - "type": "object", - "properties": { - "capacityTierUsedSize": { - "$ref": "#/components/schemas/Capacity" - }, - "s3BucketName": { - "type": "string" - }, - "tierLevel": { - "type": "string" - } - } - }, - "CbsPropertiesWithReason": { - "type": "object", - "properties": { - "cbsBackupStatus": { - "type": "string" - }, - "cbsRules": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CbsSchedule" - } - }, - "numberOfBackedUpVolumes": { - "type": "integer", - "format": "int32" - }, - "objectStoreName": { - "type": "string" - }, - "providerSpecific": { - "$ref": "#/components/schemas/ProviderSpecific" - }, - "cbsPolicyName": { - "type": "string" - }, - "usedCapacity": { - "$ref": "#/components/schemas/Capacity" - }, - "ipSpace": { - "type": "string" - }, - "region": { - "type": "string" - }, - "providerAccountName": { - "type": "string" - }, - "exclusionReason": { - "type": "string" - } - } - }, - "CbsSchedule": { - "type": "object", - "properties": { - "snapmirrorLabel": { - "type": "string" - }, - "snapshotsToKeep": { - "type": "integer", - "format": "int32" - } - } - }, - "CertificateResponse": { - "required": [ - "startDate" - ], - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "directIssuerName": { - "type": "string" - }, - "subjectName": { - "type": "string" - }, - "startDate": { - "type": "integer", - "format": "int64" - }, - "endDate": { - "type": "integer", - "format": "int64" - }, - "serialNumber": { - "type": "string" - }, - "certificate": { - "type": "string" - }, - "certificateType": { - "type": "string" - } - } - }, - "ChangeLicenseParameters": { - "type": "object", - "properties": { - "newLicenseType": { - "$ref": "#/components/schemas/OntapLicenseType" - }, - "newInstanceType": { - "type": "string" - } - } - }, - "CloudComplianceStatusResponse": { - "type": "object", - "properties": { - "scanStatus": { - "type": "string" - }, - "complianceStatus": { - "$ref": "#/components/schemas/ComplianceExtendedStatusResponse" - }, - "lastDeploymentError": { - "type": "string" - }, - "complianceBackupStatus": { - "type": "string" - } - } - }, - "ComplianceExtendedStatusResponse": { - "type": "object", - "properties": { - "sensitivePersonalHits": { - "type": "integer", - "format": "int32" - }, - "personalHits": { - "type": "integer", - "format": "int32" - }, - "nonSensitiveHits": { - "type": "integer", - "format": "int32" - }, - "scanStatus": { - "$ref": "#/components/schemas/ComplianceScanStatusResponse" - } - } - }, - "ComplianceScanStatusResponse": { - "type": "object", - "properties": { - "scanned": { - "type": "integer", - "format": "int32" - }, - "notScanned": { - "type": "integer", - "format": "int32" - }, - "volumes": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ComplianceScanStatusVolumeResponse" - } - } - } - }, - "ComplianceScanStatusVolumeResponse": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "status": { - "type": "string" - }, - "error": { - "type": "string" - }, - "scopeId": { - "type": "object" - } - } - }, - "CvoSaasProperties": { - "type": "object", - "properties": { - "subscription": { - "$ref": "#/components/schemas/SaasSubscription" - }, - "freeTrialExpiry": { - "type": "object" - }, - "saasEnabled": { - "type": "object" - }, - "capacityLicensePackage": { - "type": "string" - } - } - }, - "DefaultProviderVolume": { - "type": "object", - "properties": { - "size": { - "$ref": "#/components/schemas/Capacity" - }, - "diskType": { - "type": "string" - }, - "capacityTier": { - "type": "string" - }, - "iops": { - "type": "object" - } - } - }, - "DisksDetails": { - "type": "object", - "properties": { - "numberOfDisks": { - "type": "integer", - "format": "int32" - }, - "diskSize": { - "$ref": "#/components/schemas/Capacity" - }, - "diskType": { - "type": "string" - } - } - }, - "ElasticVolumeQuoteInfo": { - "type": "object", - "properties": { - "totalCapacityToAdd": { - "$ref": "#/components/schemas/Capacity" - }, - "addedCapacityToExistingEvDisks": { - "$ref": "#/components/schemas/Capacity" - }, - "newRaidForEvInfo": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/RaidInfoForEvAggregate" - } - }, - "totalEvDisks": { - "type": "integer", - "format": "int32" - } - } - }, - "EncryptionProperties": { - "type": "object", - "properties": { - "ontapEncryption": { - "type": "boolean" - }, - "awsVolumeEncryption": { - "type": "boolean" - }, - "azureVolumeEncryption": { - "type": "boolean" - }, - "gcpVolumeEncryption": { - "type": "boolean" - }, - "keyManagers": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/KeyManagerResponse" - } - }, - "encryptionCertificates": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CertificateResponse" - } - }, - "awsEncryptionKey": { - "$ref": "#/components/schemas/AwsEncryptionKey" - } - } - }, - "FailureCauses": { - "required": [ - "invalidOntapCredentials" - ], - "type": "object", - "properties": { - "invalidOntapCredentials": { - "type": "boolean" - }, - "noCloudProviderConnection": { - "type": "boolean" - }, - "invalidCloudProviderCredentials": { - "type": "boolean" - } - } - }, - "FpolicyProperties": { - "type": "object", - "properties": { - "status": { - "type": "integer", - "format": "int32" - }, - "fPolicyProtocolStatus": { - "$ref": "#/components/schemas/FpolicyProtocolStatus" - }, - "fileExtensions": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "FpolicyProtocolStatus": { - "type": "object", - "properties": { - "nfsv3": { - "type": "integer", - "format": "int32" - }, - "nfsv4": { - "type": "integer", - "format": "int32" - }, - "cifs": { - "type": "integer", - "format": "int32" - } - } - }, - "GcpHaMediatorInfo": { - "type": "object", - "properties": { - "mediatorInstanceName": { - "type": "string" - }, - "zone": { - "type": "string" - }, - "instanceType": { - "type": "string" - }, - "primaryIp": { - "type": "string" - }, - "instanceStatus": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "GcpHaNodeInfo": { - "type": "object", - "properties": { - "instanceName": { - "type": "string" - }, - "zone": { - "type": "string" - }, - "instanceType": { - "type": "string" - }, - "primaryIp": { - "type": "string" - }, - "instanceStatus": { - "type": "string" - }, - "numOfNics": { - "type": "integer", - "format": "int32" - }, - "labels": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "string" - } - } - } - }, - "GcpHaProperties": { - "type": "object", - "properties": { - "mediatorInfo": { - "$ref": "#/components/schemas/GcpHaMediatorInfo" - }, - "node1Info": { - "$ref": "#/components/schemas/GcpHaNodeInfo" - }, - "node2Info": { - "$ref": "#/components/schemas/GcpHaNodeInfo" - }, - "projectName": { - "type": "string" - } - } - }, - "GcpProperties": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "regionName": { - "type": "string" - }, - "zoneName": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "instanceType": { - "type": "string" - }, - "subnetCidr": { - "type": "string" - }, - "numOfNics": { - "type": "integer", - "format": "int32" - }, - "labels": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "string" - } - }, - "projectName": { - "type": "string" - }, - "deploymentName": { - "type": "string" - } - } - }, - "GcpVsaWorkingEnvironmentResponse": { - "required": [ - "actionsRequired", - "isHA", - "licensesInformation", - "publicId", - "schedules", - "snapshotPolicies", - "supportRegistrationInformation", - "svms" - ], - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "creatorUserEmail": { - "type": "string" - }, - "status": { - "$ref": "#/components/schemas/StatusProperties" - }, - "providerProperties": { - "$ref": "#/components/schemas/GcpProperties" - }, - "reservedSize": { - "$ref": "#/components/schemas/Capacity" - }, - "clusterProperties": { - "$ref": "#/components/schemas/VsaClusterProperties" - }, - "ontapClusterProperties": { - "$ref": "#/components/schemas/OntapClusterProperties" - }, - "cloudProviderName": { - "type": "string" - }, - "snapshotPolicies": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicy" - } - }, - "actionsRequired": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ActionRequired" - } - }, - "activeActions": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "replicationProperties": { - "$ref": "#/components/schemas/ReplicationProperties" - }, - "schedules": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaSchedule" - } - }, - "svms": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Svm" - } - }, - "workingEnvironmentType": { - "type": "string" - }, - "supportRegistrationProperties": { - "$ref": "#/components/schemas/SupportRegistrationProperties" - }, - "supportRegistrationInformation": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SupportRegistrationInformation" - } - }, - "capacityFeatures": { - "$ref": "#/components/schemas/CapacityFeatures" - }, - "encryptionProperties": { - "$ref": "#/components/schemas/EncryptionProperties" - }, - "supportedFeatures": { - "$ref": "#/components/schemas/SupportedFeatures" - }, - "isHA": { - "type": "boolean" - }, - "haProperties": { - "$ref": "#/components/schemas/GcpHaProperties" - }, - "fpolicyProperties": { - "$ref": "#/components/schemas/FpolicyProperties" - }, - "saasProperties": { - "$ref": "#/components/schemas/CvoSaasProperties" - }, - "cbsProperties": { - "$ref": "#/components/schemas/CbsPropertiesWithReason" - }, - "complianceProperties": { - "$ref": "#/components/schemas/CloudComplianceStatusResponse" - }, - "monitoringProperties": { - "$ref": "#/components/schemas/MonitoringStatusResponse" - }, - "licensesInformation": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseInformation" - } - } - } - }, - "InstanceNameIdAndType": { - "type": "object", - "properties": { - "instanceName": { - "type": "string" - }, - "instanceType": { - "type": "string" - }, - "instanceId": { - "type": "string" - } - } - }, - "KeyManagerResponse": { - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "address": { - "type": "string" - }, - "usernameField": { - "type": "string" - }, - "usernameValue": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "KpiUnitValue": { - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double" - }, - "unit": { - "type": "string" - } - } - }, - "LicenseInformation": { - "required": [ - "package", - "type", - "useType" - ], - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "byol", - "paygo", - "eval", - "free_trail", - "capacity" - ] - }, - "useType": { - "type": "string", - "enum": [ - "system", - "EXTRA_CAPACITY", - "BACKUP", - "CVO_NODE", - "CAPACITY_BASED" - ] - }, - "package": { - "type": "string", - "enum": [ - "explore", - "standard", - "premium" - ] - }, - "serialNumbers": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "capacityLimit": { - "$ref": "#/components/schemas/Capacity" - }, - "expirations": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "object" - } - } - } - }, - "LifResponse": { - "required": [ - "dataProtocols", - "ip", - "lifType", - "netmask", - "nodeName", - "privateIp" - ], - "type": "object", - "properties": { - "ip": { - "type": "string" - }, - "netmask": { - "type": "string" - }, - "lifType": { - "type": "string" - }, - "dataProtocols": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "nodeName": { - "type": "string" - }, - "privateIp": { - "type": "boolean" - } - } - }, - "MapStringString": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "string" - } - }, - "MaxDisksAllow": { - "type": "object", - "properties": { - "numOfDisks": { - "type": "integer", - "format": "int32" - }, - "reason": { - "type": "string" - } - } - }, - "MonitoringInfo": { - "type": "object", - "properties": { - "averageIops": { - "type": "number", - "format": "double" - }, - "averageLatency": { - "$ref": "#/components/schemas/KpiUnitValue" - }, - "storageAverageThroughput": { - "$ref": "#/components/schemas/KpiUnitValue" - }, - "node1AverageThroughput": { - "$ref": "#/components/schemas/KpiUnitValue" - }, - "node2AverageThroughput": { - "$ref": "#/components/schemas/KpiUnitValue" - } - } - }, - "MonitoringStatusResponse": { - "type": "object", - "properties": { - "monitoringStatus": { - "type": "string" - }, - "monitoringInfo": { - "$ref": "#/components/schemas/MonitoringInfo" - }, - "tenantUrl": { - "type": "string" - } - } - }, - "OntapClusterProperties": { - "type": "object", - "properties": { - "nodes": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OntapNodeProperties" - } - }, - "clusterName": { - "type": "string" - }, - "clusterUuid": { - "type": "string" - }, - "ontapVersion": { - "type": "string" - }, - "systemManagerUrl": { - "type": "string" - }, - "creationTime": { - "type": "integer", - "format": "int64" - }, - "licenseType": { - "$ref": "#/components/schemas/VsaLicense" - }, - "licensePackageName": { - "type": "string" - }, - "isKeystoneSubscription": { - "type": "boolean" - }, - "lastModifiedOffbox": { - "type": "object" - }, - "offboxTarget": { - "type": "boolean" - }, - "upgradeVersions": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OntapUpdateImageMetadata" - } - }, - "writingSpeedState": { - "type": "string" - }, - "broadcastDomainInfos": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/BroadcastDomainInfo" - } - }, - "evaluation": { - "type": "boolean" - }, - "capacityTierInfo": { - "$ref": "#/components/schemas/CapacityTierInfo" - }, - "canConfigureCapacityTier": { - "type": "boolean" - }, - "usedCapacity": { - "$ref": "#/components/schemas/Capacity" - }, - "userName": { - "type": "string" - }, - "wormEnabled": { - "type": "boolean" - }, - "isSpaceReportingLogical": { - "type": "boolean" - }, - "vscanFileOperationDefaultProfile": { - "type": "string" - }, - "aggregateCount": { - "type": "integer", - "format": "int32" - }, - "volumeCount": { - "type": "integer", - "format": "int32" - }, - "flashCache": { - "type": "boolean" - } - } - }, - "OntapLicenseType": { - "required": [ - "capacityLimit" - ], - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "subName": { - "type": "string" - }, - "subDescription": { - "type": "string" - }, - "capacity_limit": { - "type": "string" - }, - "platformLicenseRequired": { - "type": "boolean" - }, - "default": { - "type": "boolean" - }, - "capacityLimit": { - "$ref": "#/components/schemas/Capacity" - } - } - }, - "OntapNodeProperties": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "lifs": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LifResponse" - } - }, - "serialNumber": { - "type": "string" - }, - "systemId": { - "type": "string" - }, - "platformLicense": { - "type": "string" - }, - "platformSerialNumber": { - "type": "string" - }, - "cloudProviderId": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "inTakeover": { - "type": "boolean" - } - } - }, - "OntapUpdateImageMetadata": { - "required": [ - "autoUpdateAllowed", - "imageVersion", - "lastModified" - ], - "type": "object", - "properties": { - "imageVersion": { - "type": "string" - }, - "lastModified": { - "type": "integer", - "format": "int64" - }, - "autoUpdateAllowed": { - "type": "boolean" - } - } - }, - "PolicySchedule": { - "required": [ - "frequency", - "retention" - ], - "type": "object", - "properties": { - "frequency": { - "type": "string" - }, - "retention": { - "type": "integer", - "format": "int32" - } - } - }, - "ProviderSpecific": { - "type": "object", - "properties": { - "azureRgName": { - "type": "string" - }, - "gcpProjectId": { - "type": "string" - }, - "gcpRegion": { - "type": "string" - } - } - }, - "ProviderVolumeTypeResponse": { - "required": [ - "maxDisksAllow" - ], - "type": "object", - "properties": { - "size": { - "$ref": "#/components/schemas/Capacity" - }, - "supportedVolumeTypes": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "maxDisksAllow": { - "$ref": "#/components/schemas/MaxDisksAllow" - } - } - }, - "RaidInfoForEvAggregate": { - "required": [ - "diskSize", - "numOfDisks" - ], - "type": "object", - "properties": { - "numOfDisks": { - "type": "integer", - "format": "int32" - }, - "diskSize": { - "$ref": "#/components/schemas/Capacity" - } - } - }, - "ReplicationProperties": { - "type": "object", - "properties": { - "peers": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "replicationTargets": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "ResourcesToDelete": { - "type": "object", - "properties": { - "instanceNameAndType": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceNameIdAndType" - } - }, - "numberOfDisksAndDiskSize": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DisksDetails" - } - } - } - }, - "SaasSubscription": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - } - } - }, - "SeqActionRequired": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ActionRequired" - } - }, - "SeqBroadcastDomainInfo": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/BroadcastDomainInfo" - } - }, - "SeqCbsSchedule": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CbsSchedule" - } - }, - "SeqCertificateResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CertificateResponse" - } - }, - "SeqComplianceScanStatusVolumeResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ComplianceScanStatusVolumeResponse" - } - }, - "SeqDisksDetails": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DisksDetails" - } - }, - "SeqInstanceNameIdAndType": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceNameIdAndType" - } - }, - "SeqKeyManagerResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/KeyManagerResponse" - } - }, - "SeqLicenseInformation": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseInformation" - } - }, - "SeqLifResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LifResponse" - } - }, - "SeqObject": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "object" - } - }, - "SeqOntapNodeProperties": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OntapNodeProperties" - } - }, - "SeqOntapUpdateImageMetadata": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OntapUpdateImageMetadata" - } - }, - "SeqPolicySchedule": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/PolicySchedule" - } - }, - "SeqProviderVolumeTypeResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ProviderVolumeTypeResponse" - } - }, - "SeqRaidInfoForEvAggregate": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/RaidInfoForEvAggregate" - } - }, - "SeqSnapshotPolicy": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicy" - } - }, - "SeqStartStopRange": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/StartStopRange" - } - }, - "SeqSupportRegistrationInformation": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SupportRegistrationInformation" - } - }, - "SeqSupportedCapacityTiersResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SupportedCapacityTiersResponse" - } - }, - "SeqSvm": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Svm" - } - }, - "SeqValue": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Value" - } - }, - "SeqVsaSchedule": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaSchedule" - } - }, - "SnapshotPolicy": { - "required": [ - "description", - "name", - "schedules" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "schedules": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/PolicySchedule" - } - }, - "description": { - "type": "string" - } - } - }, - "StartStopRange": { - "required": [ - "stop" - ], - "type": "object", - "properties": { - "stop": { - "$ref": "#/components/schemas/TimePoint" - }, - "start": { - "$ref": "#/components/schemas/TimePoint" - } - } - }, - "StatusProperties": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "message": { - "type": "string" - }, - "failureCauses": { - "$ref": "#/components/schemas/FailureCauses" - }, - "extendedFailureReason": { - "type": "string" - } - } - }, - "SupportRegistrationInformation": { - "type": "object", - "properties": { - "supportRegistrationStatus": { - "type": "string" - }, - "serialNumber": { - "type": "string" - }, - "licenseExpiryDate": { - "type": "object" - }, - "cloudLicenseExists": { - "type": "boolean" - }, - "nssAccountId": { - "type": "string" - } - } - }, - "SupportRegistrationProperties": { - "type": "object", - "properties": { - "supportRegistrationStatus": { - "type": "string" - }, - "licenseExpiryDate": { - "type": "integer", - "format": "int64" - } - } - }, - "SupportedCapacityTiers": { - "required": [ - "supportedCapacityTiersPerVolumeType" - ], - "type": "object", - "properties": { - "supportedCapacityTiersPerVolumeType": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SupportedCapacityTiersResponse" - } - }, - "capacityTiersDisableReasons": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "compositeSupported": { - "type": "boolean" - }, - "forceCompositeVersion": { - "type": "boolean" - } - } - }, - "SupportedCapacityTiersResponse": { - "type": "object", - "properties": { - "volumeType": { - "type": "string" - }, - "supportedCapacityTiers": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "availableTieringPolicies": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "SupportedFeatures": { - "type": "object", - "properties": { - "supportsMixedAggregates": { - "type": "boolean" - }, - "supportsTieringWithServiceAccount": { - "type": "boolean" - }, - "supportsGp3Disk": { - "type": "boolean" - }, - "supportsElasticVolumes": { - "type": "boolean" - } - } - }, - "Svm": { - "required": [ - "allowedProtocols", - "ver3Enabled", - "ver4Enabled" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "state": { - "type": "string" - }, - "allowedProtocols": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Value" - } - }, - "language": { - "type": "string" - }, - "allowedAggregates": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "ver3Enabled": { - "type": "boolean" - }, - "ver4Enabled": { - "type": "boolean" - } - } - }, - "TimePoint": { - "required": [ - "day" - ], - "type": "object", - "properties": { - "day": { - "type": "integer", - "format": "int32" - }, - "hour": { - "type": "integer", - "format": "int32" - }, - "minute": { - "type": "integer", - "format": "int32" - } - } - }, - "Value": { - "type": "object" - }, - "VolumeInfo": { - "type": "object", - "properties": { - "volumeName": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "newCapacity": { - "$ref": "#/components/schemas/Capacity" - } - } - }, - "VolumeMoveParameters": { - "type": "object", - "properties": { - "volumeName": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "targetAggregateName": { - "type": "string" - }, - "isNewTargetAggregate": { - "type": "boolean" - }, - "homeNode": { - "type": "string" - } - } - }, - "VsaClusterProperties": { - "type": "object", - "properties": { - "lifs": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LifResponse" - } - }, - "serialNumber": { - "type": "string" - }, - "systemId": { - "type": "string" - }, - "clusterName": { - "type": "string" - }, - "ontapVersion": { - "type": "string" - }, - "accountId": { - "type": "string" - }, - "productCode": { - "type": "string" - }, - "amiId": { - "type": "string" - }, - "systemManagerUrl": { - "type": "string" - }, - "creationTime": { - "type": "integer", - "format": "int64" - }, - "instanceId": { - "type": "string" - }, - "platformLicense": { - "type": "string" - }, - "licenseExpiryDate": { - "type": "integer", - "format": "int64" - }, - "instanceType": { - "type": "string" - }, - "publicIp": { - "type": "string" - }, - "publicDnsName": { - "type": "string" - }, - "licenseType": { - "$ref": "#/components/schemas/VsaLicense" - }, - "lastModifiedOffbox": { - "type": "object" - }, - "offboxTarget": { - "type": "boolean" - }, - "upgradeVersions": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OntapUpdateImageMetadata" - } - }, - "writingSpeedState": { - "type": "string" - } - } - }, - "VsaLicense": { - "required": [ - "capacityLimit", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "capacityLimit": { - "$ref": "#/components/schemas/Capacity" - } - } - }, - "VsaSchedule": { - "required": [ - "name", - "schedule" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "schedule": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/StartStopRange" - } - }, - "enabled": { - "type": "boolean" - } - } - }, - "ClusterCredentialsRequest": { - "required": [ - "userName" - ], - "type": "object", - "properties": { - "userName": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "RecoverGcpHaRequest": { - "required": [ - "clusterCredentials", - "region" - ], - "type": "object", - "properties": { - "region": { - "type": "string" - }, - "name": { - "type": "string" - }, - "clusterCredentials": { - "$ref": "#/components/schemas/ClusterCredentialsRequest" - }, - "tenantId": { - "type": "string" - }, - "projectId": { - "type": "string" - }, - "nssAccountId": { - "type": "string" - } - } - }, - "DiscoveredGcpVsaResponse": { - "required": [ - "name", - "recoverable" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - }, - "publicId": { - "type": "string" - }, - "zone": { - "type": "string" - }, - "vnetName": { - "type": "string" - }, - "vnetId": { - "type": "string" - }, - "projectName": { - "type": "string" - }, - "subnetName": { - "type": "string" - }, - "clusterAddress": { - "type": "string" - }, - "recoverable": { - "type": "boolean" - } - } - }, - "SeqDiscoveredGcpVsaResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DiscoveredGcpVsaResponse" - } - }, - "RecoverGcpVsaRequest": { - "required": [ - "clusterCredentials", - "zone" - ], - "type": "object", - "properties": { - "zone": { - "type": "string" - }, - "instanceName": { - "type": "string" - }, - "clusterCredentials": { - "$ref": "#/components/schemas/ClusterCredentialsRequest" - }, - "tenantId": { - "type": "string" - }, - "projectId": { - "type": "string" - }, - "nssAccountId": { - "type": "string" - } - } - }, - "AllowedValuesForVolumesListFilter": { - "type": "object", - "properties": { - "volumeTypes": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "diskTypes": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "svmNames": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "volumeStatus": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "SeqOptionString": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "SeqVolumeForBackupResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeForBackupResponse" - } - }, - "VolumeForBackupResponse": { - "required": [ - "disableReasonBackup", - "isBackupOn", - "name", - "size" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "size": { - "$ref": "#/components/schemas/Capacity" - }, - "usedSize": { - "$ref": "#/components/schemas/Capacity" - }, - "state": { - "type": "string" - }, - "providerVolumeType": { - "type": "string" - }, - "volumeType": { - "type": "string" - }, - "isBackupOn": { - "type": "boolean" - }, - "disableReasonBackup": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "VolumesListForBackup": { - "required": [ - "totalNumberOfVolumes", - "volumes" - ], - "type": "object", - "properties": { - "volumes": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeForBackupResponse" - } - }, - "totalNumberOfVolumes": { - "type": "integer", - "format": "int32" - }, - "filteredNumberOfVolumes": { - "type": "object" - }, - "hasNextPage": { - "type": "object" - }, - "allowedValuesForVolumesListFilter": { - "$ref": "#/components/schemas/AllowedValuesForVolumesListFilter" - } - } - }, - "ListFilterByParam": { - "required": [ - "s" - ], - "type": "object", - "properties": { - "s": { - "type": "string", - "writeOnly": true - } - } - }, - "ListSortByParam": { - "required": [ - "s" - ], - "type": "object", - "properties": { - "s": { - "type": "string", - "writeOnly": true - } - } - }, - "VsaVolumeQuoteResponse": { - "required": [ - "aggregateName", - "autoVsaCapacityManagement", - "diskSize", - "newAggregate", - "numOfDisks" - ], - "type": "object", - "properties": { - "numOfDisks": { - "type": "integer", - "format": "int32" - }, - "diskSize": { - "$ref": "#/components/schemas/Capacity" - }, - "aggregateName": { - "type": "string" - }, - "newAggregate": { - "type": "boolean" - }, - "autoVsaCapacityManagement": { - "type": "boolean" - }, - "elasticVolumeQuoteResponse": { - "$ref": "#/components/schemas/ElasticVolumeQuoteInfo" - } - } - }, - "PositiveCapacity": { - "required": [ - "size", - "unit" - ], - "type": "object", - "properties": { - "size": { - "type": "number", - "format": "double" - }, - "unit": { - "type": "string" - } - } - }, - "VsaVolumeQuoteRequest": { - "required": [ - "enableThinProvisioning", - "isReplicationFlow", - "size", - "svmName", - "verifyNameUniqueness", - "workingEnvironmentId" - ], - "type": "object", - "properties": { - "workingEnvironmentId": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "aggregateName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "size": { - "$ref": "#/components/schemas/PositiveCapacity" - }, - "initialSize": { - "$ref": "#/components/schemas/Capacity" - }, - "enableThinProvisioning": { - "type": "boolean" - }, - "providerVolumeType": { - "type": "string" - }, - "verifyNameUniqueness": { - "type": "boolean" - }, - "capacityTier": { - "type": "string" - }, - "isReplicationFlow": { - "type": "boolean" - }, - "iops": { - "type": "integer", - "format": "int32" - }, - "throughput": { - "type": "integer", - "format": "int32" - }, - "tieringPolicy": { - "type": "string" - } - } - }, - "ChangeVolumeTierRequest": { - "required": [ - "aggregateName", - "newAggregate", - "newDiskTypeName", - "numOfDisks" - ], - "type": "object", - "properties": { - "aggregateName": { - "type": "string" - }, - "numOfDisks": { - "type": "integer", - "format": "int32" - }, - "newAggregate": { - "type": "boolean" - }, - "newDiskTypeName": { - "type": "string" - }, - "newCapacityTier": { - "type": "string" - }, - "iops": { - "type": "integer", - "format": "int32" - }, - "throughput": { - "type": "integer", - "format": "int32" - }, - "newTieringPolicy": { - "type": "string" - }, - "evCapacityApprovedToAdd": { - "$ref": "#/components/schemas/ElasticVolumeQuoteInfo" - }, - "minimumCoolingDays": { - "type": "object" - } - } - }, - "ConnectionState": { - "type": "object", - "properties": { - "connection_state": { - "type": "string" - } - } - }, - "IGroup": { - "required": [ - "igroupName", - "igroupType", - "initiators", - "initiatorsWithConnStatus", - "lunMaps" - ], - "type": "object", - "properties": { - "igroupName": { - "type": "string" - }, - "osType": { - "type": "string" - }, - "portsetName": { - "type": "string" - }, - "igroupType": { - "type": "string", - "enum": [ - "undefined", - "fcp", - "iscsi", - "mixed" - ] - }, - "initiators": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "lunMaps": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LunMapsLun" - } - }, - "initiatorsWithConnStatus": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InitiatorsConnectivityStateNameObject" - } - } - } - }, - "InitiatorsConnectivityStateNameObject": { - "required": [ - "connectivity_tracking" - ], - "type": "object", - "properties": { - "connectivity_tracking": { - "$ref": "#/components/schemas/ConnectionState" - }, - "name": { - "type": "string" - } - } - }, - "LunMapsLun": { - "required": [ - "lun" - ], - "type": "object", - "properties": { - "lun": { - "$ref": "#/components/schemas/NameUuidObject" - } - } - }, - "NameUuidObject": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "uuid": { - "type": "string" - } - } - }, - "SeqIGroup": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/IGroup" - } - }, - "SeqInitiatorsConnectivityStateNameObject": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InitiatorsConnectivityStateNameObject" - } - }, - "SeqLunMapsLun": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LunMapsLun" - } - }, - "Initiator": { - "required": [ - "aliasName", - "iqn" - ], - "type": "object", - "properties": { - "aliasName": { - "type": "string" - }, - "iqn": { - "type": "string" - } - } - }, - "SeqInitiator": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Initiator" - } - }, - "SeqSnapshotResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotResponse" - } - }, - "SnapshotResponse": { - "required": [ - "accessTime", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "accessTime": { - "type": "integer", - "format": "int64" - }, - "label": { - "type": "string" - } - } - }, - "PatternMessage": { - "required": [ - "regex" - ], - "type": "object", - "properties": { - "regex": { - "$ref": "#/components/schemas/Regex" - }, - "message": { - "type": "string" - } - } - }, - "Regex": { - "required": [ - "groupNames", - "pattern" - ], - "type": "object", - "properties": { - "pattern": { - "required": [ - "flags" - ], - "type": "object", - "properties": { - "pattern": { - "type": "string" - }, - "flags": { - "type": "integer", - "format": "int32" - }, - "cursor": { - "type": "integer", - "format": "int32", - "writeOnly": true - } - } - }, - "groupNames": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "VolumeName": { - "required": [ - "_1", - "validatesWith" - ], - "type": "object", - "properties": { - "_1": { - "type": "string" - }, - "validatesWith": { - "$ref": "#/components/schemas/PatternMessage" - } - } - }, - "CifsShareInfo": { - "required": [ - "accessControlList", - "shareName" - ], - "type": "object", - "properties": { - "shareName": { - "type": "string" - }, - "accessControlList": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CifsShareUserPermissions" - } - }, - "vscanFileOpPolicy": { - "type": "string" - } - } - }, - "CifsShareUserPermissions": { - "required": [ - "users" - ], - "type": "object", - "properties": { - "permission": { - "type": "string" - }, - "users": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "ExportPolicyRule": { - "required": [ - "ips", - "ruleAccessControl", - "superUser" - ], - "type": "object", - "properties": { - "index": { - "type": "object" - }, - "ruleAccessControl": { - "type": "string" - }, - "ips": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "nfsVersion": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "superUser": { - "type": "boolean" - } - } - }, - "NamedExportPolicyInfo": { - "required": [ - "ips", - "policyType", - "rules" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "policyType": { - "type": "string" - }, - "ips": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "nfsVersion": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "rules": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ExportPolicyRule" - } - } - } - }, - "SeqCifsShareUserPermissions": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CifsShareUserPermissions" - } - }, - "SeqExportPolicyRule": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ExportPolicyRule" - } - }, - "VolumeModifyRequest": { - "type": "object", - "properties": { - "snapshotPolicyName": { - "type": "string" - }, - "shareInfo": { - "$ref": "#/components/schemas/CifsShareInfo" - }, - "exportPolicyInfo": { - "$ref": "#/components/schemas/NamedExportPolicyInfo" - }, - "qualityOfService": { - "$ref": "#/components/schemas/VolumeQualityOfService" - }, - "tieringPolicy": { - "type": "string" - }, - "minimumCoolingDays": { - "type": "integer", - "format": "int32" - }, - "comment": { - "type": "string" - } - } - }, - "VolumeQualityOfService": { - "type": "object", - "properties": { - "maxIops": { - "type": "integer", - "format": "int32" - }, - "maxDataRate": { - "$ref": "#/components/schemas/Capacity" - } - } - }, - "VolumeCloneRequest": { - "required": [ - "newVolumeName" - ], - "type": "object", - "properties": { - "newVolumeName": { - "type": "string" - }, - "parentSnapshot": { - "type": "string" - } - } - }, - "SnapshotDeleteRequest": { - "required": [ - "snapshotName" - ], - "type": "object", - "properties": { - "snapshotName": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "VolumeMoveRequest": { - "required": [ - "createTargetAggregate", - "numOfDisksToAdd", - "targetAggregateName" - ], - "type": "object", - "properties": { - "targetAggregateName": { - "type": "string" - }, - "numOfDisksToAdd": { - "type": "integer", - "format": "int32" - }, - "createTargetAggregate": { - "type": "boolean" - }, - "newDiskTypeName": { - "type": "string" - }, - "newCapacityTier": { - "type": "string" - }, - "newTieringPolicy": { - "type": "string" - }, - "evCapacityApprovedToAdd": { - "$ref": "#/components/schemas/ElasticVolumeQuoteInfo" - } - } - }, - "CreateCifsShareInfoRequest": { - "type": "object", - "properties": { - "shareName": { - "type": "string" - }, - "accessControl": { - "$ref": "#/components/schemas/CifsShareUserPermissions" - } - } - }, - "CreateIscsiInfoRequest": { - "type": "object", - "properties": { - "osName": { - "type": "string" - }, - "igroupCreationRequest": { - "$ref": "#/components/schemas/IgroupCreationRequest" - }, - "igroups": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "ExportPolicyInfo": { - "type": "object", - "properties": { - "policyType": { - "type": "string" - }, - "ips": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "nfsVersion": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "rules": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ExportPolicyRule" - } - } - } - }, - "FlexGroupVolumeInfo": { - "type": "object", - "properties": { - "aggregateList": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "numberOfConstituents": { - "type": "integer", - "format": "int32" - } - } - }, - "IgroupCreationRequest": { - "type": "object", - "properties": { - "initiators": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "igroupName": { - "type": "string" - } - } - }, - "SeqVolumeTags": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeTags" - } - }, - "VolumeTags": { - "type": "object", - "properties": { - "tagKey": { - "type": "string" - }, - "tagValue": { - "type": "string" - } - } - }, - "VsaVolumeCreateRequest": { - "required": [ - "aggregateName", - "enableCompression", - "enableDeduplication", - "enableThinProvisioning", - "maxNumOfDisksApprovedToAdd", - "size", - "snapshotPolicyName", - "svmName", - "syncToS3", - "volumeTags", - "workingEnvironmentId" - ], - "type": "object", - "properties": { - "workingEnvironmentId": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "aggregateName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "size": { - "$ref": "#/components/schemas/PositiveCapacity" - }, - "initialSize": { - "$ref": "#/components/schemas/Capacity" - }, - "snapshotPolicyName": { - "type": "string" - }, - "exportPolicyInfo": { - "$ref": "#/components/schemas/ExportPolicyInfo" - }, - "shareInfo": { - "$ref": "#/components/schemas/CreateCifsShareInfoRequest" - }, - "iscsiInfo": { - "$ref": "#/components/schemas/CreateIscsiInfoRequest" - }, - "enableThinProvisioning": { - "type": "boolean" - }, - "enableCompression": { - "type": "boolean" - }, - "enableDeduplication": { - "type": "boolean" - }, - "maxNumOfDisksApprovedToAdd": { - "type": "integer", - "format": "int32" - }, - "evCapacityApprovedToAdd": { - "$ref": "#/components/schemas/ElasticVolumeQuoteInfo" - }, - "providerVolumeType": { - "type": "string" - }, - "syncToS3": { - "type": "boolean" - }, - "capacityTier": { - "type": "string" - }, - "iops": { - "type": "integer", - "format": "int32" - }, - "throughput": { - "type": "integer", - "format": "int32" - }, - "tieringPolicy": { - "type": "string" - }, - "junctionPath": { - "type": "string" - }, - "qualityOfService": { - "$ref": "#/components/schemas/VolumeQualityOfService" - }, - "minimumCoolingDays": { - "type": "object" - }, - "volumeTags": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeTags" - } - }, - "comment": { - "type": "string" - }, - "flexGroupVolumeInfo": { - "$ref": "#/components/schemas/FlexGroupVolumeInfo" - } - } - }, - "SeqCifsShareInfo": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CifsShareInfo" - } - }, - "SeqVolumeResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeResponse" - } - }, - "VolumeCbsInfo": { - "type": "object", - "properties": { - "totalBackups": { - "type": "integer", - "format": "int32" - } - } - }, - "VolumeResponse": { - "required": [ - "aggregateName", - "autoSizeMode", - "cloneNames", - "compression", - "compressionSpaceSaved", - "constituentsAggregates", - "deduplication", - "deduplicationSpaceSaved", - "exportPolicyInfo", - "isFlexGroupVolume", - "iscsiEnabled", - "junctionPath", - "maxGrowSize", - "moving", - "name", - "parentVolumeName", - "rootVolume", - "securityStyle", - "shareInfo", - "shareNames", - "size", - "snapshotPolicy", - "state", - "svmName", - "targetName", - "thinProvisioning", - "usedSize", - "uuid", - "volumeType" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "size": { - "$ref": "#/components/schemas/Capacity" - }, - "usedSize": { - "$ref": "#/components/schemas/Capacity" - }, - "junctionPath": { - "type": "string" - }, - "volumeTotalInodes": { - "type": "integer", - "format": "int64" - }, - "volumeUsedInodes": { - "type": "integer", - "format": "int64" - }, - "mountPoint": { - "type": "string" - }, - "compressionSpaceSaved": { - "$ref": "#/components/schemas/Capacity" - }, - "deduplicationSpaceSaved": { - "$ref": "#/components/schemas/Capacity" - }, - "thinProvisioning": { - "type": "boolean" - }, - "compression": { - "type": "boolean" - }, - "deduplication": { - "type": "boolean" - }, - "snapshotPolicy": { - "type": "string" - }, - "securityStyle": { - "type": "string" - }, - "exportPolicyInfo": { - "$ref": "#/components/schemas/NamedExportPolicyInfo" - }, - "shareNames": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "shareInfo": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CifsShareInfo" - } - }, - "parentVolumeName": { - "type": "string" - }, - "rootVolume": { - "type": "boolean" - }, - "state": { - "type": "string" - }, - "volumeType": { - "type": "string" - }, - "aggregateName": { - "type": "string" - }, - "parentSnapshot": { - "type": "string" - }, - "autoSizeMode": { - "type": "string" - }, - "maxGrowSize": { - "$ref": "#/components/schemas/Capacity" - }, - "providerVolumeType": { - "type": "string" - }, - "cloneNames": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "moving": { - "type": "boolean" - }, - "primaryNoFailoverMountPoint": { - "type": "string" - }, - "secondaryNoFailoverMountPoint": { - "type": "string" - }, - "capacityTier": { - "type": "string" - }, - "capacityTierUsedSize": { - "$ref": "#/components/schemas/Capacity" - }, - "cifsShareAccessPoint": { - "type": "string" - }, - "primaryCifsShareAccessPoint": { - "type": "string" - }, - "secondaryCifsShareAccessPoint": { - "type": "string" - }, - "tieringPolicy": { - "type": "string" - }, - "tierInactiveUserData": { - "$ref": "#/components/schemas/Capacity" - }, - "tierInactiveUserDataPercent": { - "type": "integer", - "format": "int32" - }, - "comment": { - "type": "string" - }, - "qosPolicyGroupName": { - "type": "string" - }, - "snaplockType": { - "type": "string" - }, - "constituentsAggregates": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "snapshotsUsedSize": { - "$ref": "#/components/schemas/Capacity" - }, - "cbsBackupsInfo": { - "$ref": "#/components/schemas/VolumeCbsInfo" - }, - "minimumCoolingDays": { - "type": "integer", - "format": "int32" - }, - "targetName": { - "type": "string" - }, - "iscsiEnabled": { - "type": "boolean" - }, - "isFlexGroupVolume": { - "type": "boolean" - } - } - }, - "SnapshotCreateRequest": { - "type": "object", - "properties": { - "snapshotName": { - "type": "string" - } - } - }, - "AccountWorkingEnvironmentResponse": { - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "workingEnvironmentType": { - "type": "string" - } - } - }, - "AssumeRole": { - "type": "object", - "properties": { - "roleName": { - "type": "string" - }, - "accountId": { - "type": "string" - }, - "isGov": { - "type": "boolean" - } - } - }, - "AwsAccountResponse": { - "required": [ - "publicId", - "vsaList" - ], - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "accountName": { - "type": "string" - }, - "accountType": { - "type": "string" - }, - "accountId": { - "type": "string" - }, - "accessKey": { - "type": "string" - }, - "assumeRole": { - "$ref": "#/components/schemas/AssumeRole" - }, - "occmRole": { - "type": "string" - }, - "vsaList": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AccountWorkingEnvironmentResponse" - } - }, - "subscriptionId": { - "type": "string" - } - } - }, - "AzureAccountResponse": { - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "accountName": { - "type": "string" - }, - "accountType": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "applicationId": { - "type": "string" - }, - "occmRole": { - "type": "string" - }, - "vsaList": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AccountWorkingEnvironmentResponse" - } - } - } - }, - "CloudProviderAccountResponse": { - "required": [ - "awsAccounts", - "azureAccounts", - "gcpStorageAccounts", - "nssAccounts" - ], - "type": "object", - "properties": { - "awsAccounts": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AwsAccountResponse" - } - }, - "azureAccounts": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureAccountResponse" - } - }, - "gcpStorageAccounts": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpAccountResponse" - } - }, - "nssAccounts": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/NssAccountResponse" - } - } - } - }, - "GcpAccountResponse": { - "required": [ - "publicId", - "vsaList" - ], - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "accountName": { - "type": "string" - }, - "accountType": { - "type": "string" - }, - "accessKey": { - "type": "string" - }, - "vsaList": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AccountWorkingEnvironmentResponse" - } - }, - "occmRole": { - "type": "string" - } - } - }, - "NssAccountResponse": { - "required": [ - "publicId", - "vsaList" - ], - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "accountName": { - "type": "string" - }, - "accountType": { - "type": "string" - }, - "nssUserName": { - "type": "string" - }, - "vsaList": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AccountWorkingEnvironmentResponse" - } - } - } - }, - "SeqAccountWorkingEnvironmentResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AccountWorkingEnvironmentResponse" - } - }, - "SeqAwsAccountResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AwsAccountResponse" - } - }, - "SeqAzureAccountResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureAccountResponse" - } - }, - "SeqGcpAccountResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpAccountResponse" - } - }, - "SeqNssAccountResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/NssAccountResponse" - } - }, - "AwsAccessKeys": { - "required": [ - "accessKey" - ], - "type": "object", - "properties": { - "accessKey": { - "type": "string" - }, - "secretKey": { - "type": "string" - } - } - }, - "AwsAccountRequest": { - "required": [ - "providerKeys" - ], - "type": "object", - "properties": { - "accountName": { - "type": "string" - }, - "providerKeys": { - "$ref": "#/components/schemas/AwsKeysRequest" - }, - "subscriptionId": { - "type": "string" - } - } - }, - "AwsKeysRequest": { - "type": "object", - "properties": { - "awsAccessKeys": { - "$ref": "#/components/schemas/AwsAccessKeys" - }, - "assumeRoleArn": { - "type": "string" - } - } - }, - "GcpKeysForCloudStorageWithValidation": { - "type": "object", - "properties": { - "accessKey": { - "type": "string" - }, - "secretKey": { - "type": "string" - } - } - }, - "GcpStorageAccountRequest": { - "required": [ - "providerKeys" - ], - "type": "object", - "properties": { - "accountName": { - "type": "string" - }, - "providerKeys": { - "$ref": "#/components/schemas/GcpKeysForCloudStorageWithValidation" - } - } - }, - "AssociatedSubscription": { - "required": [ - "default", - "subscriptionId" - ], - "type": "object", - "properties": { - "subscriptionId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "saasSubscriptionId": { - "type": "string" - }, - "highAvailabilityEnabled": { - "type": "object" - }, - "vMOrchestratorZonalMultiFDEnabled": { - "type": "object" - } - } - }, - "SeqAssociatedSubscription": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AssociatedSubscription" - } - }, - "AzureAccountRequest": { - "required": [ - "providerKeys" - ], - "type": "object", - "properties": { - "accountName": { - "type": "string" - }, - "providerKeys": { - "$ref": "#/components/schemas/AzureKeys" - } - } - }, - "AzureKeys": { - "required": [ - "tenantId" - ], - "type": "object", - "properties": { - "tenantId": { - "type": "string" - }, - "applicationId": { - "type": "string" - }, - "applicationKey": { - "type": "string" - }, - "subscription": { - "type": "string" - } - } - }, - "NssAccountVsaListRequest": { - "required": [ - "vsaList" - ], - "type": "object", - "properties": { - "vsaList": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "NssAccountCredentials": { - "required": [ - "nssUserName" - ], - "type": "object", - "properties": { - "nssUserName": { - "type": "string" - }, - "nssPassword": { - "type": "string" - } - } - }, - "NssAccountRequest": { - "required": [ - "providerKeys", - "vsaList" - ], - "type": "object", - "properties": { - "accountName": { - "type": "string" - }, - "providerKeys": { - "$ref": "#/components/schemas/NssAccountCredentials" - }, - "vsaList": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "AuditGroupSummary": { - "required": [ - "_id", - "actionName", - "id", - "records", - "requestId", - "startDate", - "version" - ], - "type": "object", - "properties": { - "_id": { - "type": "integer", - "format": "int32" - }, - "id": { - "type": "string" - }, - "requestId": { - "type": "string" - }, - "startDate": { - "type": "integer", - "format": "int64" - }, - "endDate": { - "type": "integer", - "format": "int64" - }, - "actionName": { - "type": "string" - }, - "status": { - "type": "string" - }, - "userName": { - "type": "string" - }, - "tenantName": { - "type": "string" - }, - "workingEnvironmentName": { - "type": "string" - }, - "actionParameters": { - "type": "string" - }, - "records": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AuditGroupSummaryRecord" - } - }, - "errorMessage": { - "type": "string" - }, - "version": { - "type": "string" - }, - "parentId": { - "type": "object" - }, - "userId": { - "type": "string" - }, - "workingEnvironmentId": { - "type": "string" - }, - "containsFailedRecords": { - "type": "boolean" - }, - "containsRecords": { - "type": "boolean" - } - } - }, - "AuditGroupSummaryRecord": { - "required": [ - "actionName", - "count", - "date", - "id", - "status" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "date": { - "type": "integer", - "format": "int64" - }, - "actionName": { - "type": "string" - }, - "status": { - "type": "string" - }, - "parameters": { - "type": "string" - }, - "errorMessage": { - "type": "string" - }, - "count": { - "type": "integer", - "format": "int32" - } - } - }, - "ListAuditGroupSummary": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AuditGroupSummary" - } - }, - "ListAuditGroupSummaryRecord": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AuditGroupSummaryRecord" - } - }, - "TaskCacheEntry": { - "required": [ - "actionName", - "closeTime", - "status" - ], - "type": "object", - "properties": { - "status": { - "type": "integer", - "format": "int32" - }, - "closeTime": { - "type": "integer", - "format": "int64" - }, - "actionName": { - "type": "string" - }, - "error": { - "type": "string" - } - } - }, - "CloudCentralAuditGroupResponse": { - "required": [ - "accountId", - "errors", - "startTime" - ], - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "principalId": { - "type": "string" - }, - "agentId": { - "type": "string" - }, - "agentName": { - "type": "string" - }, - "resourceId": { - "type": "string" - }, - "resourceName": { - "type": "string" - }, - "action": { - "type": "string" - }, - "startTime": { - "type": "integer", - "format": "int64" - }, - "endTime": { - "type": "object" - }, - "status": { - "type": "string" - }, - "requestId": { - "type": "string" - }, - "service": { - "type": "string" - }, - "errors": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "requestData": { - "type": "string" - }, - "hasRecords": { - "type": "boolean" - }, - "hasFailedRecords": { - "type": "boolean" - }, - "lastModified": { - "type": "integer", - "format": "int64" - } - } - }, - "SeqCloudCentralAuditGroupResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudCentralAuditGroupResponse" - } - }, - "CloudCentralAuditRecordResponse": { - "required": [ - "action", - "creationTime", - "errors" - ], - "type": "object", - "properties": { - "creationTime": { - "type": "integer", - "format": "int64" - }, - "action": { - "type": "string" - }, - "status": { - "type": "string" - }, - "data": { - "type": "string" - }, - "errors": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "recordId": { - "type": "integer", - "format": "int64" - }, - "count": { - "type": "integer", - "format": "int64" - } - } - }, - "ListCloudCentralAuditRecordResponse": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudCentralAuditRecordResponse" - } - }, - "CloudCentralAuditOptionsEntryResponse": { - "required": [ - "column" - ], - "type": "object", - "properties": { - "column": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "label": { - "type": "string" - } - } - }, - "CloudCentralAuditOptionsResponse": { - "required": [ - "service" - ], - "type": "object", - "properties": { - "service": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudCentralAuditOptionsEntryResponse" - } - }, - "action": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudCentralAuditOptionsEntryResponse" - } - }, - "agent": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudCentralAuditOptionsEntryResponse" - } - }, - "resource": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudCentralAuditOptionsEntryResponse" - } - }, - "user": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudCentralAuditOptionsEntryResponse" - } - } - } - }, - "SeqCloudCentralAuditOptionsEntryResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudCentralAuditOptionsEntryResponse" - } - }, - "AzureCredentials": { - "type": "object", - "properties": { - "subscriptionId": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "applicationId": { - "type": "string" - }, - "applicationKey": { - "type": "string" - } - } - }, - "CloudSyncLicenseInformation": { - "type": "object", - "properties": { - "cloudSyncLicenseTypes": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "licenseExpirationDate": { - "type": "integer", - "format": "int64" - } - } - }, - "SeqUserWorkingEnvironmentResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/UserWorkingEnvironmentResponse" - } - }, - "UserResponse": { - "required": [ - "assignedWorkingEnvironments", - "createdWorkingEnvironments", - "email", - "firstName", - "isLdap", - "lastName", - "ldapUserName", - "notificationsOptIn", - "permissions", - "publicId", - "roleId", - "tenantId" - ], - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "assignedWorkingEnvironments": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "email": { - "type": "string" - }, - "roleId": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "createdWorkingEnvironments": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/UserWorkingEnvironmentResponse" - } - }, - "azureCredentials": { - "$ref": "#/components/schemas/AzureCredentials" - }, - "cloudSyncLicenseInformation": { - "$ref": "#/components/schemas/CloudSyncLicenseInformation" - }, - "isLdap": { - "type": "boolean" - }, - "ldapUserName": { - "type": "string" - }, - "notificationsOptIn": { - "type": "boolean" - }, - "permissions": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "UserWorkingEnvironmentResponse": { - "required": [ - "name", - "publicId", - "workingEnvironmentType" - ], - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "workingEnvironmentType": { - "type": "string" - } - } - }, - "ResetPassword": { - "required": [ - "oldPassword" - ], - "type": "object", - "properties": { - "oldPassword": { - "type": "string" - }, - "newPassword": { - "type": "string" - } - } - }, - "UserPasswordRequest": { - "required": [ - "email", - "password" - ], - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "UpdateDisksIopsAndThrouputRequest": { - "required": [ - "iops", - "throughput" - ], - "type": "object", - "properties": { - "iops": { - "type": "integer", - "format": "int32" - }, - "throughput": { - "type": "integer", - "format": "int32" - } - } - }, - "AggregateResponse": { - "required": [ - "availableCapacity", - "disks", - "encryptionType", - "evCompatibilityType", - "homeNode", - "isRoot", - "name", - "providerVolumes", - "sidlEnabled", - "snaplockType", - "totalCapacity", - "usedCapacity", - "volumes" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "availableCapacity": { - "$ref": "#/components/schemas/Capacity" - }, - "totalCapacity": { - "$ref": "#/components/schemas/Capacity" - }, - "usedCapacity": { - "$ref": "#/components/schemas/Capacity" - }, - "volumes": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Volume" - } - }, - "providerVolumes": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ProviderVolumeResponse" - } - }, - "disks": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Disk" - } - }, - "state": { - "type": "string" - }, - "encryptionType": { - "type": "string" - }, - "encryptionKeyId": { - "type": "string" - }, - "isRoot": { - "type": "boolean" - }, - "homeNode": { - "type": "string" - }, - "ownerNode": { - "type": "string" - }, - "capacityTier": { - "type": "string" - }, - "capacityTierUsed": { - "$ref": "#/components/schemas/Capacity" - }, - "sidlEnabled": { - "type": "boolean" - }, - "snaplockType": { - "type": "string" - }, - "evCompatibilityType": { - "type": "string" - }, - "iops": { - "type": "object" - } - } - }, - "Disk": { - "required": [ - "containerType", - "ownerNode" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "containerType": { - "type": "string" - }, - "ownerNode": { - "type": "string" - }, - "device": { - "type": "string" - }, - "vmDiskProperties": { - "$ref": "#/components/schemas/VmDiskProperties" - } - } - }, - "ProviderVolumeResponse": { - "required": [ - "device", - "diskType", - "encrypted", - "id", - "instanceId", - "size", - "state" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "size": { - "$ref": "#/components/schemas/Capacity" - }, - "state": { - "type": "string" - }, - "device": { - "type": "string" - }, - "instanceId": { - "type": "string" - }, - "diskType": { - "type": "string" - }, - "encrypted": { - "type": "boolean" - }, - "iops": { - "type": "integer", - "format": "int32" - }, - "throughput": { - "type": "integer", - "format": "int32" - }, - "instance2Id": { - "type": "string" - } - } - }, - "SeqAggregateResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AggregateResponse" - } - }, - "SeqDisk": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Disk" - } - }, - "SeqProviderVolumeResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ProviderVolumeResponse" - } - }, - "SeqVolume": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Volume" - } - }, - "VmDiskProperties": { - "type": "object", - "properties": { - "objectName": { - "type": "string" - }, - "storageAccountName": { - "type": "string" - }, - "containerName": { - "type": "string" - } - } - }, - "Volume": { - "required": [ - "isClone", - "name", - "rootVolume", - "thinProvisioned", - "totalSize", - "usedSize" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "totalSize": { - "$ref": "#/components/schemas/Capacity" - }, - "usedSize": { - "$ref": "#/components/schemas/Capacity" - }, - "thinProvisioned": { - "type": "boolean" - }, - "isClone": { - "type": "boolean" - }, - "rootVolume": { - "type": "boolean" - } - } - }, - "VsaAggregateCreateRequest": { - "required": [ - "workingEnvironmentId" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "workingEnvironmentId": { - "type": "string" - }, - "numberOfDisks": { - "type": "integer", - "format": "int32" - }, - "diskSize": { - "$ref": "#/components/schemas/Capacity" - }, - "initialEvAggregateSize": { - "$ref": "#/components/schemas/Capacity" - }, - "homeNode": { - "type": "string" - }, - "providerVolumeType": { - "type": "string" - }, - "capacityTier": { - "type": "string" - }, - "iops": { - "type": "integer", - "format": "int32" - }, - "throughput": { - "type": "integer", - "format": "int32" - } - } - }, - "AddDisksToAggregateRequest": { - "required": [ - "numberOfDisks" - ], - "type": "object", - "properties": { - "numberOfDisks": { - "type": "integer", - "format": "int32" - } - } - }, - "AzureDiscoveredWorkingEnvironmentRequest": { - "required": [ - "clusterCredentials", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "publicId": { - "type": "string" - }, - "tenantPublicId": { - "type": "string" - }, - "region": { - "type": "string" - }, - "vpcId": { - "type": "string" - }, - "clusterAddress": { - "type": "string" - }, - "clusterCredentials": { - "$ref": "#/components/schemas/ClusterCredentials" - }, - "resourceGroup": { - "type": "string" - }, - "providerAccount": { - "type": "string" - }, - "cloudProviderAccount": { - "type": "string" - }, - "nssAccountId": { - "type": "string" - }, - "isDirectMarketplace": { - "type": "object" - } - } - }, - "ClusterCredentials": { - "required": [ - "id", - "password" - ], - "type": "object", - "properties": { - "userName": { - "type": "string" - }, - "password": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int32" - }, - "publicId": { - "type": "string" - } - } - }, - "RecoverAzureHARequest": { - "required": [ - "clusterCredentials", - "region" - ], - "type": "object", - "properties": { - "region": { - "type": "string" - }, - "resourceGroupName": { - "type": "string" - }, - "clusterCredentials": { - "$ref": "#/components/schemas/ClusterCredentialsRequest" - }, - "tenantId": { - "type": "string" - }, - "providerAccount": { - "type": "string" - }, - "cloudProviderAccount": { - "type": "string" - }, - "nssAccountId": { - "type": "string" - } - } - }, - "DiscoveredAzureHaResponse": { - "required": [ - "name", - "recoverable" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "publicId": { - "type": "string" - }, - "region": { - "type": "string" - }, - "vnetName": { - "type": "string" - }, - "vnetId": { - "type": "string" - }, - "subnetId": { - "type": "string" - }, - "subnetName": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "clusterAddress": { - "type": "string" - }, - "recoverable": { - "type": "boolean" - }, - "byol": { - "type": "boolean" - }, - "registered": { - "type": "boolean" - }, - "isDirectMarketplace": { - "type": "boolean" - } - } - }, - "SeqDiscoveredAzureHaResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DiscoveredAzureHaResponse" - } - }, - "Configuration": { - "required": [ - "features", - "license", - "ontapVersion", - "region", - "upgradeableFrom" - ], - "type": "object", - "properties": { - "ontapVersion": { - "type": "string" - }, - "license": { - "$ref": "#/components/schemas/OntapLicenseType" - }, - "instanceType": { - "type": "string" - }, - "region": { - "$ref": "#/components/schemas/Region" - }, - "defaultInstance": { - "type": "boolean" - }, - "features": { - "uniqueItems": true, - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "upgradeableFrom": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "ListConfiguration": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Configuration" - } - }, - "ListString": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "Region": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "code": { - "type": "string" - }, - "location": { - "type": "string" - }, - "s3Region": { - "type": "string" - } - } - }, - "SetString": { - "uniqueItems": true, - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "AzureNetworkRequirementsResponse": { - "required": [ - "vsaMinimumRequiredIps" - ], - "type": "object", - "properties": { - "vsaMinimumRequiredIps": { - "type": "integer", - "format": "int32" - }, - "haVsaMinimumRequiredIps": { - "type": "integer", - "format": "int32" - } - } - }, - "AzureValidateSubscribedToOntapCloudResponse": { - "required": [ - "isSubscribed" - ], - "type": "object", - "properties": { - "failureInfo": { - "type": "string" - }, - "isSubscribed": { - "type": "boolean" - } - } - }, - "AzureValidateSubscribedToOntapCloudRequest": { - "required": [ - "region", - "vsaMetadata" - ], - "type": "object", - "properties": { - "region": { - "type": "string" - }, - "vsaMetadata": { - "$ref": "#/components/schemas/VsaMetadataRequest" - }, - "subscriptionId": { - "type": "string" - }, - "cloudProviderAccount": { - "type": "string" - } - } - }, - "VsaMetadataRequest": { - "required": [ - "instanceType", - "licenseType", - "ontapVersion" - ], - "type": "object", - "properties": { - "ontapVersion": { - "type": "string" - }, - "licenseType": { - "type": "string" - }, - "instanceType": { - "type": "string" - }, - "platformSerialNumber": { - "type": "string" - }, - "providedLicense": { - "type": "string" - }, - "capacityPackageName": { - "type": "string" - }, - "keyStoneSubscription": { - "type": "string" - }, - "useLatestVersion": { - "type": "boolean" - } - } - }, - "CreateBlobContainerRequest": { - "required": [ - "resourceGroupName" - ], - "type": "object", - "properties": { - "subscriptionId": { - "type": "string" - }, - "cloudProviderAccountId": { - "type": "string" - }, - "resourceGroupName": { - "type": "string" - }, - "storageAccountName": { - "type": "string" - }, - "containerName": { - "type": "string" - } - } - }, - "AzureAvailabilityZoneResponse": { - "required": [ - "region", - "zones" - ], - "type": "object", - "properties": { - "region": { - "type": "string" - }, - "zones": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "object" - } - } - } - }, - "AzureNetworkExtendedResponse": { - "type": "object", - "properties": { - "virtualNetworks": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureVirtualNetworkResponse" - } - }, - "securityGroups": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureSecurityGroupResponse" - } - } - } - }, - "AzureSecurityGroupResponse": { - "required": [ - "id", - "name" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - } - } - }, - "AzureSubnetResponse": { - "required": [ - "availableIps", - "id", - "minimumRequiredIps", - "name" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "cidr": { - "type": "string" - }, - "name": { - "type": "string" - }, - "availableIps": { - "type": "integer", - "format": "int32" - }, - "minimumRequiredIps": { - "type": "integer", - "format": "int32" - } - } - }, - "AzureVirtualNetworkCidrData": { - "required": [ - "cidr", - "subnets" - ], - "type": "object", - "properties": { - "cidr": { - "type": "string" - }, - "subnets": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureSubnetResponse" - } - } - } - }, - "AzureVirtualNetworkResponse": { - "required": [ - "cidrs", - "id", - "name", - "resourceGroup", - "tags" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - }, - "cidrs": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureVirtualNetworkCidrData" - } - }, - "resourceGroup": { - "type": "string" - }, - "tags": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/TagResponse" - } - } - } - }, - "SeqAzureSecurityGroupResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureSecurityGroupResponse" - } - }, - "SeqAzureSubnetResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureSubnetResponse" - } - }, - "SeqAzureVirtualNetworkCidrData": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureVirtualNetworkCidrData" - } - }, - "SeqAzureVirtualNetworkResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureVirtualNetworkResponse" - } - }, - "SeqTagResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/TagResponse" - } - }, - "TagResponse": { - "required": [ - "key", - "value" - ], - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" - } - } - }, - "AzureKeyVault": { - "required": [ - "location", - "name", - "resourceGroup", - "vaultUri" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "location": { - "type": "string" - }, - "vaultUri": { - "type": "string" - } - } - }, - "SeqAzureKeyVault": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureKeyVault" - } - }, - "AzureKey": { - "required": [ - "keyName", - "kid" - ], - "type": "object", - "properties": { - "keyName": { - "type": "string" - }, - "kid": { - "type": "string" - } - } - }, - "SeqAzureKey": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureKey" - } - }, - "AzureResourceGroupByRegionResponse": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - } - } - }, - "SeqAzureResourceGroupByRegionResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureResourceGroupByRegionResponse" - } - }, - "AzureDiskSize": { - "required": [ - "size" - ], - "type": "object", - "properties": { - "size": { - "$ref": "#/components/schemas/Capacity" - }, - "description": { - "type": "string" - }, - "supportedOccmLicenses": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "isDefault": { - "type": "boolean" - } - } - }, - "AzureStorageAccountTypeResponse": { - "required": [ - "availabilityTypes", - "diskType", - "sizes" - ], - "type": "object", - "properties": { - "diskType": { - "type": "string" - }, - "availabilityTypes": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "sizes": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureDiskSize" - } - } - } - }, - "SeqAzureDiskSize": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureDiskSize" - } - }, - "SeqAzureStorageAccountTypeResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureStorageAccountTypeResponse" - } - }, - "SeqTagKeyResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/TagKeyResponse" - } - }, - "TagKeyResponse": { - "required": [ - "key", - "values" - ], - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "values": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "AzureBlobContainer": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "SeqAzureBlobContainer": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureBlobContainer" - } - }, - "AzureRegionResponse": { - "required": [ - "displayName" - ], - "type": "object", - "properties": { - "displayName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "vnets": { - "$ref": "#/components/schemas/AzureNetworkExtendedResponse" - }, - "supportsZonesAndPssdV2": { - "type": "object" - } - } - }, - "SeqAzureRegionResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureRegionResponse" - } - }, - "Expand": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - }, - "Expands": { - "required": [ - "expands", - "raw" - ], - "type": "object", - "properties": { - "raw": { - "type": "string" - }, - "expands": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Expand" - } - } - } - }, - "SeqExpand": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Expand" - } - }, - "InstanceTypeResponse": { - "required": [ - "instanceType" - ], - "type": "object", - "properties": { - "instanceType": { - "type": "string" - } - } - }, - "InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse": { - "required": [ - "instanceTypes" - ], - "type": "object", - "properties": { - "instanceTypes": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceTypeResponse" - } - } - } - }, - "SeqInstanceTypeResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceTypeResponse" - } - }, - "SupportedFeaturesResponse": { - "required": [ - "wormSupportedVersion" - ], - "type": "object", - "properties": { - "wormSupportedVersion": { - "type": "boolean" - }, - "cbsSupportedVersion": { - "type": "boolean" - }, - "httpsStorageAccountSupportedVersion": { - "type": "boolean" - }, - "tieringWithServiceAccount": { - "type": "boolean" - }, - "s3CmkEncryptionSupportedVersion": { - "type": "boolean" - }, - "gp3SupportedVersion": { - "type": "boolean" - }, - "elasticVolumeSupportedAndEnabled": { - "type": "boolean" - }, - "wormWithComposeSupported": { - "type": "boolean" - }, - "isAzureFlashcacheSupported": { - "type": "boolean" - }, - "wormWithBackupSupported": { - "type": "boolean" - }, - "azureHaManagedDisksSupported": { - "type": "boolean" - }, - "awsLocalZones": { - "type": "boolean" - }, - "isAzureZonalSupported": { - "type": "boolean" - } - } - }, - "InstanceTypeRegionMapping": { - "type": "object", - "properties": { - "region": { - "type": "string" - }, - "instanceType": { - "type": "string" - } - } - }, - "PackageInfoResponse": { - "required": [ - "diskSize", - "instanceTypeMapping", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "description": { - "type": "string" - }, - "licenseType": { - "type": "string" - }, - "instanceTypeMapping": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceTypeRegionMapping" - } - }, - "diskType": { - "type": "string" - }, - "diskSize": { - "$ref": "#/components/schemas/Capacity" - }, - "capacityTier": { - "type": "string" - }, - "instanceTenancy": { - "type": "string" - }, - "writingSpeedState": { - "type": "string" - }, - "iops": { - "type": "object" - }, - "throughput": { - "type": "object" - } - } - }, - "SeqInstanceTypeRegionMapping": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceTypeRegionMapping" - } - }, - "SeqPackageInfoResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/PackageInfoResponse" - } - }, - "SyncAvsOnVolumeRequest": { - "required": [ - "clusterName", - "privateCloudName", - "resourceGroup" - ], - "type": "object", - "properties": { - "privateCloudName": { - "type": "string" - }, - "clusterName": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - } - } - }, - "AvsOnVolumeRequest": { - "required": [ - "clusterName", - "dataStoreName", - "privateCloudName", - "resourceGroup" - ], - "type": "object", - "properties": { - "privateCloudName": { - "type": "string" - }, - "clusterName": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "dataStoreName": { - "type": "string" - } - } - }, - "AzureAvailabilitySet": { - "type": "object", - "properties": { - "faultDomain": { - "type": "integer", - "format": "int32" - }, - "updateDomain": { - "type": "integer", - "format": "int32" - } - } - }, - "AzureDataDiskResponse": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "diskSizeGB": { - "type": "integer", - "format": "int32" - }, - "lun": { - "type": "integer", - "format": "int32" - }, - "id": { - "type": "string" - }, - "caching": { - "type": "string" - }, - "accountType": { - "type": "string" - }, - "managed": { - "type": "boolean" - }, - "encryptionSet": { - "type": "string" - } - } - }, - "AzureHaNodeInfo": { - "required": [ - "availabilitySet" - ], - "type": "object", - "properties": { - "instanceName": { - "type": "string" - }, - "instanceId": { - "type": "string" - }, - "primaryIp": { - "type": "string" - }, - "state": { - "type": "string" - }, - "serialNumber": { - "type": "string" - }, - "availabilitySet": { - "$ref": "#/components/schemas/AzureAvailabilitySet" - }, - "availabilityZone": { - "type": "object" - } - } - }, - "AzureHaProperties": { - "type": "object", - "properties": { - "loadBalancerName": { - "type": "string" - }, - "haEnabledOnLbRules": { - "type": "boolean" - }, - "node1Info": { - "$ref": "#/components/schemas/AzureHaNodeInfo" - }, - "node2Info": { - "$ref": "#/components/schemas/AzureHaNodeInfo" - }, - "multiZone": { - "type": "boolean" - }, - "applicationSecurityGroupName": { - "type": "string" - }, - "azureHaDeploymentType": { - "type": "string" - } - } - }, - "AzureProperties": { - "type": "object", - "properties": { - "regionName": { - "type": "string" - }, - "resourceGroup": { - "$ref": "#/components/schemas/AzureResourceGroupResponse" - }, - "vnetCidr": { - "type": "string" - }, - "tags": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "string" - } - }, - "subscriptionId": { - "type": "string" - }, - "deploymentId": { - "type": "string" - }, - "creationTime": { - "type": "integer", - "format": "int64" - }, - "instanceType": { - "type": "string" - }, - "numOfNics": { - "type": "integer", - "format": "int32" - }, - "singleNetworkInterface": { - "type": "boolean" - }, - "subscriptionName": { - "type": "string" - }, - "cloudProviderAccountId": { - "type": "string" - }, - "availabilityZone": { - "type": "object" - }, - "dataDisks": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureDataDiskResponse" - } - } - } - }, - "AzureResourceGroupResponse": { - "required": [ - "tags" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "type": "string" - }, - "tags": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "string" - } - } - } - }, - "AzureVsaWorkingEnvironmentResponse": { - "required": [ - "actionsRequired", - "licensesInformation", - "publicId", - "schedules", - "snapshotPolicies", - "supportRegistrationInformation", - "svms" - ], - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "creatorUserEmail": { - "type": "string" - }, - "status": { - "$ref": "#/components/schemas/StatusProperties" - }, - "providerProperties": { - "$ref": "#/components/schemas/AzureProperties" - }, - "reservedSize": { - "$ref": "#/components/schemas/Capacity" - }, - "clusterProperties": { - "$ref": "#/components/schemas/VsaClusterProperties" - }, - "ontapClusterProperties": { - "$ref": "#/components/schemas/OntapClusterProperties" - }, - "cloudProviderName": { - "type": "string" - }, - "snapshotPolicies": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicy" - } - }, - "actionsRequired": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ActionRequired" - } - }, - "activeActions": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "replicationProperties": { - "$ref": "#/components/schemas/ReplicationProperties" - }, - "schedules": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaSchedule" - } - }, - "svms": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Svm" - } - }, - "workingEnvironmentType": { - "type": "string" - }, - "supportRegistrationProperties": { - "$ref": "#/components/schemas/SupportRegistrationProperties" - }, - "supportRegistrationInformation": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SupportRegistrationInformation" - } - }, - "capacityFeatures": { - "$ref": "#/components/schemas/CapacityFeatures" - }, - "encryptionProperties": { - "$ref": "#/components/schemas/EncryptionProperties" - }, - "supportedFeatures": { - "$ref": "#/components/schemas/SupportedFeatures" - }, - "isHA": { - "type": "boolean" - }, - "haProperties": { - "$ref": "#/components/schemas/AzureHaProperties" - }, - "fpolicyProperties": { - "$ref": "#/components/schemas/FpolicyProperties" - }, - "saasProperties": { - "$ref": "#/components/schemas/CvoSaasProperties" - }, - "cbsProperties": { - "$ref": "#/components/schemas/CbsPropertiesWithReason" - }, - "complianceProperties": { - "$ref": "#/components/schemas/CloudComplianceStatusResponse" - }, - "monitoringProperties": { - "$ref": "#/components/schemas/MonitoringStatusResponse" - }, - "licensesInformation": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseInformation" - } - } - } - }, - "SeqAzureDataDiskResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureDataDiskResponse" - } - }, - "AdminUsername": { - "required": [ - "_1", - "validatesWith" - ], - "type": "object", - "properties": { - "_1": { - "type": "string" - }, - "validatesWith": { - "$ref": "#/components/schemas/PatternMessage" - } - } - }, - "AzureEncryption": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "vaultName": { - "type": "string" - }, - "userAssignedIdentity": { - "type": "string" - } - } - }, - "AzureHaParameters": { - "type": "object", - "properties": { - "platformSerialNumberNode1": { - "type": "string" - }, - "platformSerialNumberNode2": { - "type": "string" - }, - "availabilityZoneNode1": { - "type": "integer", - "format": "int32" - }, - "availabilityZoneNode2": { - "type": "integer", - "format": "int32" - }, - "enableHttps": { - "type": "boolean" - }, - "multiZone": { - "type": "boolean" - } - } - }, - "AzureTag": { - "type": "object", - "properties": { - "tagKey": { - "type": "string" - }, - "tagValue": { - "type": "string" - } - } - }, - "CIFSConfigurationRequest": { - "required": [ - "activeDirectoryDomain", - "activeDirectoryPassword", - "activeDirectoryUsername", - "ipAddresses", - "netBIOS", - "organizationalUnit" - ], - "type": "object", - "properties": { - "dnsDomain": { - "type": "string" - }, - "ipAddresses": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "netBIOS": { - "type": "string" - }, - "organizationalUnit": { - "type": "string" - }, - "activeDirectoryDomain": { - "type": "string" - }, - "activeDirectoryUsername": { - "type": "string" - }, - "activeDirectoryPassword": { - "type": "string" - }, - "svmName": { - "type": "string" - } - } - }, - "CreateAzureVSAWorkingEnvironmentRequest": { - "required": [ - "azureTags", - "dataEncryptionType", - "diskSize", - "enableCompliance", - "enableMonitoring", - "storageType", - "subnetId", - "vnetId", - "vsaMetadata" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "svmPassword": { - "type": "string" - }, - "username": { - "$ref": "#/components/schemas/AdminUsername" - }, - "vnetId": { - "type": "string" - }, - "cidr": { - "type": "string" - }, - "description": { - "type": "string" - }, - "volume": { - "$ref": "#/components/schemas/VsaVolumeOnNewVsaCreateRequest" - }, - "region": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "subnetId": { - "type": "string" - }, - "dataEncryptionType": { - "type": "string" - }, - "ontapEncryptionParameters": { - "$ref": "#/components/schemas/OntapEncryption" - }, - "securityGroupId": { - "type": "string" - }, - "openSecurityGroup": { - "type": "object" - }, - "serialNumber": { - "type": "string" - }, - "cifsConfigurationRequest": { - "$ref": "#/components/schemas/CIFSConfigurationRequest" - }, - "diskSize": { - "$ref": "#/components/schemas/Capacity" - }, - "storageType": { - "type": "string" - }, - "azureTags": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureTag" - } - }, - "writingSpeedState": { - "type": "string" - }, - "vsaMetadata": { - "$ref": "#/components/schemas/VsaMetadataRequest" - }, - "failedToCreateWorkingEnvironmentId": { - "type": "string" - }, - "packageName": { - "type": "string" - }, - "vhdImageRequest": { - "$ref": "#/components/schemas/VhdImageRequest" - }, - "resourceGroup": { - "type": "string" - }, - "subscriptionId": { - "type": "string" - }, - "capacityTier": { - "type": "string" - }, - "haParams": { - "$ref": "#/components/schemas/AzureHaParameters" - }, - "allowDeployInExistingRg": { - "type": "boolean" - }, - "svmName": { - "type": "string" - }, - "wormRequest": { - "$ref": "#/components/schemas/WormRequest" - }, - "cloudProviderAccount": { - "type": "string" - }, - "nssAccount": { - "type": "string" - }, - "saasSubscriptionId": { - "type": "string" - }, - "enableCompliance": { - "type": "boolean" - }, - "storageAccountPrefix": { - "type": "string" - }, - "backupVolumesToCbs": { - "type": "boolean" - }, - "tierLevel": { - "type": "string" - }, - "availabilityZone": { - "type": "integer", - "format": "int32" - }, - "enableMonitoring": { - "type": "boolean" - }, - "azureEncryptionParameters": { - "$ref": "#/components/schemas/AzureEncryption" - }, - "enableServices": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "storageAccountNetworkAccess": { - "type": "string" - } - } - }, - "OntapEncryption": { - "type": "object", - "properties": { - "keyManagerIds": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "keyManagerCaCertificateId": { - "type": "string" - } - } - }, - "SeqAzureTag": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureTag" - } - }, - "VhdImageRequest": { - "type": "object", - "properties": { - "blobUrl": { - "type": "string" - } - } - }, - "VsaVolumeOnNewVsaCreateRequest": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "size": { - "$ref": "#/components/schemas/PositiveCapacity" - }, - "initialSize": { - "$ref": "#/components/schemas/Capacity" - }, - "snapshotPolicyName": { - "type": "string" - }, - "exportPolicyInfo": { - "$ref": "#/components/schemas/ExportPolicyInfo" - }, - "shareInfo": { - "$ref": "#/components/schemas/CreateCifsShareInfoRequest" - }, - "iscsiInfo": { - "$ref": "#/components/schemas/CreateIscsiInfoRequest" - }, - "enableThinProvisioning": { - "type": "boolean" - }, - "enableCompression": { - "type": "boolean" - }, - "enableDeduplication": { - "type": "boolean" - }, - "tieringPolicy": { - "type": "string" - }, - "junctionPath": { - "type": "string" - }, - "qualityOfService": { - "$ref": "#/components/schemas/VolumeQualityOfService" - } - } - }, - "WormRequest": { - "required": [ - "retentionPeriod" - ], - "type": "object", - "properties": { - "retentionPeriod": { - "$ref": "#/components/schemas/WormRetentionPeriod" - } - } - }, - "WormRetentionPeriod": { - "required": [ - "length", - "unit" - ], - "type": "object", - "properties": { - "length": { - "type": "integer", - "format": "int32" - }, - "unit": { - "type": "string" - } - } - }, - "AzureSvmPassword": { - "required": [ - "_1", - "validatesWith" - ], - "type": "object", - "properties": { - "_1": { - "type": "string" - }, - "validatesWith": { - "$ref": "#/components/schemas/PatternMessage" - } - } - }, - "CreateAzureSvmRequest": { - "required": [ - "mgmtLif" - ], - "type": "object", - "properties": { - "svmName": { - "type": "string" - }, - "svmPassword": { - "$ref": "#/components/schemas/AzureSvmPassword" - }, - "mgmtLif": { - "type": "boolean" - }, - "rootVolumeAggregate": { - "type": "string" - } - } - }, - "AvsPrivateCloudCluster": { - "required": [ - "id", - "properties", - "tags" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "tags": { - "required": [ - "traversableAgain" - ], - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/components/schemas/AvsPrivateCloudClusterProperties" - } - } - }, - "AvsPrivateCloudClusterProperties": { - "required": [ - "hosts" - ], - "type": "object", - "properties": { - "clusterId": { - "type": "string" - }, - "clusterSize": { - "type": "string" - }, - "provisioningState": { - "type": "string" - }, - "vsanDatastoreName": { - "type": "string" - }, - "hosts": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "SeqAvsPrivateCloudCluster": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AvsPrivateCloudCluster" - } - }, - "AvsPrivateCloudClusterHost": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "SeqAvsPrivateCloudClusterHost": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AvsPrivateCloudClusterHost" - } - }, - "AvailableIpsResponse": { - "required": [ - "availableIps" - ], - "type": "object", - "properties": { - "availableIps": { - "type": "integer", - "format": "int32" - } - } - }, - "AvsPrivateCloud": { - "required": [ - "id", - "properties", - "tags", - "zones" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "location": { - "type": "string" - }, - "zones": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "tags": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/components/schemas/AvsPrivateCloudProperties" - } - } - }, - "AvsPrivateCloudEndpoints": { - "type": "object", - "properties": { - "vcenterIp": { - "type": "string" - } - } - }, - "AvsPrivateCloudManagCluster": { - "type": "object", - "properties": { - "clusterId": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "clusterSize": { - "type": "string" - }, - "provisioningState": { - "type": "string" - }, - "vsanDatastoreName": { - "type": "string" - } - } - }, - "AvsPrivateCloudProperties": { - "required": [ - "endpoints", - "managementCluster" - ], - "type": "object", - "properties": { - "provisioningState": { - "type": "string" - }, - "endpoints": { - "$ref": "#/components/schemas/AvsPrivateCloudEndpoints" - }, - "managementCluster": { - "$ref": "#/components/schemas/AvsPrivateCloudManagCluster" - } - } - }, - "SeqAvsPrivateCloud": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AvsPrivateCloud" - } - }, - "SeqAzureVsaWorkingEnvironmentResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureVsaWorkingEnvironmentResponse" - } - }, - "CIFSDeleteRequest": { - "type": "object", - "properties": { - "activeDirectoryUsername": { - "type": "string" - }, - "activeDirectoryPassword": { - "type": "string" - }, - "svmName": { - "type": "string" - } - } - }, - "CapacityLicenseInfo": { - "required": [ - "totalLicensedCapacity" - ], - "type": "object", - "properties": { - "flavorType": { - "type": "string" - }, - "contractType": { - "type": "string" - }, - "totalLicensedCapacity": { - "$ref": "#/components/schemas/TotalCapacity" - }, - "totalConsumedCapacity": { - "$ref": "#/components/schemas/TotalCapacity" - } - } - }, - "CloudAccountResponse": { - "required": [ - "cloudAccountId" - ], - "type": "object", - "properties": { - "cloudAccountId": { - "type": "string" - }, - "provider": { - "type": "string" - }, - "subscriptionId": { - "type": "string" - } - } - }, - "PreValidationResponse": { - "required": [ - "capacityLicenses", - "mpSub", - "totalPrimaryVolumes", - "validAccount" - ], - "type": "object", - "properties": { - "validAccount": { - "type": "boolean" - }, - "validNss": { - "type": "boolean" - }, - "mpSub": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudAccountResponse" - } - }, - "capacityLicenses": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CapacityLicenseInfo" - } - }, - "totalPrimaryVolumes": { - "$ref": "#/components/schemas/Capacity" - }, - "totalDpVolumes": { - "$ref": "#/components/schemas/Capacity" - }, - "vmPlan": { - "type": "string" - }, - "awsOldDeployment": { - "type": "boolean" - } - } - }, - "SeqCapacityLicenseInfo": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CapacityLicenseInfo" - } - }, - "SeqCloudAccountResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudAccountResponse" - } - }, - "TotalCapacity": { - "required": [ - "capacity" - ], - "type": "object", - "properties": { - "capacity": { - "type": "integer", - "format": "int64" - }, - "units": { - "type": "string" - } - } - }, - "WritingSpeedRequest": { - "type": "object", - "properties": { - "writingSpeedState": { - "type": "string" - } - } - }, - "LicenseAndInstanceTypeModificationRequest": { - "required": [ - "instanceType", - "licenseType" - ], - "type": "object", - "properties": { - "instanceType": { - "type": "string" - }, - "licenseType": { - "type": "string" - } - } - }, - "SeqUpdateLocalImage": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/UpdateLocalImage" - } - }, - "UpdateLocalImage": { - "required": [ - "isCurrent", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - }, - "isCurrent": { - "type": "boolean" - } - } - }, - "UpdateSystemImageRequest": { - "required": [ - "updateParameter", - "updateType" - ], - "type": "object", - "properties": { - "updateType": { - "type": "string" - }, - "updateParameter": { - "type": "string" - } - } - }, - "EligibilityResponse": { - "required": [ - "eligibilityResponse" - ], - "type": "object", - "properties": { - "eligibilityResponse": { - "type": "string" - } - } - }, - "InputPart": { - "required": [ - "bodyAsString", - "headers", - "mediaType" - ], - "type": "object", - "properties": { - "bodyAsString": { - "type": "string" - }, - "mediaType": { - "required": [ - "parameters", - "wildcardSubtype" - ], - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "subtype": { - "type": "string" - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "wildcardSubtype": { - "type": "boolean" - }, - "wildcardType": { - "type": "boolean" - } - } - }, - "contentTypeFromMessage": { - "type": "boolean" - }, - "headers": { - "type": "object", - "properties": { - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "MultipartFormDataInput": { - "required": [ - "formData", - "formDataMap", - "parts" - ], - "type": "object", - "properties": { - "formData": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/InputPart" - } - }, - "formDataMap": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InputPart" - } - } - }, - "parts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InputPart" - } - }, - "preamble": { - "type": "string" - } - } - }, - "LicenseFileContent": { - "required": [ - "licenseOne" - ], - "type": "object", - "properties": { - "licenseOne": { - "type": "string" - }, - "licenseTwo": { - "type": "string" - } - } - }, - "ChangeNetworkOptimizationRequest": { - "required": [ - "optimize" - ], - "type": "object", - "properties": { - "optimize": { - "type": "boolean" - } - } - }, - "CreateRequestParametersResponse": { - "required": [ - "parameters" - ], - "type": "object", - "properties": { - "parameters": { - "$ref": "#/components/schemas/MapStringObject" - } - } - }, - "MapStringObject": { - "required": [ - "traversableAgain" - ], - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "object" - } - }, - "EnableCapacityTieringRequest": { - "type": "object", - "properties": { - "instanceProfileName": { - "type": "string" - }, - "gcpStorageAccountId": { - "type": "string" - }, - "storageAccountPrefix": { - "type": "string" - } - } - }, - "CostByService": { - "required": [ - "costByUsage", - "name", - "total" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "total": { - "$ref": "#/components/schemas/Money" - }, - "costByUsage": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CostByUsage" - } - } - } - }, - "CostByTime": { - "required": [ - "costByService", - "end", - "estimated", - "start", - "total" - ], - "type": "object", - "properties": { - "start": { - "type": "string" - }, - "end": { - "type": "string" - }, - "estimated": { - "type": "boolean" - }, - "total": { - "$ref": "#/components/schemas/Money" - }, - "costByService": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CostByService" - } - } - } - }, - "CostByUsage": { - "required": [ - "cost", - "name", - "usage" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "cost": { - "$ref": "#/components/schemas/Money" - }, - "usage": { - "$ref": "#/components/schemas/Usage" - } - } - }, - "Money": { - "required": [ - "amount", - "currency" - ], - "type": "object", - "properties": { - "amount": { - "type": "number", - "format": "double" - }, - "currency": { - "type": "string" - } - } - }, - "SeqCostByService": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CostByService" - } - }, - "SeqCostByTime": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CostByTime" - } - }, - "SeqCostByUsage": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CostByUsage" - } - }, - "Usage": { - "required": [ - "units" - ], - "type": "object", - "properties": { - "amount": { - "type": "number", - "format": "double" - }, - "units": { - "type": "string" - } - } - }, - "WorkingEnvironmentCostAndUsageResponse": { - "required": [ - "costByTime", - "hasPermissions" - ], - "type": "object", - "properties": { - "hasPermissions": { - "type": "boolean" - }, - "costByTime": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CostByTime" - } - } - } - }, - "SavingsInfo": { - "required": [ - "monthlySaving", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "monthlySaving": { - "$ref": "#/components/schemas/Money" - } - } - }, - "SeqSavingsInfo": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SavingsInfo" - } - }, - "WorkingEnvironmentOntapSavingResponse": { - "required": [ - "savings" - ], - "type": "object", - "properties": { - "savings": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SavingsInfo" - } - } - } - }, - "GetLicenseResponse": { - "required": [ - "capacity", - "expirationDate", - "serialNumber" - ], - "type": "object", - "properties": { - "serialNumber": { - "type": "string" - }, - "resourceId": { - "type": "string" - }, - "licenseType": { - "type": "string" - }, - "expirationDate": { - "type": "integer", - "format": "int64" - }, - "license": { - "type": "string" - }, - "capacity": { - "type": "number", - "format": "double" - }, - "metadata": { - "type": "string" - }, - "associatedResourceId": { - "type": "string" - }, - "licensePackage": { - "type": "string" - } - } - }, - "ListGetLicenseResponse": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GetLicenseResponse" - } - }, - "LicensesSerials": { - "required": [ - "serials" - ], - "type": "object", - "properties": { - "serials": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "LicensesContent": { - "required": [ - "licences" - ], - "type": "object", - "properties": { - "licences": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "VscanFileOpRequest": { - "type": "object", - "properties": { - "vscanFileOp": { - "type": "string" - } - } - }, - "InstanceTypeInfo": { - "required": [ - "supportedFeatures", - "supportsEncryption" - ], - "type": "object", - "properties": { - "instanceType": { - "type": "string" - }, - "supportsEncryption": { - "type": "boolean" - }, - "supportedFeatures": { - "uniqueItems": true, - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "isDefault": { - "type": "boolean" - } - } - }, - "LicenseAndInstanceType": { - "required": [ - "capacityLimit", - "instanceTypes", - "licenseType" - ], - "type": "object", - "properties": { - "licenseType": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "capacityLimit": { - "$ref": "#/components/schemas/Capacity" - }, - "instanceTypes": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceTypeInfo" - } - } - } - }, - "SeqInstanceTypeInfo": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceTypeInfo" - } - }, - "SeqLicenseAndInstanceType": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseAndInstanceType" - } - }, - "CIFSConfigurationResponse": { - "required": [ - "activeDirectoryDomain", - "authenticationType", - "dnsDomain", - "ipAddresses", - "netBIOS", - "organizationalUnit" - ], - "type": "object", - "properties": { - "dnsDomain": { - "type": "string" - }, - "activeDirectoryDomain": { - "type": "string" - }, - "ipAddresses": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "netBIOS": { - "type": "string" - }, - "organizationalUnit": { - "type": "string" - }, - "authenticationType": { - "type": "string" - } - } - }, - "SeqCIFSConfigurationResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CIFSConfigurationResponse" - } - }, - "CloudResourceTag": { - "required": [ - "tagKey" - ], - "type": "object", - "properties": { - "tagKey": { - "type": "string" - }, - "tagValue": { - "type": "string" - } - } - }, - "ModifyUserTagsRequest": { - "required": [ - "tags" - ], - "type": "object", - "properties": { - "tags": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudResourceTag" - } - } - } - }, - "SeqCloudResourceTag": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudResourceTag" - } - }, - "UserTagsResponse": { - "required": [ - "tags" - ], - "type": "object", - "properties": { - "tags": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudResourceTag" - } - } - } - }, - "ProvidedLicenseResponse": { - "required": [ - "license" - ], - "type": "object", - "properties": { - "license": { - "type": "string" - }, - "serialNumber": { - "type": "string" - }, - "contractEndDate": { - "type": "object" - } - } - }, - "UpdateCredentialsRequest": { - "required": [ - "password" - ], - "type": "object", - "properties": { - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "ChangeTierLevelRequest": { - "required": [ - "level" - ], - "type": "object", - "properties": { - "level": { - "type": "string" - } - } - }, - "RegisterCvoResponse": { - "required": [ - "serial1" - ], - "type": "object", - "properties": { - "serial1": { - "type": "string" - }, - "serial2": { - "type": "string" - } - } - }, - "LicenseConversionRequest": { - "required": [ - "capacityPackageName", - "sendAsup" - ], - "type": "object", - "properties": { - "capacityPackageName": { - "type": "string" - }, - "sendAsup": { - "type": "boolean" - }, - "deleteByNodeByolLicense": { - "type": "boolean" - } - } - }, - "NTPConfigurationRequest": { - "required": [ - "ntpServer" - ], - "type": "object", - "properties": { - "ntpServer": { - "type": "string" - } - } - }, - "SupportRegistrationResponse": { - "required": [ - "status" - ], - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "licenseExpiryDate": { - "type": "object" - }, - "licenseStartDate": { - "type": "object" - }, - "nssAccountId": { - "type": "string" - } - } - }, - "VsaSchedulesRequest": { - "required": [ - "schedules" - ], - "type": "object", - "properties": { - "schedules": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaSchedule" - } - } - } - }, - "SvmNameModificationRequest": { - "type": "object", - "properties": { - "svmNewName": { - "type": "string" - }, - "svmName": { - "type": "string" - } - } - }, - "SeqSnapshotPolicyScheduleRequest": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicyScheduleRequest" - } - }, - "SnapshotPolicyCreateRequest": { - "required": [ - "schedules" - ], - "type": "object", - "properties": { - "snapshotPolicyName": { - "type": "string" - }, - "schedules": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicyScheduleRequest" - } - } - } - }, - "SnapshotPolicyScheduleRequest": { - "required": [ - "retention", - "scheduleType" - ], - "type": "object", - "properties": { - "scheduleType": { - "type": "string" - }, - "retention": { - "type": "integer", - "format": "int32" - } - } - }, - "ChangeSerialNumberRequest": { - "required": [ - "nodeOne" - ], - "type": "object", - "properties": { - "nodeOne": { - "type": "string" - }, - "nodeTwo": { - "type": "string" - } - } - }, - "PasswordWrapper": { - "type": "object", - "properties": { - "password": { - "type": "string" - } - } - }, - "CreateCloudComplianceByWesRequest": { - "required": [ - "workingEnvironmentIds" - ], - "type": "object", - "properties": { - "workingEnvironmentIds": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "enableAnf": { - "type": "boolean" - } - } - }, - "CloudComplianceInfoResponse": { - "required": [ - "healthy", - "status" - ], - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "widgetUrl": { - "type": "string" - }, - "privateIp": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "lastDeploymentError": { - "type": "string" - }, - "containerActive": { - "type": "boolean" - } - } - }, - "EnableServiceScanRequest": { - "type": "object", - "properties": { - "instanceProfileName": { - "type": "string" - } - } - }, - "InstallCertificatesRequest": { - "required": [ - "occmCertificate" - ], - "type": "object", - "properties": { - "occmCertificate": { - "type": "string" - } - } - }, - "CsrResponse": { - "required": [ - "csr" - ], - "type": "object", - "properties": { - "csr": { - "type": "string" - } - } - }, - "KeyManagerCaCertificateRequest": { - "required": [ - "certificate" - ], - "type": "object", - "properties": { - "certificate": { - "type": "string" - } - } - }, - "KeyManagerRequest": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "address": { - "type": "string" - }, - "usernameField": { - "$ref": "#/components/schemas/NonEmptyOptionalString" - }, - "usernameValue": { - "$ref": "#/components/schemas/NonEmptyOptionalString" - } - } - }, - "NonEmptyOptionalString": { - "type": "object", - "properties": { - "_1": { - "type": "string" - } - } - }, - "SeqWeActionRequiredResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/WeActionRequiredResponse" - } - }, - "TenantActionsRequiredResponse": { - "required": [ - "weActions" - ], - "type": "object", - "properties": { - "weActions": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/WeActionRequiredResponse" - } - } - } - }, - "WeActionRequiredResponse": { - "required": [ - "actions", - "publicId" - ], - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "actions": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ActionRequired" - } - } - } - }, - "AwsHaProperties": { - "type": "object", - "properties": { - "mediatorVersionInfo": { - "$ref": "#/components/schemas/MediatorVersionInfo" - }, - "mediatorStatus": { - "$ref": "#/components/schemas/MediatorStatus" - }, - "routeTables": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "mediatorVersionsToUpdate": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/MediatorUpdateVersionMetadata" - } - }, - "failoverMode": { - "type": "string" - } - } - }, - "AwsProperties": { - "type": "object", - "properties": { - "regionName": { - "type": "string" - }, - "availabilityZones": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "instances": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceResponse" - } - }, - "vpc": { - "$ref": "#/components/schemas/VpcBasicResponse" - }, - "accountId": { - "type": "string" - }, - "roleArn": { - "type": "string" - }, - "cloudProviderAccountId": { - "type": "string" - }, - "bootDiskSize": { - "type": "object" - }, - "outpostArn": { - "type": "string" - }, - "coreDiskExists": { - "type": "object" - } - } - }, - "CloudSyncProperties": { - "type": "object", - "properties": { - "isSynced": { - "type": "boolean" - }, - "status": { - "$ref": "#/components/schemas/CloudSyncStatus" - }, - "dataBrokerProperties": { - "$ref": "#/components/schemas/DataBrokerProperties" - }, - "s3Location": { - "type": "string" - }, - "relationships": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudSyncRelationship" - } - } - } - }, - "CloudSyncRelationship": { - "type": "object", - "properties": { - "volumeName": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "relationshipStatus": { - "type": "string" - }, - "s3Location": { - "type": "string" - }, - "id": { - "type": "string" - }, - "progress": { - "type": "integer", - "format": "int32" - }, - "failureMessage": { - "type": "string" - } - } - }, - "CloudSyncStatus": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "failureMessage": { - "type": "string" - } - } - }, - "CronJobSchedule": { - "required": [ - "months" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "months": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "days": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "weekDays": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "hours": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "minutes": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "DataBrokerPlacement": { - "type": "object", - "properties": { - "vpcId": { - "type": "string" - }, - "subnetId": { - "type": "string" - }, - "instanceType": { - "type": "string" - }, - "instanceId": { - "type": "string" - }, - "keyPair": { - "type": "string" - } - } - }, - "DataBrokerProperties": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "dataBrokerPlacement": { - "$ref": "#/components/schemas/DataBrokerPlacement" - } - } - }, - "ExtendedObjectStoreConfigInfo": { - "type": "object", - "properties": { - "objectStoreConfig": { - "$ref": "#/components/schemas/ObjectStoreConfigInfo" - }, - "tierLevel": { - "type": "string" - } - } - }, - "InstanceResponse": { - "required": [ - "availabilityZone", - "id", - "imageId", - "instanceType", - "isOCCMInstance", - "isVsaInstance", - "keyPairName", - "name", - "placementGroup", - "privateDnsName", - "privateIpAddress", - "productCode", - "publicDnsName", - "publicIpAddress", - "state", - "subnetId", - "tags", - "tenancy" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "instanceType": { - "type": "string" - }, - "state": { - "type": "string" - }, - "publicIpAddress": { - "type": "string" - }, - "privateIpAddress": { - "type": "string" - }, - "publicDnsName": { - "type": "string" - }, - "privateDnsName": { - "type": "string" - }, - "imageId": { - "type": "string" - }, - "subnetId": { - "type": "string" - }, - "availabilityZone": { - "type": "string" - }, - "isVsaInstance": { - "type": "boolean" - }, - "isOCCMInstance": { - "type": "boolean" - }, - "tags": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "string" - } - }, - "productCode": { - "type": "string" - }, - "tenancy": { - "type": "string" - }, - "placementGroup": { - "type": "string" - }, - "keyPairName": { - "type": "string" - }, - "instanceProfileId": { - "type": "string" - } - } - }, - "InterClusterLif": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "address": { - "type": "string" - }, - "port": { - "type": "string" - }, - "node": { - "type": "string" - }, - "status": { - "type": "string" - }, - "isPeered": { - "type": "boolean" - } - } - }, - "MediatorStatus": { - "type": "object", - "properties": { - "statusCode": { - "type": "integer", - "format": "int32" - }, - "statusMessage": { - "type": "string" - } - } - }, - "MediatorUpdateVersionMetadata": { - "type": "object", - "properties": { - "mediatorVersion": { - "type": "string" - }, - "timeStamp": { - "type": "integer", - "format": "int64" - }, - "metadataFileName": { - "type": "string" - }, - "major": { - "type": "boolean" - }, - "manifestFileName": { - "type": "string" - } - } - }, - "MediatorVersionInfo": { - "required": [ - "state" - ], - "type": "object", - "properties": { - "version": { - "type": "string" - }, - "description": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "update_in_progress", - "release_mismatch", - "not_found", - "update_meta_url_not_set", - "repository_error", - "waiting_reboot", - "waiting_service_restart", - "install_failed", - "downloaded", - "update_available", - "up_to_date", - "update_url_failed_connect", - "undefined" - ] - }, - "bootVolumeId": { - "type": "string" - } - } - }, - "ObjectStoreConfigInfo": { - "type": "object", - "properties": { - "objectStoreName": { - "type": "string" - }, - "s3Name": { - "type": "string" - }, - "usedSpace": { - "$ref": "#/components/schemas/Capacity" - }, - "server": { - "type": "string" - }, - "providerType": { - "type": "string" - } - } - }, - "OnPremCapacityFeatures": { - "type": "object", - "properties": { - "objectStoreConfigExtended": { - "$ref": "#/components/schemas/ExtendedObjectStoreConfigInfo" - }, - "performanceTierUsedCapacity": { - "$ref": "#/components/schemas/Capacity" - }, - "inactiveUserData": { - "$ref": "#/components/schemas/Capacity" - }, - "rawCapacity": { - "$ref": "#/components/schemas/Capacity" - }, - "fiveYearSavings": { - "type": "number", - "format": "double" - } - } - }, - "OnPremClusterProperties": { - "type": "object", - "properties": { - "clusterAddress": { - "type": "string" - }, - "ontapVersion": { - "type": "string" - }, - "clusterName": { - "type": "string" - }, - "serialNumber": { - "type": "string" - }, - "systemId": { - "type": "string" - }, - "isSnapmirrorLicenseExists": { - "type": "boolean" - }, - "licenses": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "systemManagerUrl": { - "type": "string" - }, - "location": { - "$ref": "#/components/schemas/Value" - }, - "clusterUuid": { - "type": "string" - }, - "nodeModels": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "lifs": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LifResponse" - } - }, - "isAff": { - "type": "boolean" - }, - "aggregateCount": { - "type": "integer", - "format": "int32" - }, - "volumeCount": { - "type": "integer", - "format": "int32" - }, - "sanOptimized": { - "type": "boolean" - }, - "disaggregated": { - "type": "boolean" - } - } - }, - "OnPremWorkingEnvironmentResponse": { - "required": [ - "actionsRequired", - "cronJobSchedules", - "interClusterLifs", - "publicId", - "snapshotPolicies", - "svms" - ], - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "description": { - "type": "string" - }, - "name": { - "type": "string" - }, - "discoverUserEmail": { - "type": "string" - }, - "location": { - "type": "string" - }, - "reservedSize": { - "$ref": "#/components/schemas/Capacity" - }, - "status": { - "$ref": "#/components/schemas/StatusProperties" - }, - "interClusterLifs": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InterClusterLif" - } - }, - "cronJobSchedules": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CronJobSchedule" - } - }, - "svms": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Svm" - } - }, - "snapshotPolicies": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicy" - } - }, - "replicationProperties": { - "$ref": "#/components/schemas/ReplicationProperties" - }, - "clusterProperties": { - "$ref": "#/components/schemas/OnPremClusterProperties" - }, - "ontapClusterProperties": { - "$ref": "#/components/schemas/OnPremClusterProperties" - }, - "workingEnvironmentType": { - "type": "string" - }, - "cloudSyncProperties": { - "$ref": "#/components/schemas/CloudSyncProperties" - }, - "actionsRequired": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ActionRequired" - } - }, - "capacityFeatures": { - "$ref": "#/components/schemas/OnPremCapacityFeatures" - }, - "aff": { - "type": "boolean" - }, - "cbsProperties": { - "$ref": "#/components/schemas/CbsPropertiesWithReason" - }, - "complianceProperties": { - "$ref": "#/components/schemas/CloudComplianceStatusResponse" - }, - "monitoringProperties": { - "$ref": "#/components/schemas/MonitoringStatusResponse" - } - } - }, - "SeqCloudSyncRelationship": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudSyncRelationship" - } - }, - "SeqCronJobSchedule": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CronJobSchedule" - } - }, - "SeqGcpVsaWorkingEnvironmentResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpVsaWorkingEnvironmentResponse" - } - }, - "SeqInstanceResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceResponse" - } - }, - "SeqInteger": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "SeqInterClusterLif": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InterClusterLif" - } - }, - "SeqMediatorUpdateVersionMetadata": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/MediatorUpdateVersionMetadata" - } - }, - "SeqOnPremWorkingEnvironmentResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OnPremWorkingEnvironmentResponse" - } - }, - "SeqVpcTagResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VpcTagResponse" - } - }, - "SeqVsaWorkingEnvironmentResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaWorkingEnvironmentResponse" - } - }, - "VpcBasicResponse": { - "required": [ - "cidrBlock", - "default", - "state", - "tags", - "vpcId" - ], - "type": "object", - "properties": { - "vpcId": { - "type": "string" - }, - "state": { - "type": "string" - }, - "cidrBlock": { - "type": "string" - }, - "tags": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VpcTagResponse" - } - }, - "default": { - "type": "boolean" - } - } - }, - "VpcTagResponse": { - "required": [ - "key", - "value" - ], - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" - } - } - }, - "VsaWorkingEnvironmentResponse": { - "required": [ - "actionsRequired", - "cronJobSchedules", - "interClusterLifs", - "isHA", - "licensesInformation", - "publicId", - "schedules", - "snapshotPolicies", - "supportRegistrationInformation", - "svms" - ], - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "creatorUserEmail": { - "type": "string" - }, - "status": { - "$ref": "#/components/schemas/StatusProperties" - }, - "awsProperties": { - "$ref": "#/components/schemas/AwsProperties" - }, - "reservedSize": { - "$ref": "#/components/schemas/Capacity" - }, - "encryptionProperties": { - "$ref": "#/components/schemas/EncryptionProperties" - }, - "clusterProperties": { - "$ref": "#/components/schemas/VsaClusterProperties" - }, - "ontapClusterProperties": { - "$ref": "#/components/schemas/OntapClusterProperties" - }, - "actionsRequired": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ActionRequired" - } - }, - "interClusterLifs": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InterClusterLif" - } - }, - "cronJobSchedules": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CronJobSchedule" - } - }, - "snapshotPolicies": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapshotPolicy" - } - }, - "svms": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Svm" - } - }, - "activeActions": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "replicationProperties": { - "$ref": "#/components/schemas/ReplicationProperties" - }, - "schedules": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaSchedule" - } - }, - "cloudProviderName": { - "type": "string" - }, - "isHA": { - "type": "boolean" - }, - "workingEnvironmentType": { - "type": "string" - }, - "supportRegistrationProperties": { - "$ref": "#/components/schemas/SupportRegistrationProperties" - }, - "supportRegistrationInformation": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SupportRegistrationInformation" - } - }, - "haProperties": { - "$ref": "#/components/schemas/AwsHaProperties" - }, - "capacityFeatures": { - "$ref": "#/components/schemas/CapacityFeatures" - }, - "cloudSyncProperties": { - "$ref": "#/components/schemas/CloudSyncProperties" - }, - "supportedFeatures": { - "$ref": "#/components/schemas/SupportedFeatures" - }, - "fpolicyProperties": { - "$ref": "#/components/schemas/FpolicyProperties" - }, - "saasProperties": { - "$ref": "#/components/schemas/CvoSaasProperties" - }, - "cbsProperties": { - "$ref": "#/components/schemas/CbsPropertiesWithReason" - }, - "complianceProperties": { - "$ref": "#/components/schemas/CloudComplianceStatusResponse" - }, - "monitoringProperties": { - "$ref": "#/components/schemas/MonitoringStatusResponse" - }, - "licensesInformation": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseInformation" - } - } - } - }, - "WorkingEnvironments": { - "required": [ - "azureVsaWorkingEnvironments", - "gcpVsaWorkingEnvironments", - "onPremWorkingEnvironments", - "vsaWorkingEnvironments" - ], - "type": "object", - "properties": { - "vsaWorkingEnvironments": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VsaWorkingEnvironmentResponse" - } - }, - "onPremWorkingEnvironments": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OnPremWorkingEnvironmentResponse" - } - }, - "azureVsaWorkingEnvironments": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AzureVsaWorkingEnvironmentResponse" - } - }, - "gcpVsaWorkingEnvironments": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpVsaWorkingEnvironmentResponse" - } - } - } - }, - "GenericVsaWorkingEnvironmentResponse": { - "required": [ - "licensesInformation", - "publicId", - "userTags" - ], - "type": "object", - "properties": { - "publicId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "status": { - "$ref": "#/components/schemas/StatusProperties" - }, - "ontapClusterProperties": { - "$ref": "#/components/schemas/OntapClusterProperties" - }, - "cloudProviderName": { - "type": "string" - }, - "isHA": { - "type": "boolean" - }, - "workingEnvironmentType": { - "type": "string" - }, - "userTags": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "string" - } - }, - "licensesInformation": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseInformation" - } - } - } - }, - "CreateFlexCacheRestRequest": { - "required": [ - "cacheVolumePercentage", - "destinationSvmName", - "destinationWorkingEnvironmentId", - "replicateNfsCifsShares", - "sourceSvmName", - "sourceVolumes", - "sourceWorkingEnvironmentId" - ], - "type": "object", - "properties": { - "sourceWorkingEnvironmentId": { - "type": "string" - }, - "destinationWorkingEnvironmentId": { - "type": "string" - }, - "sourceSvmName": { - "type": "string" - }, - "destinationSvmName": { - "type": "string" - }, - "sourceIpSpace": { - "type": "string" - }, - "destinationIpSpace": { - "type": "string" - }, - "sourceVolumes": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "cacheVolumePercentage": { - "type": "integer", - "format": "int32" - }, - "nameForSingleVolume": { - "type": "string" - }, - "namePrefix": { - "type": "string" - }, - "nameSuffix": { - "type": "string" - }, - "replicateNfsCifsShares": { - "type": "boolean" - } - } - }, - "AllRelationships": { - "required": [ - "relationships" - ], - "type": "object", - "properties": { - "relationships": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SourceTarget" - } - } - } - }, - "Id": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, - "SeqSourceTarget": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SourceTarget" - } - }, - "SourceTarget": { - "required": [ - "source" - ], - "type": "object", - "properties": { - "source": { - "$ref": "#/components/schemas/Id" - }, - "target": { - "$ref": "#/components/schemas/Id" - } - } - }, - "ModifyFlexCacheRestRequest": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "cacheVolumeSize": { - "type": "object" - }, - "junctionPath": { - "type": "string" - }, - "exportPolicy": { - "type": "string" - } - } - }, - "FlexCacheResponse": { - "required": [ - "destination", - "source" - ], - "type": "object", - "properties": { - "source": { - "$ref": "#/components/schemas/FlexCacheSide" - }, - "destination": { - "$ref": "#/components/schemas/FlexCacheSide" - } - } - }, - "FlexCacheSide": { - "type": "object", - "properties": { - "workingEnvironmentId": { - "type": "string" - }, - "workingEnvironmentType": { - "type": "string" - }, - "clusterName": { - "type": "string" - }, - "svm": { - "type": "string" - }, - "volume": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "size": { - "$ref": "#/components/schemas/Capacity" - } - } - }, - "SeqFlexCacheResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/FlexCacheResponse" - } - }, - "AccessPoints": { - "type": "object", - "properties": { - "accessPoint": { - "type": "string" - }, - "primary": { - "type": "string" - }, - "secondary": { - "type": "string" - } - } - }, - "AutoSizeResponse": { - "required": [ - "mode" - ], - "type": "object", - "properties": { - "mode": { - "type": "string" - }, - "maximum": { - "$ref": "#/components/schemas/Capacity" - } - } - }, - "AvsIqnStatusResponse": { - "type": "object", - "properties": { - "iqn": { - "type": "string" - }, - "connection_state": { - "type": "string" - } - } - }, - "CifsResponse": { - "type": "object", - "properties": { - "shareInfo": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CifsShareInfo" - } - }, - "accessPoints": { - "$ref": "#/components/schemas/AccessPoints" - } - } - }, - "CloneResponse": { - "required": [ - "childVolumes", - "parentVolume" - ], - "type": "object", - "properties": { - "parentVolume": { - "$ref": "#/components/schemas/Identifier" - }, - "parentSnapshot": { - "$ref": "#/components/schemas/Identifier" - }, - "childVolumes": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "CompressionResponse": { - "required": [ - "enabled", - "savings" - ], - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "savings": { - "$ref": "#/components/schemas/Capacity" - } - } - }, - "DeduplicationResponse": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "savings": { - "$ref": "#/components/schemas/Capacity" - } - } - }, - "EfficiencyResponse": { - "type": "object", - "properties": { - "compression": { - "$ref": "#/components/schemas/CompressionResponse" - }, - "deduplication": { - "$ref": "#/components/schemas/DeduplicationResponse" - } - } - }, - "Identifier": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "uuid": { - "type": "string" - } - } - }, - "InodesResponse": { - "type": "object", - "properties": { - "total": { - "type": "object" - }, - "used": { - "type": "object" - } - } - }, - "IscsiResponse": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "targetName": { - "type": "string" - } - } - }, - "MountPoints": { - "type": "object", - "properties": { - "mountPoint": { - "type": "string" - }, - "primaryNoFailover": { - "type": "string" - }, - "SecondaryNoFailover": { - "type": "string" - } - } - }, - "NfsResponse": { - "type": "object", - "properties": { - "exportPolicy": { - "$ref": "#/components/schemas/NamedExportPolicyInfo" - }, - "mountPoints": { - "$ref": "#/components/schemas/MountPoints" - } - } - }, - "SeqAvsIqnStatusResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AvsIqnStatusResponse" - } - }, - "SeqTag": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "SnaplockResponse": { - "type": "object", - "properties": { - "type": { - "type": "string" - } - } - }, - "SnapmirrorResponse": { - "type": "object", - "properties": { - "cloudProtected": { - "type": "object" - }, - "ontapProtected": { - "type": "object" - } - } - }, - "Tag": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" - } - } - }, - "TieringResponse": { - "type": "object", - "properties": { - "policy": { - "type": "string" - }, - "minCoolingDays": { - "type": "object" - }, - "type": { - "type": "string" - }, - "used": { - "$ref": "#/components/schemas/Capacity" - }, - "tierInactiveUserData": { - "$ref": "#/components/schemas/Capacity" - }, - "tierInactiveUserDataPercent": { - "type": "object" - } - } - }, - "VolumeProviderPropertiesResponse": { - "type": "object", - "properties": { - "volumeType": { - "type": "string" - }, - "tags": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "iops": { - "type": "object" - }, - "throughput": { - "type": "object" - } - } - }, - "NfsClientsResponse": { - "required": [ - "volume" - ], - "type": "object", - "properties": { - "volume": { - "type": "string" - }, - "svm": { - "type": "string" - }, - "exportPolicy": { - "type": "string" - }, - "clientIp": { - "type": "string" - }, - "idleDuration": { - "type": "string" - } - } - }, - "SeqNfsClientsResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/NfsClientsResponse" - } - }, - "SeqSharePermissions": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SharePermissions" - } - }, - "SeqVolumeShareResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeShareResponse" - } - }, - "SharePermissions": { - "type": "object", - "properties": { - "userOrGroup": { - "type": "string" - }, - "permission": { - "type": "string" - } - } - }, - "VolumeShareResponse": { - "required": [ - "name", - "permissions" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "volume": { - "type": "string" - }, - "path": { - "type": "string" - }, - "permissions": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SharePermissions" - } - } - } - }, - "FsxVolumeModifyRequest": { - "type": "object", - "properties": { - "snapshotPolicyName": { - "type": "string" - }, - "exportPolicyInfo": { - "$ref": "#/components/schemas/NamedExportPolicyInfo" - }, - "tieringPolicy": { - "type": "string" - }, - "shareInfo": { - "$ref": "#/components/schemas/CifsShareInfo" - } - } - }, - "AwsTag": { - "type": "object", - "properties": { - "tagKey": { - "type": "string" - }, - "tagValue": { - "type": "string" - } - } - }, - "FsxVolumeCreateRequest": { - "required": [ - "awsTags", - "enableStorageEfficiency", - "fileSystemId", - "size", - "snapshotPolicyName", - "svmName" - ], - "type": "object", - "properties": { - "fileSystemId": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "size": { - "$ref": "#/components/schemas/PositiveCapacity" - }, - "initialSize": { - "$ref": "#/components/schemas/Capacity" - }, - "snapshotPolicyName": { - "type": "string" - }, - "exportPolicyInfo": { - "$ref": "#/components/schemas/ExportPolicyInfo" - }, - "shareInfo": { - "$ref": "#/components/schemas/CreateCifsShareInfoRequest" - }, - "ProtocolIscsiInfo": { - "$ref": "#/components/schemas/CreateIscsiInfoRequest" - }, - "enableStorageEfficiency": { - "type": "boolean" - }, - "tieringPolicy": { - "type": "string" - }, - "awsTags": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AwsTag" - } - }, - "numberOfConstituents": { - "type": "object" - } - } - }, - "SeqAwsTag": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AwsTag" - } - }, - "ExportPolicyResponse": { - "required": [ - "name", - "rules" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "svm": { - "type": "string" - }, - "rules": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ExportPolicyRule" - } - } - } - }, - "SeqExportPolicyResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ExportPolicyResponse" - } - }, - "SeqSvmResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SvmResponse" - } - }, - "SvmResponse": { - "required": [ - "allowedProtocols", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "state": { - "type": "string" - }, - "language": { - "type": "string" - }, - "allowedProtocols": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "InterfaceResponse": { - "required": [ - "dataProtocols", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "address": { - "type": "string" - }, - "svm": { - "type": "string" - }, - "role": { - "type": "string" - }, - "status": { - "type": "string" - }, - "ipSpace": { - "type": "string" - }, - "dataProtocols": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "SeqInterfaceResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InterfaceResponse" - } - }, - "ClusterInfo": { - "type": "object", - "properties": { - "clusterName": { - "type": "string" - }, - "clusterUuid": { - "type": "string" - } - } - }, - "FsxCredentialsStatusResponse": { - "required": [ - "valid" - ], - "type": "object", - "properties": { - "valid": { - "type": "boolean" - }, - "clusterInfo": { - "$ref": "#/components/schemas/ClusterInfo" - }, - "failureReason": { - "type": "string" - } - } - }, - "ZapiCredentials": { - "required": [ - "ip" - ], - "type": "object", - "properties": { - "ip": { - "type": "string" - }, - "userName": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "GcpNetworkRequirementsResponse": { - "required": [ - "vsaMinimumRequiredIps" - ], - "type": "object", - "properties": { - "vsaMinimumRequiredIps": { - "type": "integer", - "format": "int32" - }, - "haVsaMinimumRequiredIps": { - "type": "integer", - "format": "int32" - } - } - }, - "GcpEncryptionKey": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - }, - "keyRing": { - "type": "string" - }, - "location": { - "type": "string" - } - } - }, - "SeqGcpEncryptionKey": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpEncryptionKey" - } - }, - "GcpServiceAccountResponse": { - "required": [ - "isEnabled", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "projectId": { - "type": "string" - }, - "email": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "isEnabled": { - "type": "boolean" - } - } - }, - "GcpServiceAccountsResponse": { - "required": [ - "accounts" - ], - "type": "object", - "properties": { - "accounts": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpServiceAccountResponse" - } - } - } - }, - "SeqGcpServiceAccountResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpServiceAccountResponse" - } - }, - "GcpBucket": { - "required": [ - "labels", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "location": { - "type": "string" - }, - "storageClass": { - "type": "string" - }, - "kmsKeyName": { - "type": "string" - }, - "labels": { - "$ref": "#/components/schemas/MapStringString" - } - } - }, - "SeqGcpBucket": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpBucket" - } - }, - "OptionListWorkerPool": { - "required": [ - "empty" - ], - "type": "object", - "properties": { - "empty": { - "type": "boolean" - }, - "defined": { - "type": "boolean" - } - } - }, - "CreateBucketRequest": { - "required": [ - "bucketName" - ], - "type": "object", - "properties": { - "projectId": { - "type": "string" - }, - "bucketName": { - "type": "string" - }, - "location": { - "type": "string" - }, - "storageClass": { - "type": "string" - }, - "kmsKeyName": { - "type": "string" - } - } - }, - "GcpDiskTypeResponse": { - "required": [ - "size", - "supportedDiskTypes" - ], - "type": "object", - "properties": { - "size": { - "$ref": "#/components/schemas/Capacity" - }, - "supportedDiskTypes": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "supportedOccmLicenses": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "SeqGcpDiskTypeResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpDiskTypeResponse" - } - }, - "GcpProjectResponse": { - "required": [ - "isDefault", - "parent", - "projectNumber" - ], - "type": "object", - "properties": { - "isDefault": { - "type": "boolean" - }, - "projectNumber": { - "type": "string" - }, - "projectId": { - "type": "string" - }, - "lifecycleState": { - "type": "string" - }, - "name": { - "type": "string" - }, - "createTime": { - "type": "string" - }, - "parent": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "string" - } - }, - "subscriptionId": { - "type": "string" - } - } - }, - "GcpProjectsResponse": { - "required": [ - "projects" - ], - "type": "object", - "properties": { - "projects": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpProjectResponse" - } - } - } - }, - "SeqGcpProjectResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpProjectResponse" - } - }, - "GcpFirewallResponse": { - "required": [ - "name", - "targetServiceAccount", - "vpc" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "vpc": { - "type": "string" - }, - "targetServiceAccount": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "GcpRegionResponse": { - "required": [ - "displayName", - "vpcs", - "zones" - ], - "type": "object", - "properties": { - "displayName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "zones": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpZoneResponse" - } - }, - "vpcs": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpVirtualNetworkResponse" - } - } - } - }, - "GcpSubnetResponse": { - "required": [ - "availableIps", - "ipCidrRange", - "minimumRequiredIps", - "name", - "path" - ], - "type": "object", - "properties": { - "ipCidrRange": { - "type": "string" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "availableIps": { - "type": "integer", - "format": "int32" - }, - "minimumRequiredIps": { - "type": "integer", - "format": "int32" - } - } - }, - "GcpVirtualNetworkResponse": { - "required": [ - "firewalls", - "name", - "subnets" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "subnets": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpSubnetResponse" - } - }, - "firewalls": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpFirewallResponse" - } - } - } - }, - "GcpZoneResponse": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - }, - "SeqGcpFirewallResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpFirewallResponse" - } - }, - "SeqGcpRegionResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpRegionResponse" - } - }, - "SeqGcpSubnetResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpSubnetResponse" - } - }, - "SeqGcpVirtualNetworkResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpVirtualNetworkResponse" - } - }, - "SeqGcpZoneResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpZoneResponse" - } - }, - "GcpConnectivityResponse": { - "required": [ - "firewalls", - "isShared", - "name", - "subnets", - "vpcPath" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "vpcPath": { - "type": "string" - }, - "subnets": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpSubnetResponse" - } - }, - "firewalls": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpFirewallResponse" - } - }, - "isShared": { - "type": "boolean" - } - } - }, - "SeqGcpConnectivityResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpConnectivityResponse" - } - }, - "GcpZonesAndRegionResponse": { - "required": [ - "displayName", - "zones" - ], - "type": "object", - "properties": { - "displayName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "location": { - "type": "string" - }, - "zones": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpZoneResponse" - } - } - } - }, - "SeqGcpZonesAndRegionResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpZonesAndRegionResponse" - } - }, - "CreateGcpVsaWorkingEnvironmentRequest": { - "required": [ - "dataEncryptionType", - "enableCompliance", - "enableMonitoring", - "flashCache", - "gcpLabels", - "gcpVolumeSize", - "gcpVolumeType", - "skipSvmManagementLif", - "subnetId", - "vpcId", - "vsaMetadata" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "svmPassword": { - "type": "string" - }, - "username": { - "$ref": "#/components/schemas/AdminUsername" - }, - "vpcId": { - "type": "string" - }, - "volume": { - "$ref": "#/components/schemas/VsaVolumeOnNewVsaCreateRequest" - }, - "region": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "subnetPath": { - "type": "string" - }, - "subnetId": { - "type": "string" - }, - "firewallRule": { - "type": "string" - }, - "firewallTagNameRule": { - "type": "string" - }, - "firewallIpRanges": { - "type": "object" - }, - "dataEncryptionType": { - "type": "string" - }, - "securityGroupId": { - "type": "string" - }, - "vsaMetadata": { - "$ref": "#/components/schemas/VsaMetadataRequest" - }, - "cifsConfigurationRequest": { - "$ref": "#/components/schemas/CIFSConfigurationRequest" - }, - "serialNumber": { - "type": "string" - }, - "gcpVolumeSize": { - "$ref": "#/components/schemas/Capacity" - }, - "gcpVolumeType": { - "type": "string" - }, - "gcpLabels": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpLabel" - } - }, - "workerPool": { - "type": "string" - }, - "writingSpeedState": { - "type": "string" - }, - "failedToCreateWorkingEnvironmentId": { - "type": "string" - }, - "capacityTier": { - "type": "string" - }, - "packageName": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "wormRequest": { - "$ref": "#/components/schemas/WormRequest" - }, - "nssAccount": { - "type": "string" - }, - "gcpStorageAccount": { - "type": "string" - }, - "gcpServiceAccount": { - "type": "string" - }, - "tierLevel": { - "type": "string" - }, - "saasSubscriptionId": { - "type": "string" - }, - "cloudProviderAccount": { - "type": "string" - }, - "project": { - "type": "string" - }, - "enableCompliance": { - "type": "boolean" - }, - "gcpEncryptionParameters": { - "$ref": "#/components/schemas/GcpEncryption" - }, - "providedImage": { - "type": "string" - }, - "providedMediatorImage": { - "type": "string" - }, - "enableMonitoring": { - "type": "boolean" - }, - "enableServices": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "backupVolumesToCbs": { - "type": "boolean" - }, - "haParams": { - "$ref": "#/components/schemas/GcpHaParameters" - }, - "gcpPerformance": { - "$ref": "#/components/schemas/GcpPerformance" - }, - "skipSvmManagementLif": { - "type": "boolean" - }, - "flashCache": { - "type": "boolean" - } - } - }, - "GcpEncryption": { - "type": "object", - "properties": { - "key": { - "type": "string" - } - } - }, - "GcpHaParameters": { - "type": "object", - "properties": { - "platformSerialNumberNode1": { - "type": "string" - }, - "platformSerialNumberNode2": { - "type": "string" - }, - "node1Zone": { - "type": "string" - }, - "node2Zone": { - "type": "string" - }, - "mediatorZone": { - "type": "string" - }, - "vpc0NodeAndDataConnectivity": { - "type": "string" - }, - "vpc1ClusterConnectivity": { - "type": "string" - }, - "vpc2HAConnectivity": { - "type": "string" - }, - "vpc3DataReplication": { - "type": "string" - }, - "subnet0NodeAndDataConnectivity": { - "type": "string" - }, - "subnet1ClusterConnectivity": { - "type": "string" - }, - "subnet2HAConnectivity": { - "type": "string" - }, - "subnet3DataReplication": { - "type": "string" - }, - "vpc0FirewallRuleName": { - "type": "string" - }, - "vpc1FirewallRuleName": { - "type": "string" - }, - "vpc2FirewallRuleName": { - "type": "string" - }, - "vpc3FirewallRuleName": { - "type": "string" - }, - "vpc0FirewallRuleTagName": { - "type": "string" - }, - "vpc1FirewallRuleTagName": { - "type": "string" - }, - "vpc2FirewallRuleTagName": { - "type": "string" - }, - "vpc3FirewallRuleTagName": { - "type": "string" - } - } - }, - "GcpLabel": { - "type": "object", - "properties": { - "labelKey": { - "type": "string" - }, - "labelValue": { - "type": "string" - } - } - }, - "GcpPerformance": { - "type": "object", - "properties": { - "iops": { - "type": "object" - }, - "throughput": { - "type": "object" - } - } - }, - "SeqGcpLabel": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/GcpLabel" - } - }, - "CreateSvmRequest": { - "required": [ - "mgmtLif" - ], - "type": "object", - "properties": { - "svmName": { - "type": "string" - }, - "svmPassword": { - "$ref": "#/components/schemas/VsaSvmPassword" - }, - "mgmtLif": { - "type": "boolean" - }, - "rootVolumeAggregate": { - "type": "string" - } - } - }, - "VsaSvmPassword": { - "required": [ - "_1", - "validatesWith" - ], - "type": "object", - "properties": { - "_1": { - "type": "string" - }, - "validatesWith": { - "$ref": "#/components/schemas/PatternMessage" - } - } - }, - "AddCapacityToEvAggregateRequest": { - "required": [ - "capacityToAdd" - ], - "type": "object", - "properties": { - "capacityToAdd": { - "$ref": "#/components/schemas/Capacity" - } - } - }, - "DiscoveredAwsHaResponse": { - "required": [ - "availabilityZones", - "name", - "recoverable" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "publicId": { - "type": "string" - }, - "region": { - "type": "string" - }, - "vpcName": { - "type": "string" - }, - "vpcId": { - "type": "string" - }, - "availabilityZones": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "subnetIds": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "stackName": { - "type": "string" - }, - "stackId": { - "type": "string" - }, - "clusterAddress": { - "type": "string" - }, - "recoverable": { - "type": "boolean" - }, - "byol": { - "type": "boolean" - }, - "registered": { - "type": "boolean" - } - } - }, - "SeqDiscoveredAwsHaResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DiscoveredAwsHaResponse" - } - }, - "RecoverVsaRequest": { - "required": [ - "clusterCredentials", - "region" - ], - "type": "object", - "properties": { - "region": { - "type": "string" - }, - "stackId": { - "type": "string" - }, - "clusterCredentials": { - "$ref": "#/components/schemas/ClusterCredentialsRequest" - }, - "tenantId": { - "type": "string" - }, - "providerAccount": { - "type": "string" - }, - "cloudProviderAccount": { - "type": "string" - }, - "nssAccountId": { - "type": "string" - } - } - }, - "UpdateKeyManagerCaCertificateRequest": { - "required": [ - "keyManagerCaCertificateId" - ], - "type": "object", - "properties": { - "keyManagerCaCertificateId": { - "type": "string" - } - } - }, - "AwsHaFloatingIpValidationResponse": { - "required": [ - "reasons", - "result" - ], - "type": "object", - "properties": { - "result": { - "type": "boolean" - }, - "reasons": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "AwsHaFloatingIpValidationData": { - "required": [ - "floatingIps", - "routeTablesIds", - "vpcId" - ], - "type": "object", - "properties": { - "floatingIps": { - "$ref": "#/components/schemas/FloatingIps" - }, - "routeTablesIds": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "vpcId": { - "type": "string" - }, - "region": { - "type": "string" - }, - "roleArn": { - "type": "string" - }, - "cloudProviderAccountId": { - "type": "string" - } - } - }, - "FloatingIps": { - "type": "object", - "properties": { - "clusterFloatingIP": { - "type": "string" - }, - "dataFloatingIP": { - "type": "string" - }, - "dataFloatingIP2": { - "type": "string" - }, - "svmFloatingIP": { - "type": "string" - } - } - }, - "RouteTableResponse": { - "required": [ - "id", - "main", - "subnets", - "tags" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "main": { - "type": "boolean" - }, - "subnets": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "tags": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/RouteTableTag" - } - } - } - }, - "RouteTableTag": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" - } - } - }, - "SeqRouteTableResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/RouteTableResponse" - } - }, - "SeqRouteTableTag": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/RouteTableTag" - } - }, - "SeqConfiguration": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Configuration" - } - }, - "NetworkRequirementsResponse": { - "required": [ - "nonHaNodeMinimumRequiredIps" - ], - "type": "object", - "properties": { - "nonHaNodeMinimumRequiredIps": { - "type": "integer", - "format": "int32" - }, - "haNodeMinimumRequiredIps": { - "type": "integer", - "format": "int32" - }, - "haMediatorMinimumRequiredIps": { - "type": "integer", - "format": "int32" - } - } - }, - "SeqAwsEncryptionKey": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AwsEncryptionKey" - } - }, - "AwsValidateSubscribedToOntapCloudResponse": { - "required": [ - "isSubscribed" - ], - "type": "object", - "properties": { - "failureInfo": { - "type": "string" - }, - "isSubscribed": { - "type": "boolean" - } - } - }, - "AwsValidateSubscribedToOntapCloudRequest": { - "required": [ - "region", - "vsaMetadata" - ], - "type": "object", - "properties": { - "region": { - "type": "string" - }, - "subnetId": { - "type": "string" - }, - "vsaMetadata": { - "$ref": "#/components/schemas/VsaMetadataRequest" - }, - "roleArn": { - "type": "string" - }, - "cloudProviderAccount": { - "type": "string" - }, - "securityGroupId": { - "type": "string" - } - } - }, - "S3BucketInfoDetails": { - "required": [ - "bucketName", - "tags" - ], - "type": "object", - "properties": { - "bucketName": { - "type": "string" - }, - "region": { - "type": "string" - }, - "tags": { - "required": [ - "traversableAgain" - ], - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "string" - } - }, - "isTieringTarget": { - "type": "boolean" - }, - "isBackupTarget": { - "type": "boolean" - } - } - }, - "S3BucketsSummary": { - "required": [ - "s3Buckets", - "totalBuckets" - ], - "type": "object", - "properties": { - "s3Buckets": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/S3BucketInfoDetails" - } - }, - "totalBuckets": { - "type": "integer", - "format": "int32" - }, - "totalRegions": { - "type": "integer", - "format": "int32" - }, - "totalTieringTargets": { - "type": "integer", - "format": "int32" - }, - "totalBackupTargets": { - "type": "integer", - "format": "int32" - } - } - }, - "SeqS3BucketInfoDetails": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/S3BucketInfoDetails" - } - }, - "BucketAdditionalData": { - "required": [ - "bucketName" - ], - "type": "object", - "properties": { - "bucketName": { - "type": "string" - }, - "tieringLevel": { - "type": "string" - }, - "accessData": { - "type": "string" - } - } - }, - "SeqBucketAdditionalData": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/BucketAdditionalData" - } - }, - "BucketsPolicyAndTieringInfoRequest": { - "required": [ - "buckets" - ], - "type": "object", - "properties": { - "buckets": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "S3BucketInfo": { - "required": [ - "bucketName", - "tags" - ], - "type": "object", - "properties": { - "bucketName": { - "type": "string" - }, - "region": { - "type": "string" - }, - "tags": { - "required": [ - "traversableAgain" - ], - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "string" - } - } - } - }, - "SeqS3BucketInfo": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/S3BucketInfo" - } - }, - "InstanceProfileResponse": { - "required": [ - "instanceProfileId" - ], - "type": "object", - "properties": { - "instanceProfileId": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "SeqInstanceProfileResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/InstanceProfileResponse" - } - }, - "KeyPairsByRegionResponse": { - "required": [ - "regionToKeyPairs" - ], - "type": "object", - "properties": { - "regionToKeyPairs": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - } - }, - "MapStringSeqString": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - }, - "CloudOntapManifest": { - "required": [ - "license_to_ami_mapping", - "ontap_image_versions_allowed_to_upgrade_from" - ], - "type": "object", - "properties": { - "ontap_version": { - "type": "string" - }, - "ontap_image_versions_allowed_to_upgrade_from": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "encryption_enabled_instance_types": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "license_to_ami_mapping": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseToAmis" - } - } - } - }, - "FeatureProperties": { - "type": "object", - "properties": { - "start": { - "type": "string" - }, - "end": { - "type": "string" - }, - "excludedRegions": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "excludedLicenseTypes": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "GlobalManifest": { - "required": [ - "cot_versions", - "license_types", - "regions", - "supportedFeatures" - ], - "type": "object", - "properties": { - "license_types": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OntapLicenseType" - } - }, - "regions": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Region" - } - }, - "azureRegions": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Region" - } - }, - "gcpRegions": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Region" - } - }, - "cot_versions": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "$ref": "#/components/schemas/MapStringListString" - } - }, - "cot_versions_to_upgrade_to": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "$ref": "#/components/schemas/MapStringListString" - } - }, - "supportedFeatures": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "$ref": "#/components/schemas/MapStringFeatureProperties" - } - } - } - }, - "LicenseToAmis": { - "required": [ - "amis" - ], - "type": "object", - "properties": { - "license_type": { - "type": "string" - }, - "instance_types": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "amis": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/RegionalAmi" - } - } - } - }, - "ListOntapLicenseType": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OntapLicenseType" - } - }, - "ListRegion": { - "required": [ - "empty" - ], - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Region" - } - }, - "MapStringFeatureProperties": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "$ref": "#/components/schemas/FeatureProperties" - } - }, - "MapStringListString": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - }, - "MapStringMapStringFeatureProperties": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "$ref": "#/components/schemas/MapStringFeatureProperties" - } - }, - "MapStringMapStringListString": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "$ref": "#/components/schemas/MapStringListString" - } - }, - "MetadataResponse": { - "required": [ - "globalManifest", - "ontapManifests" - ], - "type": "object", - "properties": { - "globalManifest": { - "$ref": "#/components/schemas/GlobalManifest" - }, - "ontapManifests": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudOntapManifest" - } - } - } - }, - "RegionalAmi": { - "type": "object", - "properties": { - "region": { - "type": "string" - }, - "ami_id": { - "type": "string" - }, - "saas_mp": { - "type": "boolean" - } - } - }, - "SeqCloudOntapManifest": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudOntapManifest" - } - }, - "SeqLicenseToAmis": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/LicenseToAmis" - } - }, - "SeqRegionalAmi": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/RegionalAmi" - } - }, - "SecurityGroupResponse": { - "required": [ - "description", - "name", - "securityGroupId" - ], - "type": "object", - "properties": { - "securityGroupId": { - "type": "string" - }, - "description": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "SeqSecurityGroupResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SecurityGroupResponse" - } - }, - "SeqSubnetResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SubnetResponse" - } - }, - "SeqVpcExtendedResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VpcExtendedResponse" - } - }, - "SubnetResponse": { - "required": [ - "availabilityZone", - "availableIps", - "cidr", - "minimumRequiredIps", - "subnetId" - ], - "type": "object", - "properties": { - "subnetId": { - "type": "string" - }, - "cidr": { - "type": "string" - }, - "subnetName": { - "type": "string" - }, - "availabilityZone": { - "type": "string" - }, - "availableIps": { - "type": "integer", - "format": "int32" - }, - "minimumRequiredIps": { - "type": "integer", - "format": "int32" - }, - "outpostArn": { - "type": "string" - } - } - }, - "VpcExtendedResponse": { - "required": [ - "cidrBlock", - "default", - "securityGroups", - "state", - "subnets", - "tags", - "tenancy", - "vpcId" - ], - "type": "object", - "properties": { - "vpcId": { - "type": "string" - }, - "state": { - "type": "string" - }, - "cidrBlock": { - "type": "string" - }, - "tags": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VpcTagResponse" - } - }, - "default": { - "type": "boolean" - }, - "subnets": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SubnetResponse" - } - }, - "securityGroups": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SecurityGroupResponse" - } - }, - "tenancy": { - "type": "string" - } - } - }, - "S3Summary": { - "required": [ - "isSupportable", - "numOfBuckets" - ], - "type": "object", - "properties": { - "isSupportable": { - "type": "boolean" - }, - "numOfBuckets": { - "type": "integer", - "format": "int32" - }, - "numOfRegions": { - "type": "integer", - "format": "int32" - } - } - }, - "EbsVolumeType": { - "required": [ - "description", - "size", - "supportedVolumeTypes" - ], - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "size": { - "$ref": "#/components/schemas/Capacity" - }, - "supportedVolumeTypes": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "supportedOccmLicenses": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "isDefault": { - "type": "boolean" - } - } - }, - "SeqEbsVolumeType": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/EbsVolumeType" - } - }, - "AwsEncryption": { - "type": "object", - "properties": { - "kmsKeyId": { - "type": "string" - }, - "kmsKeyArn": { - "type": "string" - } - } - }, - "CreateAwsHaWorkingEnvironmentRequest": { - "required": [ - "awsTags", - "dataEncryptionType", - "ebsVolumeSize", - "ebsVolumeType", - "enableCompliance", - "enableMonitoring", - "haParams", - "subnetId", - "vpcId", - "vsaMetadata" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "svmPassword": { - "type": "string" - }, - "username": { - "$ref": "#/components/schemas/AdminUsername" - }, - "vpcId": { - "type": "string" - }, - "description": { - "type": "string" - }, - "region": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "volume": { - "$ref": "#/components/schemas/VsaVolumeOnNewVsaCreateRequest" - }, - "ebsVolumeSize": { - "$ref": "#/components/schemas/Capacity" - }, - "ebsVolumeType": { - "type": "string" - }, - "vsaMetadata": { - "$ref": "#/components/schemas/VsaMetadataRequest" - }, - "dataEncryptionType": { - "type": "string" - }, - "ontapEncryptionParameters": { - "$ref": "#/components/schemas/OntapEncryption" - }, - "awsEncryptionParameters": { - "$ref": "#/components/schemas/AwsEncryption" - }, - "haParams": { - "$ref": "#/components/schemas/HaParameters" - }, - "securityGroupId": { - "type": "string" - }, - "openSecurityGroup": { - "type": "object" - }, - "awsTags": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AwsTag" - } - }, - "cifsConfigurationRequest": { - "$ref": "#/components/schemas/CIFSConfigurationRequest" - }, - "optimizedNetworkUtilization": { - "type": "boolean" - }, - "clusterKeyPairName": { - "type": "string" - }, - "instanceTenancy": { - "type": "string" - }, - "failedToCreateWorkingEnvironmentId": { - "type": "string" - }, - "capacityTier": { - "type": "string" - }, - "iops": { - "type": "integer", - "format": "int32" - }, - "throughput": { - "type": "integer", - "format": "int32" - }, - "packageName": { - "type": "string" - }, - "instanceProfileName": { - "type": "string" - }, - "roleArn": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "wormRequest": { - "$ref": "#/components/schemas/WormRequest" - }, - "cloudProviderAccount": { - "type": "string" - }, - "nssAccount": { - "type": "string" - }, - "saasSubscriptionId": { - "type": "string" - }, - "backupVolumesToCbs": { - "type": "boolean" - }, - "enableCompliance": { - "type": "boolean" - }, - "disableEv": { - "type": "boolean" - }, - "tierLevel": { - "type": "string" - }, - "enableMonitoring": { - "type": "boolean" - }, - "enableServices": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "writingSpeedState": { - "type": "string" - }, - "subnetId": { - "type": "string" - }, - "ontapEncryptionDefined": { - "type": "boolean" - } - } - }, - "HaParameters": { - "type": "object", - "properties": { - "node1SubnetId": { - "type": "string" - }, - "node2SubnetId": { - "type": "string" - }, - "mediatorSubnetId": { - "type": "string" - }, - "clusterFloatingIP": { - "type": "string" - }, - "dataFloatingIP": { - "type": "string" - }, - "dataFloatingIP2": { - "type": "string" - }, - "svmFloatingIP": { - "type": "string" - }, - "mediatorKeyPairName": { - "type": "string" - }, - "routeTableIds": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "platformSerialNumberNode1": { - "type": "string" - }, - "platformSerialNumberNode2": { - "type": "string" - }, - "providedLicenseNode1": { - "type": "string" - }, - "providedLicenseNode2": { - "type": "string" - }, - "failoverMode": { - "type": "string" - }, - "mediatorProxy": { - "$ref": "#/components/schemas/MediatorProxy" - }, - "mediatorAssignPublicIP": { - "type": "boolean" - }, - "mediatorInstanceProfileName": { - "type": "string" - }, - "mediatorSecurityGroupId": { - "type": "string" - }, - "assumeRoleArn": { - "type": "string" - } - } - }, - "MediatorProxy": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "userName": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "UpdateRouteTablesRequest": { - "required": [ - "routeTableIds" - ], - "type": "object", - "properties": { - "routeTableIds": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "CertificateSigningRequest": { - "type": "object", - "properties": { - "commonName": { - "type": "string" - } - } - }, - "InstallCertificatesAndPrivateKeyRequest": { - "required": [ - "occmCertificate" - ], - "type": "object", - "properties": { - "occmCertificate": { - "type": "string" - }, - "privateKey": { - "type": "string" - }, - "algorithm": { - "type": "string" - } - } - }, - "SeqTrustedCertificateResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/TrustedCertificateResponse" - } - }, - "TrustedCertificateResponse": { - "required": [ - "certificateInfo", - "id", - "status" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "status": { - "type": "string" - }, - "certificateInfo": { - "$ref": "#/components/schemas/CertificateResponse" - } - } - }, - "EnableMonitoringRequest": { - "required": [ - "workingEnvironmentIds" - ], - "type": "object", - "properties": { - "workingEnvironmentIds": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "MonitoringInfoResponse": { - "required": [ - "healthy", - "status" - ], - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "lastDeploymentError": { - "type": "string" - }, - "id": { - "type": "string" - } - } - }, - "AsupConfigurationRequest": { - "required": [ - "enabled" - ], - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "schedule": { - "$ref": "#/components/schemas/AsupSchedule" - } - } - }, - "AsupInterval": { - "type": "object", - "properties": { - "length": { - "type": "integer", - "format": "int32" - }, - "unit": { - "type": "string" - } - } - }, - "AsupSchedule": { - "required": [ - "dayOfWeek", - "interval" - ], - "type": "object", - "properties": { - "dayOfWeek": { - "type": "integer", - "format": "int32" - }, - "hourOfDay": { - "type": "integer", - "format": "int32" - }, - "interval": { - "$ref": "#/components/schemas/AsupInterval" - }, - "minuteOfHour": { - "type": "integer", - "format": "int32" - } - } - }, - "AsupConfiguration": { - "required": [ - "enabled", - "schedule", - "site" - ], - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "site": { - "type": "string" - }, - "company": { - "type": "string" - }, - "hostName": { - "type": "string" - }, - "os": { - "type": "string" - }, - "schedule": { - "$ref": "#/components/schemas/AsupSchedule" - }, - "url": { - "type": "string" - } - } - }, - "CloudSyncConstants": { - "type": "object", - "properties": { - "reminderPeriod": { - "type": "integer", - "format": "int32" - }, - "warningPeriod": { - "type": "integer", - "format": "int32" - } - } - }, - "ConfigValuesResponse": { - "required": [ - "autoVsaCapacityManagement", - "cloudSyncConstants", - "keyManagerPort", - "simplicatorUri" - ], - "type": "object", - "properties": { - "simplicatorUri": { - "type": "string" - }, - "proxyUri": { - "type": "string" - }, - "debugLogLevel": { - "type": "string" - }, - "cacheConfig": { - "type": "string" - }, - "keyManagerPort": { - "type": "integer", - "format": "int32" - }, - "ipaManualUrl": { - "type": "string" - }, - "certificateValidityPeriod": { - "type": "integer", - "format": "int32" - }, - "maxAggregateFreeSpacePercentage": { - "type": "integer", - "format": "int32" - }, - "maxEvAggregateFreeSpacePercentage": { - "type": "integer", - "format": "int32" - }, - "asupSite": { - "type": "string" - }, - "asupCompany": { - "type": "string" - }, - "maxVolumeGrowSizePercentage": { - "type": "integer", - "format": "int32" - }, - "autoVsaCapacityManagement": { - "type": "boolean" - }, - "useVolumeViewAsDefault": { - "type": "boolean" - }, - "proxyUserName": { - "type": "string" - }, - "proxyPassword": { - "type": "string" - }, - "proxyDomain": { - "type": "string" - }, - "autoUpgrade": { - "type": "boolean" - }, - "cotRollback": { - "type": "boolean" - }, - "cloudSyncConstants": { - "$ref": "#/components/schemas/CloudSyncConstants" - }, - "licenseMaxCapacityUsedPercentage": { - "type": "integer", - "format": "int32" - }, - "s3EbsRatio": { - "type": "integer", - "format": "int32" - }, - "ebsSizeToPiopsRatio": { - "type": "integer", - "format": "int32" - }, - "autoOntapUpgrade": { - "type": "boolean" - }, - "sysMgrUserCred": { - "type": "boolean" - }, - "gcpInfrastructureManager": { - "type": "boolean" - }, - "overrideCifsLocks": { - "type": "boolean" - }, - "usePrivateLink": { - "type": "boolean" - }, - "directApiTraffic": { - "type": "boolean" - }, - "useAccelerationForImageDownload": { - "type": "boolean" - }, - "maxDownloadSessions": { - "type": "integer", - "format": "int32" - }, - "rollbackOnAzurePrivateLinkFailure": { - "type": "boolean" - }, - "gcpInstanceMetadataItems": { - "$ref": "#/components/schemas/GcpInstanceMetadataItems" - }, - "userPrivateDnsZoneSettings": { - "$ref": "#/components/schemas/UserPrivateDnsZoneSettings" - } - } - }, - "GcpInstanceMetadataItems": { - "type": "object", - "properties": { - "blockProjectSshKeys": { - "type": "boolean" - }, - "serialPortEnable": { - "type": "boolean" - }, - "enableOsLogin": { - "type": "boolean" - }, - "enableOsLoginSk": { - "type": "boolean" - } - } - }, - "UserPrivateDnsZoneSettings": { - "type": "object", - "properties": { - "useExisting": { - "type": "boolean" - }, - "resourceGroup": { - "type": "string" - }, - "subscription": { - "type": "string" - } - } - }, - "ConfigValuesUpdateRequest": { - "required": [ - "pollingIntervalSeconds" - ], - "type": "object", - "properties": { - "simplicatorUri": { - "$ref": "#/components/schemas/Uri" - }, - "proxyUri": { - "type": "string" - }, - "debugLogLevel": { - "$ref": "#/components/schemas/NonEmptyOptionalString" - }, - "cacheConfig": { - "type": "string" - }, - "pollingIntervalSeconds": { - "type": "integer", - "format": "int64" - }, - "startInstanceDelaySeconds": { - "type": "integer", - "format": "int64" - }, - "assignDisksDelaySeconds": { - "type": "integer", - "format": "int64" - }, - "modifyInstanceTypeDelaySeconds": { - "type": "integer", - "format": "int64" - }, - "keyManagerPort": { - "type": "integer", - "format": "int32" - }, - "maxAggregateFreeSpacePercentage": { - "type": "integer", - "format": "int32" - }, - "ontapSpaceOverheadPercentage": { - "type": "integer", - "format": "int32" - }, - "maxVolumeGrowSizePercentage": { - "type": "integer", - "format": "int32" - }, - "autoVsaCapacityManagement": { - "type": "boolean" - }, - "proxyUserName": { - "type": "string" - }, - "proxyPassword": { - "type": "string" - }, - "proxyDomain": { - "type": "string" - }, - "autoUpgrade": { - "type": "boolean" - }, - "cotRollback": { - "type": "boolean" - }, - "s3EbsRatio": { - "type": "integer", - "format": "int32" - }, - "autoOntapUpgrade": { - "type": "boolean" - }, - "sysMgrUserCred": { - "type": "boolean" - }, - "gcpInfrastructureManager": { - "type": "boolean" - }, - "overrideCifsLocks": { - "type": "boolean" - }, - "usePrivateLink": { - "type": "boolean" - }, - "directApiTraffic": { - "type": "boolean" - }, - "useAccelerationForImageDownload": { - "type": "boolean" - }, - "maxDownloadSessions": { - "type": "integer", - "format": "int32" - }, - "rollbackOnAzurePrivateLinkFailure": { - "type": "boolean" - }, - "gcpBlockProjectSshKeys": { - "type": "boolean" - }, - "gcpSerialPortEnable": { - "type": "boolean" - }, - "gcpEnableOsLogin": { - "type": "boolean" - }, - "gcpEnableOsLoginSk": { - "type": "boolean" - } - } - }, - "Uri": { - "required": [ - "_1" - ], - "type": "object", - "properties": { - "_1": { - "type": "string" - } - } - }, - "SeqUpdateInfo": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/UpdateInfo" - } - }, - "UpdateInfo": { - "required": [ - "date", - "name", - "releaseNumber" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "date": { - "type": "integer", - "format": "int64" - }, - "releaseNumber": { - "type": "integer", - "format": "int32" - } - } - }, - "ProviderSupportedRegions": { - "required": [ - "aws" - ], - "type": "object", - "properties": { - "aws": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Region" - } - }, - "azure": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Region" - } - } - } - }, - "SeqRegion": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Region" - } - }, - "VersionWrapper": { - "required": [ - "date", - "name", - "releaseNumber" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "date": { - "type": "integer", - "format": "int64" - }, - "releaseNumber": { - "type": "integer", - "format": "int32" - } - } - }, - "FeatureFlag": { - "required": [ - "azure" - ], - "type": "object", - "properties": { - "azure": { - "type": "boolean" - } - } - }, - "AggregateNumToDiskSize": { - "type": "object", - "properties": { - "from": { - "type": "integer", - "format": "int32" - }, - "to": { - "type": "integer", - "format": "int32" - }, - "stepsUp": { - "type": "integer", - "format": "int32" - } - } - }, - "AwsDisksConstraints": { - "required": [ - "aggregatesNumToDiskSize", - "numReservedDisksSingleNode" - ], - "type": "object", - "properties": { - "numReservedDisksSingleNode": { - "type": "integer", - "format": "int32" - }, - "numReservedDisksHa": { - "type": "integer", - "format": "int32" - }, - "maxDisksSingleNode": { - "type": "integer", - "format": "int32" - }, - "maxDisksHa": { - "type": "integer", - "format": "int32" - }, - "numDisksWarnSingleNode": { - "type": "integer", - "format": "int32" - }, - "numDisksWarnHa": { - "type": "integer", - "format": "int32" - }, - "aggregatesNumToDiskSize": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AggregateNumToDiskSize" - } - }, - "maxDisksSingleNodeKvm": { - "type": "integer", - "format": "int32" - }, - "maxDisksHaKvm": { - "type": "integer", - "format": "int32" - }, - "deltaDiskWarn": { - "type": "integer", - "format": "int32" - } - } - }, - "AzureDisksConstraints": { - "type": "object", - "properties": { - "numReservedDisksSingleNode": { - "type": "integer", - "format": "int32" - }, - "numReservedDisksHaMultiZoneNode": { - "type": "integer", - "format": "int32" - } - } - }, - "CvsRegion": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "code": { - "type": "string" - }, - "location": { - "type": "string" - } - } - }, - "DisksConfiguration": { - "required": [ - "aws", - "azure", - "gcp" - ], - "type": "object", - "properties": { - "aws": { - "$ref": "#/components/schemas/AwsDisksConstraints" - }, - "azure": { - "$ref": "#/components/schemas/AzureDisksConstraints" - }, - "gcp": { - "$ref": "#/components/schemas/GcpDisksConstraints" - } - } - }, - "EvaluationOntapLicenses": { - "type": "object", - "properties": { - "worm": { - "type": "string" - } - } - }, - "EvaluationSerialNumbers": { - "type": "object", - "properties": { - "single_aws": { - "type": "string" - }, - "single_azure": { - "type": "string" - }, - "ha_aws_node1": { - "type": "string" - }, - "ha_aws_node2": { - "type": "string" - }, - "ha_azure_node1": { - "type": "string" - }, - "ha_azure_node2": { - "type": "string" - }, - "gcp_single": { - "type": "string" - }, - "ha_gcp_node1": { - "type": "string" - }, - "ha_gcp_node2": { - "type": "string" - } - } - }, - "GcpDisksConstraints": { - "type": "object", - "properties": { - "numReservedDisksSingleNode": { - "type": "integer", - "format": "int32" - }, - "maxDisksSingleNode": { - "type": "integer", - "format": "int32" - }, - "numDisksWarnSingleNode": { - "type": "integer", - "format": "int32" - }, - "deltaDiskWarn": { - "type": "integer", - "format": "int32" - } - } - }, - "InstanceConfiguration": { - "required": [ - "mediator" - ], - "type": "object", - "properties": { - "mediator": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "$ref": "#/components/schemas/InstanceConfigurationMapping" - } - }, - "probes": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "$ref": "#/components/schemas/InstanceConfigurationMapping" - } - } - } - }, - "InstanceConfigurationMapping": { - "type": "object", - "properties": { - "regular": { - "type": "string" - }, - "dedicated": { - "type": "string" - } - } - }, - "LegacyInstanceTypes": { - "required": [ - "instanceTypes" - ], - "type": "object", - "properties": { - "instanceTypes": { - "$ref": "#/components/schemas/ProviderLegacyInstanceTypes" - } - } - }, - "ListAggregateNumToDiskSize": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AggregateNumToDiskSize" - } - }, - "ListCvsRegion": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CvsRegion" - } - }, - "ListOnCloudUpgradePath": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OnCloudUpgradePath" - } - }, - "LocalServiceInfo": { - "type": "object", - "properties": { - "isSupported": { - "type": "boolean" - }, - "localFolder": { - "type": "string" - }, - "localPort": { - "type": "integer", - "format": "int32" - } - } - }, - "MapStringInstanceConfigurationMapping": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "$ref": "#/components/schemas/InstanceConfigurationMapping" - } - }, - "MapStringServiceInfo": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "$ref": "#/components/schemas/ServiceInfo" - } - }, - "MediatorUpgradeConfiguration": { - "required": [ - "dependencies" - ], - "type": "object", - "properties": { - "dependencies": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - } - }, - "OccmExternalConfiguration": { - "required": [ - "cvsRegions", - "disksConfiguration", - "email", - "evaluation_ontap_licenses", - "evaluation_serial_numbers", - "features", - "instanceConfiguration", - "legacyInstanceTypes", - "mediatorUpgradeConfiguration", - "migration", - "ontapBackupTokenCreds", - "servicesInformation", - "upgrade_path", - "zrsRegions" - ], - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "aws_product_page": { - "type": "string" - }, - "cot_aws_product_page": { - "type": "string" - }, - "ha_cot_aws_product_page": { - "type": "string" - }, - "intercom_prod_app_id": { - "type": "string" - }, - "intercom_test_app_id": { - "type": "string" - }, - "livechat_license": { - "type": "string" - }, - "features": { - "$ref": "#/components/schemas/OccmFeaturesFlags" - }, - "upgrade_path": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OnCloudUpgradePath" - } - }, - "occm_release_notes_url": { - "type": "string" - }, - "evaluation_serial_numbers": { - "$ref": "#/components/schemas/EvaluationSerialNumbers" - }, - "legacyInstanceTypes": { - "$ref": "#/components/schemas/LegacyInstanceTypes" - }, - "aws_cross_account_tutorial_url": { - "type": "string" - }, - "disksConfiguration": { - "$ref": "#/components/schemas/DisksConfiguration" - }, - "migration": { - "$ref": "#/components/schemas/OccmMigration" - }, - "evaluation_ontap_licenses": { - "$ref": "#/components/schemas/EvaluationOntapLicenses" - }, - "mediatorUpgradeConfiguration": { - "$ref": "#/components/schemas/MediatorUpgradeConfiguration" - }, - "instanceConfiguration": { - "$ref": "#/components/schemas/InstanceConfiguration" - }, - "cvsRegions": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CvsRegion" - } - }, - "regions": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - }, - "servicesInformation": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "$ref": "#/components/schemas/ServiceInfo" - } - }, - "ontapBackupTokenCreds": { - "$ref": "#/components/schemas/OntapBackupTokenCreds" - }, - "zrsRegions": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/Region" - } - } - } - }, - "OccmFeaturesFlags": { - "required": [ - "intercom" - ], - "type": "object", - "properties": { - "intercom": { - "type": "boolean" - }, - "aws_environment_collector": { - "type": "boolean" - } - } - }, - "OccmMigration": { - "type": "object", - "properties": { - "migrateAll": { - "type": "boolean" - }, - "blackList": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "OnCloudUpgradePath": { - "required": [ - "path" - ], - "type": "object", - "properties": { - "version": { - "type": "string" - }, - "path": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "OntapBackupTokenCreds": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "secret": { - "type": "string" - } - } - }, - "ProviderLegacyInstanceTypes": { - "type": "object", - "properties": { - "aws": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "azure": { - "type": "array", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "ServiceInfo": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "requireClientInfra": { - "type": "boolean" - }, - "cloudProvider": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "metadata": { - "$ref": "#/components/schemas/MapStringString" - }, - "localSupport": { - "$ref": "#/components/schemas/LocalServiceInfo" - }, - "darksiteSupport": { - "$ref": "#/components/schemas/LocalServiceInfo" - } - } - }, - "About": { - "required": [ - "beta", - "buildTimestamp", - "releaseNumber", - "serverTimeZone", - "siteIdentifier", - "version" - ], - "type": "object", - "properties": { - "version": { - "type": "string" - }, - "build": { - "type": "string" - }, - "buildTimestamp": { - "type": "integer", - "format": "int64" - }, - "systemId": { - "type": "string" - }, - "environment": { - "type": "string" - }, - "siteIdentifier": { - "$ref": "#/components/schemas/SiteIdentifier" - }, - "serverTimeZone": { - "$ref": "#/components/schemas/ServerTimeZone" - }, - "beta": { - "type": "boolean" - }, - "releaseNumber": { - "type": "integer", - "format": "int32" - }, - "simplicatorUrl": { - "type": "string" - }, - "migrationPerformed": { - "type": "boolean" - }, - "demoMode": { - "type": "boolean" - }, - "usingDockerInfra": { - "type": "boolean" - }, - "privateIp": { - "type": "string" - }, - "isLegacySM": { - "type": "boolean" - } - } - }, - "ServerTimeZone": { - "type": "object", - "properties": { - "timeZoneName": { - "type": "string" - }, - "formattedTimeZone": { - "type": "string" - } - } - }, - "SiteIdentifier": { - "type": "object", - "properties": { - "company": { - "type": "string" - }, - "host": { - "type": "string" - }, - "site": { - "type": "string" - } - } - }, - "AlertsAndNotificationServiceInformation": { - "type": "object", - "properties": { - "url": { - "type": "string" - } - } - }, - "Auth0Information": { - "type": "object", - "properties": { - "domain": { - "type": "string" - }, - "audience": { - "type": "string" - }, - "clientId": { - "type": "string" - } - } - }, - "CvsServiceInformation": { - "type": "object", - "properties": { - "url": { - "type": "string" - } - } - }, - "IpaServiceInformation": { - "type": "object", - "properties": { - "url": { - "type": "string" - } - } - }, - "LicenseServiceInformation": { - "type": "object", - "properties": { - "url": { - "type": "string" - } - } - }, - "MapStringMapStringObject": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "$ref": "#/components/schemas/MapStringObject" - } - }, - "NotificationServiceInformation": { - "type": "object", - "properties": { - "wsUrl": { - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "PortalInformation": { - "type": "object", - "properties": { - "edit_user_url": { - "type": "string" - }, - "portalBackEnd": { - "type": "string" - }, - "portalFrontEnd": { - "type": "string" - } - } - }, - "PortalService": { - "type": "object", - "properties": { - "usePortalAuthentication": { - "type": "boolean" - }, - "auth0Information": { - "$ref": "#/components/schemas/Auth0Information" - }, - "portalInformation": { - "$ref": "#/components/schemas/PortalInformation" - }, - "saasFrontEnd": { - "type": "string" - } - } - }, - "SaasMpServiceInformation": { - "type": "object", - "properties": { - "productUrlAws": { - "type": "string" - }, - "productUrlGcp": { - "type": "string" - }, - "url": { - "type": "string" - }, - "productUrlAzure": { - "type": "string" - }, - "productUrlAwsContract": { - "type": "string" - } - } - }, - "ServiceInformationUrl": { - "type": "object", - "properties": { - "url": { - "type": "string" - } - } - }, - "SetupInfo": { - "type": "object", - "properties": { - "isSetup": { - "type": "boolean" - }, - "isPendingConnectivitySet": { - "type": "boolean" - }, - "needCertificate": { - "type": "boolean" - }, - "runningInDocker": { - "type": "boolean" - } - } - }, - "SupportServices": { - "required": [ - "asupEnabled", - "portalService", - "servicesInformation", - "setupInfo" - ], - "type": "object", - "properties": { - "asupEnabled": { - "type": "boolean" - }, - "cognitoEnabled": { - "type": "boolean" - }, - "kinesisEnabled": { - "type": "boolean" - }, - "intercomEnabled": { - "type": "boolean" - }, - "liveChatEnabled": { - "type": "boolean" - }, - "volumeViewEnabled": { - "type": "boolean" - }, - "portalService": { - "$ref": "#/components/schemas/PortalService" - }, - "intercomAppId": { - "type": "string" - }, - "tenancyServiceInformation": { - "$ref": "#/components/schemas/TenancyServiceInformation" - }, - "saasMpServiceInformation": { - "$ref": "#/components/schemas/SaasMpServiceInformation" - }, - "cvsInformation": { - "type": "string" - }, - "complianceEnabled": { - "type": "boolean" - }, - "ipaServiceInformation": { - "$ref": "#/components/schemas/IpaServiceInformation" - }, - "licenseServiceInformation": { - "$ref": "#/components/schemas/LicenseServiceInformation" - }, - "servicesInformation": { - "type": "object", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "additionalProperties": { - "$ref": "#/components/schemas/MapStringObject" - } - }, - "setupInfo": { - "$ref": "#/components/schemas/SetupInfo" - }, - "useCompliancePrivateIpContainerMode": { - "type": "boolean" - }, - "notificationServiceInformation": { - "$ref": "#/components/schemas/NotificationServiceInformation" - }, - "alertsAndNotificationServiceInformation": { - "$ref": "#/components/schemas/AlertsAndNotificationServiceInformation" - }, - "credentialsServiceInformation": { - "$ref": "#/components/schemas/ServiceInformationUrl" - }, - "cvsServiceInformation": { - "$ref": "#/components/schemas/CvsServiceInformation" - }, - "platformServiceInformation": { - "$ref": "#/components/schemas/ServiceInformationUrl" - } - } - }, - "TenancyServiceInformation": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "url": { - "type": "string" - }, - "urlV4": { - "type": "string" - }, - "accountWidgetUrl": { - "type": "string" - }, - "agentsMgmtUrl": { - "type": "string" - }, - "forwarderUrlOverride": { - "type": "string" - } - } - }, - "InstancePlacementResponse": { - "type": "object", - "properties": { - "region": { - "type": "string" - }, - "vpcId": { - "type": "string" - }, - "subnetId": { - "type": "string" - }, - "keyPair": { - "type": "string" - }, - "installLocation": { - "type": "string" - }, - "role": { - "type": "string" - }, - "providerRoleType": { - "type": "string" - }, - "publicIp": { - "type": "string" - }, - "account": { - "type": "string" - }, - "govCloud": { - "type": "boolean" - }, - "china": { - "type": "boolean" - }, - "isLegacyInstance": { - "type": "boolean" - }, - "instanceType": { - "type": "string" - }, - "isLegacyOs": { - "type": "boolean" - }, - "darkSite": { - "type": "boolean" - } - } - }, - "UpdateServiceUser": { - "required": [ - "cloudManagerNotificationsOptIn" - ], - "type": "object", - "properties": { - "cloudManagerNotificationsOptIn": { - "type": "boolean" - } - } - }, - "SeqWorkspaceResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/WorkspaceResponse" - } - }, - "WorkspaceResponse": { - "required": [ - "associatedToAgent", - "workspacePublicId" - ], - "type": "object", - "properties": { - "workspacePublicId": { - "type": "string" - }, - "workspaceName": { - "type": "string" - }, - "associatedToAgent": { - "type": "boolean" - } - } - }, - "CommonDiskProperties": { - "type": "object", - "properties": { - "diskType": { - "type": "string" - }, - "sizeKB": { - "type": "integer", - "format": "int64" - }, - "rpm": { - "type": "object" - } - } - }, - "OnPremAggregateResponse": { - "required": [ - "isInactiveDataReportingEnabled", - "name", - "snaplockType", - "totalCapacity" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "totalCapacity": { - "$ref": "#/components/schemas/Capacity" - }, - "availableCapacity": { - "$ref": "#/components/schemas/Capacity" - }, - "state": { - "type": "string" - }, - "isInactiveDataReportingEnabled": { - "type": "boolean" - }, - "isObjectStoreAttachEligible": { - "type": "boolean" - }, - "objectStoreName": { - "type": "string" - }, - "usedCapacity": { - "$ref": "#/components/schemas/Capacity" - }, - "snaplockType": { - "type": "string" - }, - "tieringRestriction": { - "$ref": "#/components/schemas/TieringRestriction" - }, - "availabilityState": { - "type": "string" - }, - "commonDiskProperties": { - "$ref": "#/components/schemas/CommonDiskProperties" - } - } - }, - "SeqOnPremAggregateResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/OnPremAggregateResponse" - } - }, - "TieringRestriction": { - "type": "object", - "properties": { - "isTieringRestricted": { - "type": "boolean" - }, - "restrictionReason": { - "type": "string" - } - } - }, - "ClusterInfoResponse": { - "required": [ - "isAdmin", - "nodeModels", - "serialNumber" - ], - "type": "object", - "properties": { - "serialNumber": { - "type": "string" - }, - "clusterName": { - "type": "string" - }, - "clusterUuid": { - "type": "string" - }, - "ontapVersion": { - "type": "string" - }, - "nodeModels": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "isAdmin": { - "type": "boolean" - }, - "clusterIp": { - "type": "string" - } - } - }, - "OnPremVolumeModifyRequest": { - "type": "object", - "properties": { - "snapshotPolicyName": { - "type": "string" - }, - "shareInfo": { - "$ref": "#/components/schemas/CifsShareInfo" - }, - "exportPolicyInfo": { - "$ref": "#/components/schemas/NamedExportPolicyInfo" - }, - "tieringPolicy": { - "type": "string" - }, - "minimumCoolingDays": { - "type": "integer", - "format": "int32" - } - } - }, - "OnPremVolumeCreateRequest": { - "required": [ - "enableCompression", - "enableDeduplication", - "enableThinProvisioning", - "size", - "snapshotPolicyName", - "svmName", - "syncToS3", - "volumeTags", - "workingEnvironmentId" - ], - "type": "object", - "properties": { - "workingEnvironmentId": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "aggregateName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "size": { - "$ref": "#/components/schemas/PositiveCapacity" - }, - "initialSize": { - "$ref": "#/components/schemas/Capacity" - }, - "snapshotPolicyName": { - "type": "string" - }, - "exportPolicyInfo": { - "$ref": "#/components/schemas/ExportPolicyInfo" - }, - "shareInfo": { - "$ref": "#/components/schemas/CreateCifsShareInfoRequest" - }, - "iscsiInfo": { - "$ref": "#/components/schemas/CreateIscsiInfoRequest" - }, - "enableThinProvisioning": { - "type": "boolean" - }, - "enableCompression": { - "type": "boolean" - }, - "enableDeduplication": { - "type": "boolean" - }, - "syncToS3": { - "type": "boolean" - }, - "volumeTags": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/VolumeTags" - } - }, - "flexGroupVolumeInfo": { - "$ref": "#/components/schemas/FlexGroupVolumeInfo" - } - } - }, - "AzureCloudBackupSetupRequest": { - "type": "object", - "properties": { - "rgName": { - "type": "string" - }, - "ipSpace": { - "type": "string" - }, - "region": { - "type": "string" - }, - "subscriptionId": { - "type": "string" - } - } - }, - "AwsCloudBackupSetupRequest": { - "required": [ - "awsAccessKeys" - ], - "type": "object", - "properties": { - "awsAccessKeys": { - "$ref": "#/components/schemas/AwsAccessKeys" - }, - "ipSpace": { - "type": "string" - } - } - }, - "GcpCloudBackupSetupRequest": { - "type": "object", - "properties": { - "project": { - "type": "string" - }, - "region": { - "type": "string" - }, - "accessKey": { - "type": "string" - }, - "secretKey": { - "type": "string" - }, - "ipSpace": { - "type": "string" - } - } - }, - "SgwsCloudBackupSetupRequest": { - "required": [ - "sgwsCredentials" - ], - "type": "object", - "properties": { - "sgwsCredentials": { - "$ref": "#/components/schemas/SgwsCredentialsRequest" - }, - "ipSpace": { - "type": "string" - } - } - }, - "SgwsCredentialsRequest": { - "required": [ - "accessKey", - "secretKey" - ], - "type": "object", - "properties": { - "accessKey": { - "type": "string" - }, - "secretKey": { - "type": "string" - }, - "serviceUrl": { - "type": "string" - } - } - }, - "IpSpaceResponse": { - "required": [ - "ipSpace", - "vservers" - ], - "type": "object", - "properties": { - "ipSpace": { - "type": "string" - }, - "vservers": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "SeqIpSpaceResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/IpSpaceResponse" - } - }, - "OnPremWorkingEnvironmentDiscoverRequest": { - "required": [ - "location", - "tenantId" - ], - "type": "object", - "properties": { - "tenantId": { - "type": "string" - }, - "description": { - "type": "string" - }, - "name": { - "type": "string" - }, - "clusterAddress": { - "type": "string" - }, - "clusterUserName": { - "type": "string" - }, - "clusterPassword": { - "type": "string" - }, - "location": { - "type": "string" - } - } - }, - "SeqSnapMirrorPolicyResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapMirrorPolicyResponse" - } - }, - "SeqSnapMirrorRuleResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapMirrorRuleResponse" - } - }, - "SnapMirrorPolicyResponse": { - "required": [ - "name", - "rules" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "comment": { - "type": "string" - }, - "policyType": { - "type": "string" - }, - "rules": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SnapMirrorRuleResponse" - } - }, - "isDefault": { - "type": "boolean" - }, - "isSupported": { - "type": "boolean" - }, - "reason": { - "type": "string" - } - } - }, - "SnapMirrorRuleResponse": { - "required": [ - "retention" - ], - "type": "object", - "properties": { - "snapMirrorLabel": { - "type": "string" - }, - "retention": { - "type": "integer", - "format": "int32" - } - } - }, - "CreateReplicationRequestToFsx": { - "required": [ - "replicationRequest", - "replicationVolume" - ], - "type": "object", - "properties": { - "replicationRequest": { - "$ref": "#/components/schemas/ReplicationToFsxRequest" - }, - "replicationVolume": { - "$ref": "#/components/schemas/FsxVolumeRequest" - } - } - }, - "FsxVolumeRequest": { - "required": [ - "destinationSvmName", - "destinationVolumeName", - "sourceSvmName", - "sourceVolumeName" - ], - "type": "object", - "properties": { - "sourceSvmName": { - "type": "string" - }, - "sourceVolumeName": { - "type": "string" - }, - "destinationVolumeName": { - "type": "string" - }, - "destinationSvmName": { - "type": "string" - }, - "tieringPolicy": { - "type": "string" - }, - "minimumCoolingDays": { - "type": "object" - } - } - }, - "ReplicationToFsxRequest": { - "required": [ - "destinationFsxId", - "policyName", - "sourceInterclusterLifIps", - "sourceWorkingEnvironmentId" - ], - "type": "object", - "properties": { - "sourceWorkingEnvironmentId": { - "type": "string" - }, - "destinationFsxId": { - "type": "string" - }, - "sourceInterclusterLifIps": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "policyName": { - "type": "string" - }, - "scheduleName": { - "type": "string" - }, - "maxTransferRate": { - "type": "integer", - "format": "int32" - }, - "sourceIpSpace": { - "type": "string" - } - } - }, - "CreateReplicationRequestToOnPrem": { - "required": [ - "replicationRequest", - "replicationVolume" - ], - "type": "object", - "properties": { - "replicationRequest": { - "$ref": "#/components/schemas/ReplicationRequest" - }, - "replicationVolume": { - "$ref": "#/components/schemas/OnPremVolumeRequest" - } - } - }, - "OnPremVolumeRequest": { - "required": [ - "destinationAggregateName", - "destinationSvmName", - "destinationVolumeName", - "sourceSvmName", - "sourceVolumeName" - ], - "type": "object", - "properties": { - "sourceSvmName": { - "type": "string" - }, - "sourceVolumeName": { - "type": "string" - }, - "destinationVolumeName": { - "type": "string" - }, - "destinationAggregateName": { - "type": "string" - }, - "destinationSvmName": { - "type": "string" - }, - "destinationCapacityTier": { - "type": "string" - }, - "tieringPolicy": { - "type": "string" - }, - "minimumCoolingDays": { - "type": "object" - } - } - }, - "ReplicationRequest": { - "required": [ - "destinationInterclusterLifIps", - "destinationWorkingEnvironmentId", - "policyName", - "sourceInterclusterLifIps", - "sourceWorkingEnvironmentId" - ], - "type": "object", - "properties": { - "sourceWorkingEnvironmentId": { - "type": "string" - }, - "destinationWorkingEnvironmentId": { - "type": "string" - }, - "sourceInterclusterLifIps": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "destinationInterclusterLifIps": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "policyName": { - "type": "string" - }, - "scheduleName": { - "type": "string" - }, - "maxTransferRate": { - "type": "integer", - "format": "int32" - }, - "sourceIpSpace": { - "type": "string" - }, - "destinationIpSpace": { - "type": "string" - } - } - }, - "CreateReplicationRequestToVsa": { - "required": [ - "replicationRequest", - "replicationVolume" - ], - "type": "object", - "properties": { - "replicationRequest": { - "$ref": "#/components/schemas/ReplicationRequest" - }, - "replicationVolume": { - "$ref": "#/components/schemas/VsaVolumeRequest" - } - } - }, - "VsaVolumeRequest": { - "required": [ - "advancedMode", - "destinationAggregateName", - "destinationVolumeName", - "numOfDisksApprovedToAdd", - "sourceSvmName", - "sourceVolumeName" - ], - "type": "object", - "properties": { - "sourceSvmName": { - "type": "string" - }, - "sourceVolumeName": { - "type": "string" - }, - "destinationVolumeName": { - "type": "string" - }, - "destinationAggregateName": { - "type": "string" - }, - "numOfDisksApprovedToAdd": { - "type": "integer", - "format": "int32" - }, - "evCapacityApprovedToAdd": { - "$ref": "#/components/schemas/ElasticVolumeQuoteInfo" - }, - "advancedMode": { - "type": "boolean" - }, - "destinationProviderVolumeType": { - "type": "string" - }, - "destinationCapacityTier": { - "type": "string" - }, - "destinationSvmName": { - "type": "string" - }, - "iops": { - "type": "integer", - "format": "int32" - }, - "throughput": { - "type": "integer", - "format": "int32" - }, - "tieringPolicy": { - "type": "string" - }, - "minimumCoolingDays": { - "type": "object" - } - } - }, - "SourceSnapmirrorEndpoint": { - "required": [ - "sourceSvmName", - "sourceVolumeName", - "sourceWorkingEnvironmentId" - ], - "type": "object", - "properties": { - "sourceWorkingEnvironmentId": { - "type": "string" - }, - "sourceSvmName": { - "type": "string" - }, - "sourceVolumeName": { - "type": "string" - } - } - }, - "ReplicationUpdateRequest": { - "type": "object", - "properties": { - "schedule": { - "type": "string" - }, - "maxTransferRate": { - "type": "integer", - "format": "int32" - } - } - }, - "CronJobScheduleResponse": { - "required": [ - "days", - "hours", - "minutes", - "months", - "weekDays" - ], - "type": "object", - "properties": { - "months": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "integer", - "format": "int32" - } - }, - "days": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "integer", - "format": "int32" - } - }, - "weekDays": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "integer", - "format": "int32" - } - }, - "hours": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "integer", - "format": "int32" - } - }, - "minutes": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "integer", - "format": "int32" - } - } - } - }, - "ReplicationSchedule": { - "required": [ - "cronJobSchedule", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "cronJobSchedule": { - "$ref": "#/components/schemas/CronJobScheduleResponse" - } - } - }, - "SeqReplicationSchedule": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ReplicationSchedule" - } - }, - "ReplicationInterClusterLif": { - "required": [ - "address", - "isPeered", - "name", - "netmaskLength", - "node", - "port", - "status" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "address": { - "type": "string" - }, - "netmaskLength": { - "type": "integer", - "format": "int32" - }, - "port": { - "type": "string" - }, - "node": { - "type": "string" - }, - "status": { - "type": "string" - }, - "isPeered": { - "type": "boolean" - } - } - }, - "ReplicationInterClusterLifs": { - "required": [ - "interClusterLifs", - "peerInterClusterLifs" - ], - "type": "object", - "properties": { - "interClusterLifs": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ReplicationInterClusterLif" - } - }, - "peerInterClusterLifs": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ReplicationInterClusterLif" - } - } - } - }, - "SeqReplicationInterClusterLif": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ReplicationInterClusterLif" - } - }, - "Duration": { - "type": "object", - "properties": { - "length": { - "type": "integer", - "format": "int64" - }, - "unit": { - "type": "string" - } - } - }, - "ReplicationStatusCurrentTransferInfo": { - "required": [ - "transferError", - "transferPriority", - "transferType" - ], - "type": "object", - "properties": { - "transferType": { - "type": "string" - }, - "transferPriority": { - "type": "string" - }, - "transferError": { - "type": "string" - } - } - }, - "ReplicationStatusLastTransferInfo": { - "required": [ - "transferDuration", - "transferEnded", - "transferError", - "transferSize", - "transferType" - ], - "type": "object", - "properties": { - "transferType": { - "type": "string" - }, - "transferSize": { - "$ref": "#/components/schemas/Capacity" - }, - "transferDuration": { - "$ref": "#/components/schemas/Duration" - }, - "transferEnded": { - "type": "string", - "format": "date-time" - }, - "transferError": { - "type": "string" - } - } - }, - "ReplicationStatusResponse": { - "required": [ - "currentTransferInfo", - "destination", - "healthy", - "lagTime", - "lastTransferInfo", - "maxTransferRate", - "mirrorState", - "networkCompressionRatio", - "newestSnapshotCreated", - "newestSnapshotName", - "policy", - "policyType", - "relationshipProgress", - "relationshipStatus", - "relationshipType", - "schedule", - "source", - "totalTransferSize", - "totalTransferTime", - "unhealthyReason", - "volumeCapacityTier", - "volumeUsedSize" - ], - "type": "object", - "properties": { - "source": { - "$ref": "#/components/schemas/ReplicationStatusSide" - }, - "destination": { - "$ref": "#/components/schemas/ReplicationStatusSide" - }, - "mirrorState": { - "type": "string" - }, - "relationshipType": { - "type": "string" - }, - "relationshipStatus": { - "type": "string" - }, - "relationshipProgress": { - "$ref": "#/components/schemas/Capacity" - }, - "policy": { - "type": "string" - }, - "policyType": { - "type": "string" - }, - "schedule": { - "type": "string" - }, - "maxTransferRate": { - "$ref": "#/components/schemas/Capacity" - }, - "networkCompressionRatio": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "unhealthyReason": { - "type": "string" - }, - "lagTime": { - "$ref": "#/components/schemas/Duration" - }, - "newestSnapshotName": { - "type": "string" - }, - "newestSnapshotCreated": { - "type": "string", - "format": "date-time" - }, - "lastTransferInfo": { - "$ref": "#/components/schemas/ReplicationStatusLastTransferInfo" - }, - "currentTransferInfo": { - "$ref": "#/components/schemas/ReplicationStatusCurrentTransferInfo" - }, - "totalTransferTime": { - "$ref": "#/components/schemas/Duration" - }, - "totalTransferSize": { - "$ref": "#/components/schemas/Capacity" - }, - "volumeUsedSize": { - "$ref": "#/components/schemas/Capacity" - }, - "volumeCapacityTier": { - "$ref": "#/components/schemas/Capacity" - } - } - }, - "ReplicationStatusSide": { - "type": "object", - "properties": { - "workingEnvironmentId": { - "type": "string" - }, - "workingEnvironmentType": { - "type": "string" - }, - "workingEnvironmentStatus": { - "type": "string" - }, - "clusterName": { - "type": "string" - }, - "region": { - "type": "string" - }, - "availabilityZone": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "svmPeerAliasName": { - "type": "string" - }, - "nodeName": { - "type": "string" - }, - "volumeName": { - "type": "string" - } - } - }, - "SeqReplicationStatusResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/ReplicationStatusResponse" - } - }, - "UpdateSubscriptionRequest": { - "required": [ - "subscriptionId" - ], - "type": "object", - "properties": { - "subscriptionId": { - "type": "string" - } - } - }, - "DescribeCvoSubscriptionResponse": { - "type": "object", - "properties": { - "subscription": { - "$ref": "#/components/schemas/SubscriptionResponse" - }, - "freeTrialExpiry": { - "type": "object" - } - } - }, - "SubscriptionResponse": { - "required": [ - "active", - "byNodeMode", - "contract", - "id", - "name", - "provider" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "provider": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "contract": { - "type": "boolean" - }, - "byNodeMode": { - "type": "boolean" - } - } - }, - "SaasMpAccountResponse": { - "required": [ - "awsSubscriptions", - "azureSubscriptions", - "cloudAccounts", - "eligibleForFreeTrialAws", - "eligibleForFreeTrialAzure", - "eligibleForFreeTrialGcp", - "gcpSubscriptions" - ], - "type": "object", - "properties": { - "awsSubscriptions": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SubscriptionResponse" - } - }, - "azureSubscriptions": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SubscriptionResponse" - } - }, - "gcpSubscriptions": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SubscriptionResponse" - } - }, - "eligibleForFreeTrialAws": { - "type": "boolean" - }, - "eligibleForFreeTrialGcp": { - "type": "boolean" - }, - "eligibleForFreeTrialAzure": { - "type": "boolean" - }, - "cloudAccounts": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/CloudAccountResponse" - } - } - } - }, - "SeqSubscriptionResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/SubscriptionResponse" - } - }, - "ProxyUri": { - "type": "object", - "properties": { - "uri": { - "type": "string" - }, - "proxyUserName": { - "type": "string" - }, - "proxyPassword": { - "type": "string" - }, - "proxyDomain": { - "type": "string" - } - } - }, - "InitialSetupResponse": { - "type": "object", - "properties": { - "upgradeToVersion": { - "type": "string" - } - } - }, - "PortalSetupAsServiceConnectorRequest": { - "required": [ - "proxyUrl" - ], - "type": "object", - "properties": { - "site": { - "type": "string" - }, - "company": { - "type": "string" - }, - "tenancyAccountId": { - "type": "string" - }, - "proxyUrl": { - "$ref": "#/components/schemas/ProxyUri" - } - } - }, - "LocalAuthSetupRequest": { - "required": [ - "adminUser" - ], - "type": "object", - "properties": { - "adminUser": { - "$ref": "#/components/schemas/LocalAuthSetupUserRequest" - }, - "site": { - "type": "string" - }, - "company": { - "type": "string" - } - } - }, - "LocalAuthSetupUserRequest": { - "required": [ - "fullName" - ], - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "password": { - "type": "string" - }, - "fullName": { - "type": "string" - } - } - }, - "RegistrationResponse": { - "required": [ - "clientId" - ], - "type": "object", - "properties": { - "clientId": { - "type": "string" - } - } - }, - "SetProxyRequest": { - "required": [ - "uri" - ], - "type": "object", - "properties": { - "uri": { - "type": "string" - }, - "proxyUserName": { - "type": "string" - }, - "proxyPassword": { - "type": "string" - }, - "proxyDomain": { - "type": "string" - } - } - }, - "TenantResponse": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "publicId": { - "type": "string" - }, - "workingEnvironmentsInformation": { - "$ref": "#/components/schemas/WorkingEnvironmentsInformation" - } - } - }, - "WorkingEnvironmentsInformation": { - "type": "object", - "properties": { - "regionsCount": { - "type": "integer", - "format": "int32" - }, - "totalReservedSize": { - "$ref": "#/components/schemas/Capacity" - }, - "workingEnvironmentsCount": { - "type": "integer", - "format": "int32" - } - } - }, - "SetNssKeysRequest": { - "type": "object", - "properties": { - "nssUserName": { - "type": "string" - }, - "nssPassword": { - "type": "string" - } - } - }, - "UpdateTenantRequest": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "costCenter": { - "type": "string" - } - } - }, - "AddTenantRequest": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "costCenter": { - "type": "string" - }, - "nssKeys": { - "$ref": "#/components/schemas/SetNssKeysRequest" - } - } - }, - "SeqTenantResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/TenantResponse" - } - }, - "UpdateUserRequest": { - "type": "object", - "properties": { - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "email": { - "type": "string" - }, - "ldapUserName": { - "type": "string" - }, - "notificationsOptIn": { - "type": "boolean" - } - } - }, - "GrantPermission": { - "required": [ - "addWorkingEnvironments", - "removeWorkingEnvironments" - ], - "type": "object", - "properties": { - "addWorkingEnvironments": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "removeWorkingEnvironments": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - } - } - }, - "ResetUserPasswordRequest": { - "type": "object", - "properties": { - "password": { - "type": "string" - } - } - }, - "AddPortalUserRequest": { - "required": [ - "roleId" - ], - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "roleId": { - "type": "string" - }, - "tenantId": { - "type": "string" - } - } - }, - "AzureCredentialsRequest": { - "type": "object", - "properties": { - "subscriptionId": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "applicationId": { - "type": "string" - }, - "applicationKey": { - "type": "string" - } - } - }, - "UserRequest": { - "required": [ - "isLdap", - "roleId" - ], - "type": "object", - "properties": { - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "email": { - "type": "string" - }, - "roleId": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "password": { - "type": "string" - }, - "accessKey": { - "type": "string" - }, - "secretKey": { - "type": "string" - }, - "s3Bucket": { - "type": "string" - }, - "azureCredentials": { - "$ref": "#/components/schemas/AzureCredentialsRequest" - }, - "isLdap": { - "type": "boolean" - }, - "ldapUserName": { - "type": "string" - }, - "notificationsOptIn": { - "type": "boolean" - } - } - }, - "SeqUserResponse": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/UserResponse" - } - }, - "RecoverAzureVSARequest": { - "required": [ - "clusterCredentials", - "region" - ], - "type": "object", - "properties": { - "region": { - "type": "string" - }, - "id": { - "type": "string" - }, - "resourceGroupName": { - "type": "string" - }, - "instanceName": { - "type": "string" - }, - "clusterCredentials": { - "$ref": "#/components/schemas/ClusterCredentialsRequest" - }, - "tenantId": { - "type": "string" - }, - "providerAccount": { - "type": "string" - }, - "cloudProviderAccount": { - "type": "string" - }, - "nssAccountId": { - "type": "string" - } - } - }, - "DiscoveredAzureVSAResponse": { - "required": [ - "name", - "recoverable" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - }, - "publicId": { - "type": "string" - }, - "region": { - "type": "string" - }, - "vnetName": { - "type": "string" - }, - "vnetId": { - "type": "string" - }, - "subnetId": { - "type": "string" - }, - "subnetName": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "clusterAddress": { - "type": "string" - }, - "recoverable": { - "type": "boolean" - }, - "byol": { - "type": "boolean" - }, - "registered": { - "type": "boolean" - } - } - }, - "SeqDiscoveredAzureVSAResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DiscoveredAzureVSAResponse" - } - }, - "DiscoveredVsaResponse": { - "required": [ - "name", - "recoverable" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "publicId": { - "type": "string" - }, - "region": { - "type": "string" - }, - "vpcName": { - "type": "string" - }, - "vpcId": { - "type": "string" - }, - "availabilityZone": { - "type": "string" - }, - "subnetId": { - "type": "string" - }, - "stackName": { - "type": "string" - }, - "stackId": { - "type": "string" - }, - "clusterAddress": { - "type": "string" - }, - "recoverable": { - "type": "boolean" - }, - "isByol": { - "type": "boolean" - }, - "registered": { - "type": "boolean" - } - } - }, - "SeqDiscoveredVsaResponse": { - "required": [ - "traversableAgain" - ], - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/DiscoveredVsaResponse" - } - }, - "CreateVSAWorkingEnvironmentRequest": { - "required": [ - "awsTags", - "dataEncryptionType", - "ebsVolumeSize", - "ebsVolumeType", - "enableCompliance", - "enableMonitoring", - "subnetId", - "vpcId", - "vsaMetadata" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "svmPassword": { - "type": "string" - }, - "username": { - "$ref": "#/components/schemas/AdminUsername" - }, - "vpcId": { - "type": "string" - }, - "description": { - "type": "string" - }, - "volume": { - "$ref": "#/components/schemas/VsaVolumeOnNewVsaCreateRequest" - }, - "region": { - "type": "string" - }, - "tenantId": { - "type": "string" - }, - "subnetId": { - "type": "string" - }, - "dataEncryptionType": { - "type": "string" - }, - "ontapEncryptionParameters": { - "$ref": "#/components/schemas/OntapEncryption" - }, - "awsEncryptionParameters": { - "$ref": "#/components/schemas/AwsEncryption" - }, - "securityGroupId": { - "type": "string" - }, - "openSecurityGroup": { - "type": "object" - }, - "vsaMetadata": { - "$ref": "#/components/schemas/VsaMetadataRequest" - }, - "cifsConfigurationRequest": { - "$ref": "#/components/schemas/CIFSConfigurationRequest" - }, - "ebsVolumeSize": { - "$ref": "#/components/schemas/Capacity" - }, - "ebsVolumeType": { - "type": "string" - }, - "awsTags": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "$ref": "#/components/schemas/AwsTag" - } - }, - "writingSpeedState": { - "type": "string" - }, - "optimizedNetworkUtilization": { - "type": "boolean" - }, - "clusterKeyPairName": { - "type": "string" - }, - "instanceTenancy": { - "type": "string" - }, - "failedToCreateWorkingEnvironmentId": { - "type": "string" - }, - "capacityTier": { - "type": "string" - }, - "iops": { - "type": "integer", - "format": "int32" - }, - "throughput": { - "type": "integer", - "format": "int32" - }, - "packageName": { - "type": "string" - }, - "instanceProfileName": { - "type": "string" - }, - "roleArn": { - "type": "string" - }, - "svmName": { - "type": "string" - }, - "wormRequest": { - "$ref": "#/components/schemas/WormRequest" - }, - "cloudProviderAccount": { - "type": "string" - }, - "nssAccount": { - "type": "string" - }, - "saasSubscriptionId": { - "type": "string" - }, - "backupVolumesToCbs": { - "type": "boolean" - }, - "disableEv": { - "type": "boolean" - }, - "enableCompliance": { - "type": "boolean" - }, - "tierLevel": { - "type": "string" - }, - "enableMonitoring": { - "type": "boolean" - }, - "enableServices": { - "type": "array", - "properties": { - "traversableAgain": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - } - }, - "items": { - "type": "string" - } - }, - "ontapEncryptionDefined": { - "type": "boolean" - } - } - } - } - } -} \ No newline at end of file diff --git a/cvo/delete-accounts-.adoc b/cvo/delete-accounts-.adoc new file mode 100644 index 00000000..ae1235c2 --- /dev/null +++ b/cvo/delete-accounts-.adoc @@ -0,0 +1,44 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-accounts-.html' +summary: 'Delete an existing account' +--- + += Delete an existing account + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/accounts/{cloudProviderAccountId}`# + + + +Deletes an existing account. You cannot delete an account that is attached to systems. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudProviderAccountId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-aws-ha-aggregates-.adoc b/cvo/delete-aws-ha-aggregates-.adoc new file mode 100644 index 00000000..92f361b5 --- /dev/null +++ b/cvo/delete-aws-ha-aggregates-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-aws-ha-aggregates-.html' +summary: 'Delete an aggregate' +--- + += Delete an aggregate + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}`# + + + +Deletes an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-aws-ha-encryption-key-managers-.adoc b/cvo/delete-aws-ha-encryption-key-managers-.adoc new file mode 100644 index 00000000..b88ce743 --- /dev/null +++ b/cvo/delete-aws-ha-encryption-key-managers-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-aws-ha-encryption-key-managers-.html' +summary: 'Delete a key manager from a system' +--- + += Delete a key manager from a system + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/aws/ha/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}`# + + + +Deletes a key manager from the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|keyManagerIp +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-aws-ha-volumes--.adoc b/cvo/delete-aws-ha-volumes--.adoc new file mode 100644 index 00000000..6ebce62b --- /dev/null +++ b/cvo/delete-aws-ha-volumes--.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-aws-ha-volumes--.html' +summary: 'Delete an existing volume' +--- + += Delete an existing volume + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Deletes an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-aws-ha-volumes--snapshot.adoc b/cvo/delete-aws-ha-volumes--snapshot.adoc new file mode 100644 index 00000000..f052085b --- /dev/null +++ b/cvo/delete-aws-ha-volumes--snapshot.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-aws-ha-volumes--snapshot.html' +summary: 'Delete a snapshot' +--- + += Delete a snapshot + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Deletes a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|array[string] +|True +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-aws-ha-working-environments-.adoc b/cvo/delete-aws-ha-working-environments-.adoc new file mode 100644 index 00000000..57908a20 --- /dev/null +++ b/cvo/delete-aws-ha-working-environments-.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-aws-ha-working-environments-.html' +summary: 'Delete an existing system' +--- + += Delete an existing system + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}`# + + + +Deletes an existing Cloud Volumes ONTAP system, including all cloud resources created for the system (unless the localDelete flag is set to true). + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|localDelete +|boolean +|query +|False +a| + +|forceDelete +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-aws-ha-working-environments-extra-capacity-serials.adoc b/cvo/delete-aws-ha-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..0f64a05c --- /dev/null +++ b/cvo/delete-aws-ha-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-aws-ha-working-environments-extra-capacity-serials.html' +summary: 'Delete extra capacity licenses using the serial number' +--- + += Delete extra capacity licenses using the serial number + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Deletes extra capacity licenses by serial numbers. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-aws-ha-working-environments-fpolicy.adoc b/cvo/delete-aws-ha-working-environments-fpolicy.adoc new file mode 100644 index 00000000..544eb424 --- /dev/null +++ b/cvo/delete-aws-ha-working-environments-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-aws-ha-working-environments-fpolicy.html' +summary: 'Delete FPolicy for ransomware files' +--- + += Delete FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/fpolicy`# + + + +Deletes the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-ha-aggregates-.adoc b/cvo/delete-azure-ha-aggregates-.adoc new file mode 100644 index 00000000..60056481 --- /dev/null +++ b/cvo/delete-azure-ha-aggregates-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-ha-aggregates-.html' +summary: 'Delete an aggregate' +--- + += Delete an aggregate + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}`# + + + +Deletes an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-ha-volumes--.adoc b/cvo/delete-azure-ha-volumes--.adoc new file mode 100644 index 00000000..7577e993 --- /dev/null +++ b/cvo/delete-azure-ha-volumes--.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-ha-volumes--.html' +summary: 'Delete an existing volume' +--- + += Delete an existing volume + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Deletes an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-ha-volumes--snapshot.adoc b/cvo/delete-azure-ha-volumes--snapshot.adoc new file mode 100644 index 00000000..a24761c3 --- /dev/null +++ b/cvo/delete-azure-ha-volumes--snapshot.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-ha-volumes--snapshot.html' +summary: 'Delete a snapshot' +--- + += Delete a snapshot + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Deletes a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|array[string] +|True +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-ha-volumes-storage-vms-volumes-remove-avs.adoc b/cvo/delete-azure-ha-volumes-storage-vms-volumes-remove-avs.adoc new file mode 100644 index 00000000..57e04efe --- /dev/null +++ b/cvo/delete-azure-ha-volumes-storage-vms-volumes-remove-avs.adoc @@ -0,0 +1,103 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-ha-volumes-storage-vms-volumes-remove-avs.html' +summary: 'Remove AVS hosts on a volume' +--- + += Remove AVS hosts on a volume + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/remove-avs`# + + + +Removes Azure VMware Solution hosts on a volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|privateCloudName +|string +|True +a|Azure VMware Solution (AVS) private cloud name + + +|clusterName +|string +|True +a|Private cloud cluster name + + +|resourceGroup +|string +|True +a|Private cloud resourceGroup name + + +|dataStoreName +|string +|True +a|Private cloud DataStore name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "privateCloudName": "string", + "clusterName": "string", + "resourceGroup": "string", + "dataStoreName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-ha-working-environments-.adoc b/cvo/delete-azure-ha-working-environments-.adoc new file mode 100644 index 00000000..d3a7c38c --- /dev/null +++ b/cvo/delete-azure-ha-working-environments-.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-ha-working-environments-.html' +summary: 'Delete a system' +--- + += Delete a system + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}`# + + + +Deletes an existing Cloud Volumes ONTAP system, including all cloud resources created for the system (unless the localDelete flag is set to true). + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|localDelete +|boolean +|query +|False +a| + +|forceDelete +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-ha-working-environments-extra-capacity-serials.adoc b/cvo/delete-azure-ha-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..a9da242d --- /dev/null +++ b/cvo/delete-azure-ha-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-ha-working-environments-extra-capacity-serials.html' +summary: 'Delete extra capacity licenses by serial number' +--- + += Delete extra capacity licenses by serial number + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Deletes extra capacity licenses by serial numbers. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-ha-working-environments-fpolicy.adoc b/cvo/delete-azure-ha-working-environments-fpolicy.adoc new file mode 100644 index 00000000..0687f6b3 --- /dev/null +++ b/cvo/delete-azure-ha-working-environments-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-ha-working-environments-fpolicy.html' +summary: 'Delete FPolicy for ransomware files' +--- + += Delete FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/fpolicy`# + + + +Deletes the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-ha-working-environments-svm-.adoc b/cvo/delete-azure-ha-working-environments-svm-.adoc new file mode 100644 index 00000000..f080f198 --- /dev/null +++ b/cvo/delete-azure-ha-working-environments-svm-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-ha-working-environments-svm-.html' +summary: 'Delete an SVM' +--- + += Delete an SVM + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/svm/{svmName}`# + + + +Deletes an SVM. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-vsa-aggregates-.adoc b/cvo/delete-azure-vsa-aggregates-.adoc new file mode 100644 index 00000000..e26b2f05 --- /dev/null +++ b/cvo/delete-azure-vsa-aggregates-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-vsa-aggregates-.html' +summary: 'Delete an aggregate' +--- + += Delete an aggregate + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}`# + + + +Deletes an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-vsa-volumes--.adoc b/cvo/delete-azure-vsa-volumes--.adoc new file mode 100644 index 00000000..8df05630 --- /dev/null +++ b/cvo/delete-azure-vsa-volumes--.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-vsa-volumes--.html' +summary: 'Delete an existing volume' +--- + += Delete an existing volume + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Deletes an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-vsa-volumes--snapshot.adoc b/cvo/delete-azure-vsa-volumes--snapshot.adoc new file mode 100644 index 00000000..344923e3 --- /dev/null +++ b/cvo/delete-azure-vsa-volumes--snapshot.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-vsa-volumes--snapshot.html' +summary: 'Delete a snapshot' +--- + += Delete a snapshot + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Deletes a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|array[string] +|True +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-vsa-working-environments-.adoc b/cvo/delete-azure-vsa-working-environments-.adoc new file mode 100644 index 00000000..24996934 --- /dev/null +++ b/cvo/delete-azure-vsa-working-environments-.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-vsa-working-environments-.html' +summary: 'Delete an existing Cloud Volumes ONTAP system' +--- + += Delete an existing Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}`# + + + +Deletes an existing Cloud Volumes ONTAP system, including all cloud resources created for the system (unless the localDelete flag is set to true). + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|localDelete +|boolean +|query +|False +a| + +|forceDelete +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-vsa-working-environments-extra-capacity-serials.adoc b/cvo/delete-azure-vsa-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..9063f8b0 --- /dev/null +++ b/cvo/delete-azure-vsa-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-vsa-working-environments-extra-capacity-serials.html' +summary: 'Delete extra capacity licenses by serial numbers' +--- + += Delete extra capacity licenses by serial numbers + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Deletes extra capacity licenses by serial numbers. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-vsa-working-environments-fpolicy.adoc b/cvo/delete-azure-vsa-working-environments-fpolicy.adoc new file mode 100644 index 00000000..2169e6df --- /dev/null +++ b/cvo/delete-azure-vsa-working-environments-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-vsa-working-environments-fpolicy.html' +summary: 'Delete the FPolicy for ransomware files' +--- + += Delete the FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/fpolicy`# + + + +Deletes the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-azure-vsa-working-environments-svm-.adoc b/cvo/delete-azure-vsa-working-environments-svm-.adoc new file mode 100644 index 00000000..59b9d62b --- /dev/null +++ b/cvo/delete-azure-vsa-working-environments-svm-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-azure-vsa-working-environments-svm-.html' +summary: 'Delete an SVM' +--- + += Delete an SVM + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/svm/{svmName}`# + + + +Deletes an SVM. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-flexcache-caches-.adoc b/cvo/delete-flexcache-caches-.adoc new file mode 100644 index 00000000..4fc491ca --- /dev/null +++ b/cvo/delete-flexcache-caches-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-flexcache-caches-.html' +summary: 'Delete a FlexCache volume' +--- + += Delete a FlexCache volume + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/flexcache/{workingEnvironmentId}/caches/{cacheId}`# + + + +Deletes a FlexCache volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|cacheId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-fsx-volumes--.adoc b/cvo/delete-fsx-volumes--.adoc new file mode 100644 index 00000000..4159bcfa --- /dev/null +++ b/cvo/delete-fsx-volumes--.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-fsx-volumes--.html' +summary: 'Delete an existing volume' +--- + += Delete an existing volume + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}`# + + + +Deletes an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-fsx-volumes--snapshot.adoc b/cvo/delete-fsx-volumes--snapshot.adoc new file mode 100644 index 00000000..2743057b --- /dev/null +++ b/cvo/delete-fsx-volumes--snapshot.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-fsx-volumes--snapshot.html' +summary: 'Delete a snapshot' +--- + += Delete a snapshot + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/snapshot`# + + + +Deletes a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|array[string] +|True +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-ha-aggregates-.adoc b/cvo/delete-gcp-ha-aggregates-.adoc new file mode 100644 index 00000000..47ae7570 --- /dev/null +++ b/cvo/delete-gcp-ha-aggregates-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-ha-aggregates-.html' +summary: 'Delete an aggregate' +--- + += Delete an aggregate + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/ha/aggregates/{workingEnvironmentId}/{aggregateName}`# + + + +Deletes an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-ha-volumes--.adoc b/cvo/delete-gcp-ha-volumes--.adoc new file mode 100644 index 00000000..eed74df6 --- /dev/null +++ b/cvo/delete-gcp-ha-volumes--.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-ha-volumes--.html' +summary: 'Delete a volume' +--- + += Delete a volume + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Deletes an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-ha-volumes--snapshot.adoc b/cvo/delete-gcp-ha-volumes--snapshot.adoc new file mode 100644 index 00000000..2d25be76 --- /dev/null +++ b/cvo/delete-gcp-ha-volumes--snapshot.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-ha-volumes--snapshot.html' +summary: 'Delete a snapshot' +--- + += Delete a snapshot + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Deletes a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|array[string] +|True +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-ha-working-environments-.adoc b/cvo/delete-gcp-ha-working-environments-.adoc new file mode 100644 index 00000000..d1e5310e --- /dev/null +++ b/cvo/delete-gcp-ha-working-environments-.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-ha-working-environments-.html' +summary: 'Delete an existing system' +--- + += Delete an existing system + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}`# + + + +Deletes an existing Cloud Volumes ONTAP system, including all cloud resources created for the system (unless the localDelete flag is set to true). + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|localDelete +|boolean +|query +|False +a| + +|forceDelete +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-ha-working-environments-extra-capacity-serials.adoc b/cvo/delete-gcp-ha-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..372e4f4f --- /dev/null +++ b/cvo/delete-gcp-ha-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-ha-working-environments-extra-capacity-serials.html' +summary: 'Delete extra capacity licenses using the license serial numbers' +--- + += Delete extra capacity licenses using the license serial numbers + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Deletes extra capacity licenses by serial numbers. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-ha-working-environments-fpolicy.adoc b/cvo/delete-gcp-ha-working-environments-fpolicy.adoc new file mode 100644 index 00000000..2b76f024 --- /dev/null +++ b/cvo/delete-gcp-ha-working-environments-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-ha-working-environments-fpolicy.html' +summary: 'Delete FPolicy for ransomware files' +--- + += Delete FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/fpolicy`# + + + +Deletes the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-ha-working-environments-svm-.adoc b/cvo/delete-gcp-ha-working-environments-svm-.adoc new file mode 100644 index 00000000..f2bc279a --- /dev/null +++ b/cvo/delete-gcp-ha-working-environments-svm-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-ha-working-environments-svm-.html' +summary: 'Delete an SVM' +--- + += Delete an SVM + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/svm/{svmName}`# + + + +Deletes an SVM. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-vsa-aggregates-.adoc b/cvo/delete-gcp-vsa-aggregates-.adoc new file mode 100644 index 00000000..79959dcb --- /dev/null +++ b/cvo/delete-gcp-vsa-aggregates-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-vsa-aggregates-.html' +summary: 'Delete an aggregate' +--- + += Delete an aggregate + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName}`# + + + +Deletes an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-vsa-volumes--.adoc b/cvo/delete-gcp-vsa-volumes--.adoc new file mode 100644 index 00000000..6c724793 --- /dev/null +++ b/cvo/delete-gcp-vsa-volumes--.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-vsa-volumes--.html' +summary: 'Delete a volume' +--- + += Delete a volume + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Deletes an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-vsa-volumes--snapshot.adoc b/cvo/delete-gcp-vsa-volumes--snapshot.adoc new file mode 100644 index 00000000..ced24346 --- /dev/null +++ b/cvo/delete-gcp-vsa-volumes--snapshot.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-vsa-volumes--snapshot.html' +summary: 'Delete a snapshot' +--- + += Delete a snapshot + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Deletes a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|array[string] +|True +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-vsa-working-environments-.adoc b/cvo/delete-gcp-vsa-working-environments-.adoc new file mode 100644 index 00000000..50d45fcf --- /dev/null +++ b/cvo/delete-gcp-vsa-working-environments-.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-vsa-working-environments-.html' +summary: 'Delete an existing Cloud Volumes ONTAP system' +--- + += Delete an existing Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}`# + + + +Deletes an existing Cloud Volumes ONTAP system, including all cloud resources created for the system (unless the localDelete flag is set to true). + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|localDelete +|boolean +|query +|False +a| + +|forceDelete +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-vsa-working-environments-extra-capacity-serials.adoc b/cvo/delete-gcp-vsa-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..f0fb7546 --- /dev/null +++ b/cvo/delete-gcp-vsa-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-vsa-working-environments-extra-capacity-serials.html' +summary: 'Delete extra capacity licenses by serial numbers' +--- + += Delete extra capacity licenses by serial numbers + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Deletes extra capacity licenses by serial numbers. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-vsa-working-environments-fpolicy.adoc b/cvo/delete-gcp-vsa-working-environments-fpolicy.adoc new file mode 100644 index 00000000..b8c70a49 --- /dev/null +++ b/cvo/delete-gcp-vsa-working-environments-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-vsa-working-environments-fpolicy.html' +summary: 'Delete the FPolicy for ransomware files' +--- + += Delete the FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/fpolicy`# + + + +Deletes the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-gcp-vsa-working-environments-svm-.adoc b/cvo/delete-gcp-vsa-working-environments-svm-.adoc new file mode 100644 index 00000000..59453ef6 --- /dev/null +++ b/cvo/delete-gcp-vsa-working-environments-svm-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-gcp-vsa-working-environments-svm-.html' +summary: 'Delete an SVM' +--- + += Delete an SVM + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/svm/{svmName}`# + + + +Deletes an SVM. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-occm-encryption-key-managers-.adoc b/cvo/delete-occm-encryption-key-managers-.adoc new file mode 100644 index 00000000..6d6444e9 --- /dev/null +++ b/cvo/delete-occm-encryption-key-managers-.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-occm-encryption-key-managers-.html' +summary: 'Delete an existing key manager' +--- + += Delete an existing key manager + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/occm/encryption/key-managers/{keyManagerId}`# + + + +Deletes an existing key manager. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|keyManagerId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-occm-encryption-key-managers-ca-certificates-.adoc b/cvo/delete-occm-encryption-key-managers-ca-certificates-.adoc new file mode 100644 index 00000000..468ce107 --- /dev/null +++ b/cvo/delete-occm-encryption-key-managers-ca-certificates-.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-occm-encryption-key-managers-ca-certificates-.html' +summary: 'Delete a key manager CA certificate' +--- + += Delete a key manager CA certificate + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/occm/encryption/key-managers-ca-certificates/{keyManagerCaCertificateId}`# + + + +Deletes an existing key manager certificate authority (CA) certificate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|keyManagerCaCertificateId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-occm-key-store-trusted-certificate-.adoc b/cvo/delete-occm-key-store-trusted-certificate-.adoc new file mode 100644 index 00000000..61d167a4 --- /dev/null +++ b/cvo/delete-occm-key-store-trusted-certificate-.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-occm-key-store-trusted-certificate-.html' +summary: 'Delete an existing trusted certificate from the trust store' +--- + += Delete an existing trusted certificate from the trust store + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/occm/key-store/trusted-certificate/{certificateId}`# + + + +Deletes an existing trusted certificate from the trust store. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|certificateId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-onprem-volumes--.adoc b/cvo/delete-onprem-volumes--.adoc new file mode 100644 index 00000000..85a19da2 --- /dev/null +++ b/cvo/delete-onprem-volumes--.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-onprem-volumes--.html' +summary: 'Delete an existing volume' +--- + += Delete an existing volume + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Deletes an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-onprem-volumes--snapshot.adoc b/cvo/delete-onprem-volumes--snapshot.adoc new file mode 100644 index 00000000..2120ba49 --- /dev/null +++ b/cvo/delete-onprem-volumes--snapshot.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-onprem-volumes--snapshot.html' +summary: 'Delete a snapshot' +--- + += Delete a snapshot + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Deletes a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|array[string] +|True +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-onprem-working-environments-.adoc b/cvo/delete-onprem-working-environments-.adoc new file mode 100644 index 00000000..8c0ec895 --- /dev/null +++ b/cvo/delete-onprem-working-environments-.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-onprem-working-environments-.html' +summary: 'Delete an on-premises ONTAP system' +--- + += Delete an on-premises ONTAP system + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/onprem/working-environments/{workingEnvironmentId}`# + + + +Removes an on-premises ONTAP system from the NetApp Console. The Console will no longer manage the system, but ONTAP is not affected. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-replication--.adoc b/cvo/delete-replication--.adoc new file mode 100644 index 00000000..5559d3b8 --- /dev/null +++ b/cvo/delete-replication--.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-replication--.html' +summary: 'Remove a replication relationship' +--- + += Remove a replication relationship + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/replication/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}`# + + + +Removes a replication relationship. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|destinationWorkingEnvironmentId +|string +|path +|True +a| + +|destinationSvmName +|string +|path +|True +a| + +|destinationVolumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-tenants-.adoc b/cvo/delete-tenants-.adoc new file mode 100644 index 00000000..7321e08c --- /dev/null +++ b/cvo/delete-tenants-.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-tenants-.html' +summary: 'Delete an existing tenant' +--- + += Delete an existing tenant + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/tenants/{tenantId}`# + + + +Deletes an existing tenant. It is not possible to delete a tenant over which systems exist. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|tenantId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-users-.adoc b/cvo/delete-users-.adoc new file mode 100644 index 00000000..de302c29 --- /dev/null +++ b/cvo/delete-users-.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-users-.html' +summary: 'Delete an existing user' +--- + += Delete an existing user + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/users/{userId}`# + + + +Deletes an existing user. It is not possible to delete a user that has created existing systems. It is not possible to delete the logged in user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|userId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-users-remove-user.adoc b/cvo/delete-users-remove-user.adoc new file mode 100644 index 00000000..01bbc2c3 --- /dev/null +++ b/cvo/delete-users-remove-user.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-users-remove-user.html' +summary: 'Remove a user from NetApp Console' +--- + += Remove a user from NetApp Console + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/users/{userId}/remove-user`# + + + +Removes a user from the NetApp Console. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|userId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-vsa-aggregates-.adoc b/cvo/delete-vsa-aggregates-.adoc new file mode 100644 index 00000000..ed385d3b --- /dev/null +++ b/cvo/delete-vsa-aggregates-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-vsa-aggregates-.html' +summary: 'Delete an existing aggregate' +--- + += Delete an existing aggregate + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/vsa/aggregates/{workingEnvironmentId}/{aggregateName}`# + + + +Deletes an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-vsa-encryption-key-managers-.adoc b/cvo/delete-vsa-encryption-key-managers-.adoc new file mode 100644 index 00000000..02c60a21 --- /dev/null +++ b/cvo/delete-vsa-encryption-key-managers-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-vsa-encryption-key-managers-.html' +summary: 'Delete a key manager' +--- + += Delete a key manager + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/vsa/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}`# + + + +Deletes a key manager from the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|keyManagerIp +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-vsa-volumes--.adoc b/cvo/delete-vsa-volumes--.adoc new file mode 100644 index 00000000..fc1bd1c9 --- /dev/null +++ b/cvo/delete-vsa-volumes--.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-vsa-volumes--.html' +summary: 'Delete an existing volume' +--- + += Delete an existing volume + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Deletes an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-vsa-volumes--snapshot.adoc b/cvo/delete-vsa-volumes--snapshot.adoc new file mode 100644 index 00000000..af0f2a81 --- /dev/null +++ b/cvo/delete-vsa-volumes--snapshot.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-vsa-volumes--snapshot.html' +summary: 'Delete a snapshot' +--- + += Delete a snapshot + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Deletes a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|array[string] +|True +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-vsa-working-environments-.adoc b/cvo/delete-vsa-working-environments-.adoc new file mode 100644 index 00000000..a0598ef4 --- /dev/null +++ b/cvo/delete-vsa-working-environments-.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-vsa-working-environments-.html' +summary: 'Delete an existing Cloud Volumes ONTAP system' +--- + += Delete an existing Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}`# + + + +Deletes an existing Cloud Volumes ONTAP system, including all cloud resources created for the system (unless the localDelete flag is set to true). + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|localDelete +|boolean +|query +|False +a| + +|forceDelete +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-vsa-working-environments-extra-capacity-serials.adoc b/cvo/delete-vsa-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..5d5d5277 --- /dev/null +++ b/cvo/delete-vsa-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-vsa-working-environments-extra-capacity-serials.html' +summary: 'Delete extra capacity licenses by serial numbers' +--- + += Delete extra capacity licenses by serial numbers + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Deletes extra capacity licenses by serial numbers. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/delete-vsa-working-environments-fpolicy.adoc b/cvo/delete-vsa-working-environments-fpolicy.adoc new file mode 100644 index 00000000..c5647e3c --- /dev/null +++ b/cvo/delete-vsa-working-environments-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/delete-vsa-working-environments-fpolicy.html' +summary: 'Delete the FPolicy for ransomware files' +--- + += Delete the FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/fpolicy`# + + + +Deletes the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/get-accounts-aws-.adoc b/cvo/get-accounts-aws-.adoc new file mode 100644 index 00000000..bfd64a61 --- /dev/null +++ b/cvo/get-accounts-aws-.adoc @@ -0,0 +1,193 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-accounts-aws-.html' +summary: 'Retrieve an AWS account' +--- + += Retrieve an AWS account + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/accounts/aws/{cloudProviderAccountId}`# + + + +Retrieves an AWS account using the public ID. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudProviderAccountId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|accountId +|string +|False +a| + +|accessKey +|string +|False +a| + +|assumeRole +|link:#AssumeRole[AssumeRole] +|False +a| + +|occmRole +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|subscriptionId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "accountName": "string", + "accountType": "string", + "accountId": "string", + "accessKey": "string", + "assumeRole": { + "roleName": "string", + "accountId": "string" + }, + "occmRole": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ], + "subscriptionId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AssumeRole] +[.api-collapsible-fifth-title] +AssumeRole + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|roleName +|string +|False +a| + +|accountId +|string +|False +a| + +|isGov +|boolean +|False +a| + +|=== + + +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-accounts-azure-.adoc b/cvo/get-accounts-azure-.adoc new file mode 100644 index 00000000..40b3d02f --- /dev/null +++ b/cvo/get-accounts-azure-.adoc @@ -0,0 +1,149 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-accounts-azure-.html' +summary: 'Retrieve an Azure account' +--- + += Retrieve an Azure account + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/accounts/azure/{cloudProviderAccountId}`# + + + +Retrieves an Azure account using the public ID. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudProviderAccountId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|tenantId +|string +|False +a| + +|applicationId +|string +|False +a| + +|occmRole +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "accountName": "string", + "accountType": "string", + "tenantId": "string", + "applicationId": "string", + "occmRole": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-accounts-cloud-providers.adoc b/cvo/get-accounts-cloud-providers.adoc new file mode 100644 index 00000000..dd60fbce --- /dev/null +++ b/cvo/get-accounts-cloud-providers.adoc @@ -0,0 +1,411 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-accounts-cloud-providers.html' +summary: 'Retrieve all cloud accounts' +--- + += Retrieve all cloud accounts + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/accounts/cloud-providers`# + + + +Retrieves all cloud accounts (AWS, Azure, and Google Cloud). + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|providerType +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|awsAccounts +|array[link:#AwsAccountResponse[AwsAccountResponse]] +|True +a| + +|azureAccounts +|array[link:#AzureAccountResponse[AzureAccountResponse]] +|True +a| + +|gcpStorageAccounts +|array[link:#GcpAccountResponse[GcpAccountResponse]] +|True +a| + +|nssAccounts +|array[link:#NssAccountResponse[NssAccountResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "awsAccounts": [ + { + "publicId": "string", + "accountName": "string", + "accountType": "string", + "accountId": "string", + "accessKey": "string", + "assumeRole": { + "roleName": "string", + "accountId": "string" + }, + "occmRole": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ], + "subscriptionId": "string" + } + ], + "azureAccounts": [ + { + "publicId": "string", + "accountName": "string", + "accountType": "string", + "tenantId": "string", + "applicationId": "string", + "occmRole": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ] + } + ], + "gcpStorageAccounts": [ + { + "publicId": "string", + "accountName": "string", + "accountType": "string", + "accessKey": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ], + "occmRole": "string" + } + ], + "nssAccounts": [ + { + "publicId": "string", + "accountName": "string", + "accountType": "string", + "nssUserName": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AssumeRole] +[.api-collapsible-fifth-title] +AssumeRole + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|roleName +|string +|False +a| + +|accountId +|string +|False +a| + +|isGov +|boolean +|False +a| + +|=== + + +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +[#AwsAccountResponse] +[.api-collapsible-fifth-title] +AwsAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|accountId +|string +|False +a| + +|accessKey +|string +|False +a| + +|assumeRole +|link:#AssumeRole[AssumeRole] +|False +a| + +|occmRole +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|subscriptionId +|string +|False +a| + +|=== + + +[#AzureAccountResponse] +[.api-collapsible-fifth-title] +AzureAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|tenantId +|string +|False +a| + +|applicationId +|string +|False +a| + +|occmRole +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|=== + + +[#GcpAccountResponse] +[.api-collapsible-fifth-title] +GcpAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|accessKey +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|occmRole +|string +|False +a| + +|=== + + +[#NssAccountResponse] +[.api-collapsible-fifth-title] +NssAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|nssUserName +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-accounts-gcp-.adoc b/cvo/get-accounts-gcp-.adoc new file mode 100644 index 00000000..b29282c9 --- /dev/null +++ b/cvo/get-accounts-gcp-.adoc @@ -0,0 +1,143 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-accounts-gcp-.html' +summary: 'Retrieve a Google Cloud storage account' +--- + += Retrieve a Google Cloud storage account + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/accounts/gcp/{cloudProviderAccountId}`# + + + +Retrieves a Google Cloud storage account using the public ID. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudProviderAccountId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|accessKey +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|occmRole +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "accountName": "string", + "accountType": "string", + "accessKey": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ], + "occmRole": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-accounts-nss-.adoc b/cvo/get-accounts-nss-.adoc new file mode 100644 index 00000000..e6bb2c40 --- /dev/null +++ b/cvo/get-accounts-nss-.adoc @@ -0,0 +1,134 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-accounts-nss-.html' +summary: 'Retrieve an NSS account' +--- + += Retrieve an NSS account + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/accounts/nss/{cloudProviderAccountId}`# + + + +Retrieves a NetApp Support Site account using the public ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudProviderAccountId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|nssUserName +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "accountName": "string", + "accountType": "string", + "nssUserName": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-accounts.adoc b/cvo/get-accounts.adoc new file mode 100644 index 00000000..c2eb9842 --- /dev/null +++ b/cvo/get-accounts.adoc @@ -0,0 +1,411 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-accounts.html' +summary: 'Retrieve accounts' +--- + += Retrieve accounts + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/accounts`# + + + +Retrieves accounts. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|providerType +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|awsAccounts +|array[link:#AwsAccountResponse[AwsAccountResponse]] +|True +a| + +|azureAccounts +|array[link:#AzureAccountResponse[AzureAccountResponse]] +|True +a| + +|gcpStorageAccounts +|array[link:#GcpAccountResponse[GcpAccountResponse]] +|True +a| + +|nssAccounts +|array[link:#NssAccountResponse[NssAccountResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "awsAccounts": [ + { + "publicId": "string", + "accountName": "string", + "accountType": "string", + "accountId": "string", + "accessKey": "string", + "assumeRole": { + "roleName": "string", + "accountId": "string" + }, + "occmRole": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ], + "subscriptionId": "string" + } + ], + "azureAccounts": [ + { + "publicId": "string", + "accountName": "string", + "accountType": "string", + "tenantId": "string", + "applicationId": "string", + "occmRole": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ] + } + ], + "gcpStorageAccounts": [ + { + "publicId": "string", + "accountName": "string", + "accountType": "string", + "accessKey": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ], + "occmRole": "string" + } + ], + "nssAccounts": [ + { + "publicId": "string", + "accountName": "string", + "accountType": "string", + "nssUserName": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AssumeRole] +[.api-collapsible-fifth-title] +AssumeRole + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|roleName +|string +|False +a| + +|accountId +|string +|False +a| + +|isGov +|boolean +|False +a| + +|=== + + +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +[#AwsAccountResponse] +[.api-collapsible-fifth-title] +AwsAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|accountId +|string +|False +a| + +|accessKey +|string +|False +a| + +|assumeRole +|link:#AssumeRole[AssumeRole] +|False +a| + +|occmRole +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|subscriptionId +|string +|False +a| + +|=== + + +[#AzureAccountResponse] +[.api-collapsible-fifth-title] +AzureAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|tenantId +|string +|False +a| + +|applicationId +|string +|False +a| + +|occmRole +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|=== + + +[#GcpAccountResponse] +[.api-collapsible-fifth-title] +GcpAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|accessKey +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|occmRole +|string +|False +a| + +|=== + + +[#NssAccountResponse] +[.api-collapsible-fifth-title] +NssAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|nssUserName +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-audit-.adoc b/cvo/get-audit-.adoc new file mode 100644 index 00000000..ab4a2b62 --- /dev/null +++ b/cvo/get-audit-.adoc @@ -0,0 +1,236 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-audit-.html' +summary: 'Retrieve an audit group entry' +--- + += Retrieve an audit group entry + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/audit/{requestId}`# + + + +Retrieves the audit group entry for the specified request ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|requestId +|string +|path +|True +a| + +|records +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_id +|integer +|True +a| + +|id +|string +|True +a|Audit group public ID + + +|requestId +|string +|True +a|Request ID of an action associated with the audit group + + +|startDate +|integer +|True +a|Start date + + +|endDate +|integer +|False +a|End date + + +|actionName +|string +|True +a|Audit group name + + +|status +|string +|False +a|Audit group status + + +|userName +|string +|False +a|Name of the user who performed the action + + +|tenantName +|string +|False +a|Name of the tenant + + +|workingEnvironmentName +|string +|False +a|Name of the system related to the user action + + +|actionParameters +|string +|False +a|Parameters of the user action + + +|records +|array[link:#AuditGroupSummaryRecord[AuditGroupSummaryRecord]] +|True +a|List of audit records + + +|errorMessage +|string +|False +a|Audit failure information (if relevant) + + +|version +|string +|True +a|Version of NetApp Console used to create this audit + + +|parentId +|link:#parentId[parentId] +|False +a| + +|userId +|string +|False +a| + +|workingEnvironmentId +|string +|False +a| + +|containsFailedRecords +|boolean +|False +a| + +|containsRecords +|boolean +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AuditGroupSummaryRecord] +[.api-collapsible-fifth-title] +AuditGroupSummaryRecord + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Audit record public ID + + +|date +|integer +|True +a|Date + + +|actionName +|string +|True +a|Action + + +|status +|string +|True +a|Status + + +|parameters +|string +|False +a|Action parameters + + +|errorMessage +|string +|False +a|Audit failure information (if relevant) + + +|count +|integer +|True +a|Aggregated count of similar records + + +|=== + + +[#parentId] +[.api-collapsible-fifth-title] +parentId + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-audit-activetask-.adoc b/cvo/get-audit-activetask-.adoc new file mode 100644 index 00000000..0031d5da --- /dev/null +++ b/cvo/get-audit-activetask-.adoc @@ -0,0 +1,72 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-audit-activetask-.html' +summary: 'Retrieve an active task' +--- + += Retrieve an active task + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/audit/activeTask/{requestId}`# + + + +Retrieves the active task for the request ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|requestId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|True +a| + +|closeTime +|integer +|True +a| + +|actionName +|string +|True +a| + +|error +|string +|False +a| + +|=== + + diff --git a/cvo/get-audit-auditserver.adoc b/cvo/get-audit-auditserver.adoc new file mode 100644 index 00000000..a60351bc --- /dev/null +++ b/cvo/get-audit-auditserver.adoc @@ -0,0 +1,212 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-audit-auditserver.html' +summary: 'Retrieve audit groups and group records' +--- + += Retrieve audit groups and group records + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/audit/auditserver`# + + + +Retrieves audit groups and group records. You can optionally filter by query parameters. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_id +|integer +|True +a| + +|id +|string +|True +a|Audit group public ID + + +|requestId +|string +|True +a|Request ID of an action associated with the audit group + + +|startDate +|integer +|True +a|Start date + + +|endDate +|integer +|False +a|End date + + +|actionName +|string +|True +a|Audit group name + + +|status +|string +|False +a|Audit group status + + +|userName +|string +|False +a|Name of the user who performed the action + + +|tenantName +|string +|False +a|Name of the tenant + + +|workingEnvironmentName +|string +|False +a|Name of the system related to the user action + + +|actionParameters +|string +|False +a|Parameters of the user action + + +|records +|array[link:#AuditGroupSummaryRecord[AuditGroupSummaryRecord]] +|True +a|List of audit records + + +|errorMessage +|string +|False +a|Audit failure information (if relevant) + + +|version +|string +|True +a|Version of NetApp Console used to create this audit + + +|parentId +|link:#parentId[parentId] +|False +a| + +|userId +|string +|False +a| + +|workingEnvironmentId +|string +|False +a| + +|containsFailedRecords +|boolean +|False +a| + +|containsRecords +|boolean +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AuditGroupSummaryRecord] +[.api-collapsible-fifth-title] +AuditGroupSummaryRecord + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Audit record public ID + + +|date +|integer +|True +a|Date + + +|actionName +|string +|True +a|Action + + +|status +|string +|True +a|Status + + +|parameters +|string +|False +a|Action parameters + + +|errorMessage +|string +|False +a|Audit failure information (if relevant) + + +|count +|integer +|True +a|Aggregated count of similar records + + +|=== + + +[#parentId] +[.api-collapsible-fifth-title] +parentId + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-audit-local-audit--records.adoc b/cvo/get-audit-local-audit--records.adoc new file mode 100644 index 00000000..17c31d88 --- /dev/null +++ b/cvo/get-audit-local-audit--records.adoc @@ -0,0 +1,87 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-audit-local-audit--records.html' +summary: 'Retrieve an audit record' +--- + += Retrieve an audit record + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/audit/local/audit/{accountId}/{service}/{requestId}/records`# + + + +Retrieves an audit record with the specified request ID for the local UI. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|requestId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|creationTime +|integer +|True +a| + +|action +|string +|True +a| + +|status +|string +|False +a| + +|data +|string +|False +a| + +|errors +|array[string] +|True +a| + +|recordId +|integer +|False +a| + +|count +|integer +|False +a| + +|=== + + diff --git a/cvo/get-audit-local-audit-.adoc b/cvo/get-audit-local-audit-.adoc new file mode 100644 index 00000000..53f56bc5 --- /dev/null +++ b/cvo/get-audit-local-audit-.adoc @@ -0,0 +1,133 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-audit-local-audit-.html' +summary: 'Retrieve audit group entries' +--- + += Retrieve audit group entries + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/audit/local/audit/{accountId}`# + + + +Retrieves audit group entries. You can optionally filter by query parameters for the local UI. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|True +a| + +|principalId +|string +|False +a| + +|agentId +|string +|False +a| + +|agentName +|string +|False +a| + +|resourceId +|string +|False +a| + +|resourceName +|string +|False +a| + +|action +|string +|False +a| + +|startTime +|integer +|True +a| + +|endTime +|link:#endTime[endTime] +|False +a| + +|status +|string +|False +a| + +|requestId +|string +|False +a| + +|service +|string +|False +a| + +|errors +|array[string] +|True +a| + +|requestData +|string +|False +a| + +|hasRecords +|boolean +|False +a| + +|hasFailedRecords +|boolean +|False +a| + +|lastModified +|integer +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#endTime] +[.api-collapsible-fifth-title] +endTime + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-audit-local-audit-options.adoc b/cvo/get-audit-local-audit-options.adoc new file mode 100644 index 00000000..e949c8c1 --- /dev/null +++ b/cvo/get-audit-local-audit-options.adoc @@ -0,0 +1,140 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-audit-local-audit-options.html' +summary: 'Retrieve audit page filter options' +--- + += Retrieve audit page filter options + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/audit/local/audit/{accountId}/options`# + + + +Retrieves audit page filter options for the local UI. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|service +|array[link:#CloudCentralAuditOptionsEntryResponse[CloudCentralAuditOptionsEntryResponse]] +|True +a| + +|action +|array[link:#CloudCentralAuditOptionsEntryResponse[CloudCentralAuditOptionsEntryResponse]] +|False +a| + +|agent +|array[link:#CloudCentralAuditOptionsEntryResponse[CloudCentralAuditOptionsEntryResponse]] +|False +a| + +|resource +|array[link:#CloudCentralAuditOptionsEntryResponse[CloudCentralAuditOptionsEntryResponse]] +|False +a| + +|user +|array[link:#CloudCentralAuditOptionsEntryResponse[CloudCentralAuditOptionsEntryResponse]] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "service": [ + { + "column": "string", + "identifier": "string", + "label": "string" + } + ], + "action": [ + { + "column": "string", + "identifier": "string", + "label": "string" + } + ], + "agent": [ + { + "column": "string", + "identifier": "string", + "label": "string" + } + ], + "resource": [ + { + "column": "string", + "identifier": "string", + "label": "string" + } + ], + "user": [ + { + "column": "string", + "identifier": "string", + "label": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudCentralAuditOptionsEntryResponse] +[.api-collapsible-fifth-title] +CloudCentralAuditOptionsEntryResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|column +|string +|True +a| + +|identifier +|string +|False +a| + +|label +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-audit.adoc b/cvo/get-audit.adoc new file mode 100644 index 00000000..dfca4acb --- /dev/null +++ b/cvo/get-audit.adoc @@ -0,0 +1,242 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-audit.html' +summary: 'Retrieve audit group entries' +--- + += Retrieve audit group entries + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/audit`# + + + +Retrieves audit group entries. You can optionally filter by query parameters. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|limit +|integer +|query +|False +a| + +|after +|integer +|query +|False +a| + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_id +|integer +|True +a| + +|id +|string +|True +a|Audit group public ID + + +|requestId +|string +|True +a|Request ID of an action associated with the audit group + + +|startDate +|integer +|True +a|Start date + + +|endDate +|integer +|False +a|End date + + +|actionName +|string +|True +a|Audit group name + + +|status +|string +|False +a|Audit group status + + +|userName +|string +|False +a|Name of the user who performed the action + + +|tenantName +|string +|False +a|Name of the tenant + + +|workingEnvironmentName +|string +|False +a|Name of the system related to the user action + + +|actionParameters +|string +|False +a|Parameters of the user action + + +|records +|array[link:#AuditGroupSummaryRecord[AuditGroupSummaryRecord]] +|True +a|List of audit records + + +|errorMessage +|string +|False +a|Audit failure information (if relevant) + + +|version +|string +|True +a|Version of NetApp Console used to create this audit + + +|parentId +|link:#parentId[parentId] +|False +a| + +|userId +|string +|False +a| + +|workingEnvironmentId +|string +|False +a| + +|containsFailedRecords +|boolean +|False +a| + +|containsRecords +|boolean +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AuditGroupSummaryRecord] +[.api-collapsible-fifth-title] +AuditGroupSummaryRecord + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Audit record public ID + + +|date +|integer +|True +a|Date + + +|actionName +|string +|True +a|Action + + +|status +|string +|True +a|Status + + +|parameters +|string +|False +a|Action parameters + + +|errorMessage +|string +|False +a|Audit failure information (if relevant) + + +|count +|integer +|True +a|Aggregated count of similar records + + +|=== + + +[#parentId] +[.api-collapsible-fifth-title] +parentId + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-auth-current-user.adoc b/cvo/get-auth-current-user.adoc new file mode 100644 index 00000000..483eadc6 --- /dev/null +++ b/cvo/get-auth-current-user.adoc @@ -0,0 +1,217 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-auth-current-user.html' +summary: 'Retrieve user representation' +--- + += Retrieve user representation + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/auth/current-user`# + + + +Retrieves a representation of the current user. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|User public ID + + +|assignedWorkingEnvironments +|array[string] +|True +a|List of public IDs for all of the systems visible to the user + + +|firstName +|string +|True +a|The first name of the user + + +|lastName +|string +|True +a|The last name of the user + + +|email +|string +|True +a|The email address of the user + + +|roleId +|string +|True +a|Role ID of the user + + +|tenantId +|string +|True +a|Tenant ID of the user + + +|createdWorkingEnvironments +|array[link:#UserWorkingEnvironmentResponse[UserWorkingEnvironmentResponse]] +|True +a|List of all systems created by the user + + +|azureCredentials +|link:#AzureCredentials[AzureCredentials] +|False +a| + +|cloudSyncLicenseInformation +|link:#CloudSyncLicenseInformation[CloudSyncLicenseInformation] +|False +a| + +|isLdap +|boolean +|True +a|Indicates whether the user is an LDAP user + + +|ldapUserName +|string +|True +a|The LDAP user name + + +|notificationsOptIn +|boolean +|True +a|Notification Opt-In + + +|permissions +|array[string] +|True +a|Permissions + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#UserWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +UserWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|System public ID + + +|name +|string +|True +a|System name + + +|workingEnvironmentType +|string +|True +a|System type + + +|=== + + +[#AzureCredentials] +[.api-collapsible-fifth-title] +AzureCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|False +a| + +|tenantId +|string +|False +a| + +|applicationId +|string +|False +a| + +|applicationKey +|string +|False +a| + +|=== + + +[#CloudSyncLicenseInformation] +[.api-collapsible-fifth-title] +CloudSyncLicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudSyncLicenseTypes +|array[string] +|False +a|Cloud sync license types + + +|licenseExpirationDate +|integer +|False +a|Cloud sync license expiration date + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-auth-v4-current-user.adoc b/cvo/get-auth-v4-current-user.adoc new file mode 100644 index 00000000..f60a503d --- /dev/null +++ b/cvo/get-auth-v4-current-user.adoc @@ -0,0 +1,217 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-auth-v4-current-user.html' +summary: 'Retrieve a NetApp Console user representation with roles' +--- + += Retrieve a NetApp Console user representation with roles + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/auth/v4/current-user`# + + + +Retrieves a representation of the current user with the associated roles. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|User public ID + + +|assignedWorkingEnvironments +|array[string] +|True +a|List of public IDs for all of the systems visible to the user + + +|firstName +|string +|True +a|The first name of the user + + +|lastName +|string +|True +a|The last name of the user + + +|email +|string +|True +a|The email address of the user + + +|tenantId +|string +|True +a|Tenant ID of the user + + +|createdWorkingEnvironments +|array[link:#UserWorkingEnvironmentResponse[UserWorkingEnvironmentResponse]] +|True +a|List of all systems created by the user + + +|azureCredentials +|link:#AzureCredentials[AzureCredentials] +|False +a| + +|cloudSyncLicenseInformation +|link:#CloudSyncLicenseInformation[CloudSyncLicenseInformation] +|False +a| + +|isLdap +|boolean +|True +a|Indicates whether the user is an LDAP user + + +|ldapUserName +|string +|True +a|The LDAP user name + + +|notificationsOptIn +|boolean +|True +a|Notification OptIn + + +|roles +|array[string] +|True +a|Roles + + +|permissions +|array[string] +|True +a|Permissions + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#UserWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +UserWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|System public ID + + +|name +|string +|True +a|System name + + +|workingEnvironmentType +|string +|True +a|System type + + +|=== + + +[#AzureCredentials] +[.api-collapsible-fifth-title] +AzureCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|False +a| + +|tenantId +|string +|False +a| + +|applicationId +|string +|False +a| + +|applicationKey +|string +|False +a| + +|=== + + +[#CloudSyncLicenseInformation] +[.api-collapsible-fifth-title] +CloudSyncLicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudSyncLicenseTypes +|array[string] +|False +a|Cloud sync license types + + +|licenseExpirationDate +|integer +|False +a|Cloud sync license expiration date + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-aggregates.adoc b/cvo/get-aws-ha-aggregates.adoc new file mode 100644 index 00000000..34073b25 --- /dev/null +++ b/cvo/get-aws-ha-aggregates.adoc @@ -0,0 +1,404 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-aggregates.html' +summary: 'Retrieve aggregates' +--- + += Retrieve aggregates + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/aggregates`# + + + +Retrieves aggregates. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Aggregate name + + +|availableCapacity +|link:#Capacity[Capacity] +|True +a| + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|usedCapacity +|link:#Capacity[Capacity] +|True +a| + +|volumes +|array[link:#Volume[Volume]] +|True +a|Volumes + + +|providerVolumes +|array[link:#ProviderVolumeResponse[ProviderVolumeResponse]] +|True +a|Provider volumes + + +|disks +|array[link:#Disk[Disk]] +|True +a|Disks + + +|state +|string +|False +a|State + + +|encryptionType +|string +|True +a|Encryption Type + + +|encryptionKeyId +|string +|False +a|Encryption Key + + +|isRoot +|boolean +|True +a|Is Root + + +|homeNode +|string +|True +a|Home node + + +|ownerNode +|string +|False +a|Owner node + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsed +|link:#Capacity[Capacity] +|False +a| + +|sidlEnabled +|boolean +|True +a|SIDL enabled + + +|snaplockType +|string +|True +a|Snaplock type + + +|evCompatibilityType +|string +|True +a|Elastic Volume Compatibility Type + + +|iops +|link:#iops[iops] +|False +a|Aggregate IOPS + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Volume] +[.api-collapsible-fifth-title] +Volume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|totalSize +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioned +|boolean +|True +a|Indicates if the volume is thin-provisioned + + +|isClone +|boolean +|True +a|Indicates if the volume is a clone volume + + +|rootVolume +|boolean +|True +a|Indicates if the volume is the root volume of the SVM + + +|=== + + +[#ProviderVolumeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Specifies the ID + + +|name +|string +|True +a|Specifies the name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|state +|string +|True +a|State + + +|device +|string +|True +a|Device + + +|instanceId +|string +|True +a|InstanceId + + +|diskType +|string +|True +a|Type + + +|encrypted +|boolean +|True +a|Encrypted + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|instance2Id +|string +|False +a|Instance2Id + + +|=== + + +[#VmDiskProperties] +[.api-collapsible-fifth-title] +VmDiskProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectName +|string +|False +a| + +|storageAccountName +|string +|False +a| + +|containerName +|string +|False +a| + +|=== + + +[#Disk] +[.api-collapsible-fifth-title] +Disk + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Name + + +|containerType +|string +|True +a|Container type + + +|ownerNode +|string +|True +a|Owner node + + +|device +|string +|False +a|Device + + +|vmDiskProperties +|link:#VmDiskProperties[VmDiskProperties] +|False +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + +Aggregate IOPS + + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-discovery-discover.adoc b/cvo/get-aws-ha-discovery-discover.adoc new file mode 100644 index 00000000..5eb66e4e --- /dev/null +++ b/cvo/get-aws-ha-discovery-discover.adoc @@ -0,0 +1,129 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-discovery-discover.html' +summary: 'Retrieve a list of discovered systems' +--- + += Retrieve a list of discovered systems + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/discovery/discover`# + + + +Retrieves a list of discovered systems visible to the current user in the specified AWS region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|publicId +|string +|False +a| + +|region +|string +|False +a| + +|vpcName +|string +|False +a| + +|vpcId +|string +|False +a| + +|availabilityZones +|array[string] +|True +a| + +|subnetIds +|array[string] +|False +a| + +|stackName +|string +|False +a| + +|stackId +|string +|False +a| + +|clusterAddress +|string +|False +a| + +|recoverable +|boolean +|True +a| + +|byol +|boolean +|False +a| + +|registered +|boolean +|False +a| + +|=== + + diff --git a/cvo/get-aws-ha-metadata-aws-encryption-keys.adoc b/cvo/get-aws-ha-metadata-aws-encryption-keys.adoc new file mode 100644 index 00000000..c154d8f1 --- /dev/null +++ b/cvo/get-aws-ha-metadata-aws-encryption-keys.adoc @@ -0,0 +1,120 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-aws-encryption-keys.html' +summary: 'Retrieve AWS encryption keys by region' +--- + += Retrieve AWS encryption keys by region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/aws-encryption-keys`# + + + +Retrieves AWS encryption keys for a specific region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "alias": "string", + "keyId": "string", + "status": "string", + "origin": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-metadata-buckets.adoc b/cvo/get-aws-ha-metadata-buckets.adoc new file mode 100644 index 00000000..f369a7f1 --- /dev/null +++ b/cvo/get-aws-ha-metadata-buckets.adoc @@ -0,0 +1,100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-buckets.html' +summary: 'Retrieve all S3 buckets' +--- + += Retrieve all S3 buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/buckets`# + + + +Retrieves all S3 buckets. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|tagsRequired +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|bucketName +|string +|True +a| + +|region +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|True +a| + +|empty +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-metadata-default-snapshot-policies.adoc b/cvo/get-aws-ha-metadata-default-snapshot-policies.adoc new file mode 100644 index 00000000..1ec70ea4 --- /dev/null +++ b/cvo/get-aws-ha-metadata-default-snapshot-policies.adoc @@ -0,0 +1,100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-default-snapshot-policies.html' +summary: 'Retrieve default snapshot policies available on a cluster' +--- + += Retrieve default snapshot policies available on a cluster + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/default-snapshot-policies`# + + + +Retrieves the default snapshot policies available on a cluster. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "schedules": [ + {} + ], + "description": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-metadata-ebs-volume-types.adoc b/cvo/get-aws-ha-metadata-ebs-volume-types.adoc new file mode 100644 index 00000000..0bb2cdf9 --- /dev/null +++ b/cvo/get-aws-ha-metadata-ebs-volume-types.adoc @@ -0,0 +1,94 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-ebs-volume-types.html' +summary: 'Retrieve supported EBS volume types' +--- + += Retrieve supported EBS volume types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/ebs-volume-types`# + + + +Retrieves supported EBS volume types. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|True +a| + +|size +|link:#Capacity[Capacity] +|True +a| + +|supportedVolumeTypes +|array[string] +|True +a| + +|supportedOccmLicenses +|array[string] +|False +a| + +|isDefault +|boolean +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-metadata-get-buckets-details.adoc b/cvo/get-aws-ha-metadata-get-buckets-details.adoc new file mode 100644 index 00000000..0cb4a241 --- /dev/null +++ b/cvo/get-aws-ha-metadata-get-buckets-details.adoc @@ -0,0 +1,131 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-get-buckets-details.html' +summary: 'Retrieve all S3 buckets with additional information' +--- + += Retrieve all S3 buckets with additional information + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/get-buckets-details`# + + + +Retrieves all S3 buckets with additional information. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s3Buckets +|array[link:#S3BucketInfoDetails[S3BucketInfoDetails]] +|True +a| + +|totalBuckets +|integer +|True +a| + +|totalRegions +|integer +|False +a| + +|totalTieringTargets +|integer +|False +a| + +|totalBackupTargets +|integer +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|True +a| + +|empty +|boolean +|False +a| + +|=== + + +[#S3BucketInfoDetails] +[.api-collapsible-fifth-title] +S3BucketInfoDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|bucketName +|string +|True +a| + +|region +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|isTieringTarget +|boolean +|False +a| + +|isBackupTarget +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-metadata-instance-profiles.adoc b/cvo/get-aws-ha-metadata-instance-profiles.adoc new file mode 100644 index 00000000..5c69027a --- /dev/null +++ b/cvo/get-aws-ha-metadata-instance-profiles.adoc @@ -0,0 +1,78 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-instance-profiles.html' +summary: 'Retrieve AWS instance profiles' +--- + += Retrieve AWS instance profiles + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/instance-profiles`# + + + +Retrieves AWS instance profiles. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceProfileId +|string +|True +a| + +|name +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceProfileId": "string", + "name": "string" +} +==== + diff --git a/cvo/get-aws-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc b/cvo/get-aws-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc new file mode 100644 index 00000000..aa75c8ed --- /dev/null +++ b/cvo/get-aws-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html' +summary: 'Retrieve unsupported instance types for acceleration and capacity tiering' +--- + += Retrieve unsupported instance types for acceleration and capacity tiering + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering`# + + + +Retrieves the instance types that do not support acceleration and capacity tiering. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceTypes +|array[link:#InstanceTypeResponse[InstanceTypeResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceTypes": [ + { + "instanceType": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#InstanceTypeResponse] +[.api-collapsible-fifth-title] +InstanceTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-metadata-key-pairs-by-region.adoc b/cvo/get-aws-ha-metadata-key-pairs-by-region.adoc new file mode 100644 index 00000000..244976f3 --- /dev/null +++ b/cvo/get-aws-ha-metadata-key-pairs-by-region.adoc @@ -0,0 +1,96 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-key-pairs-by-region.html' +summary: 'Retrieve AWS user key pairs for all regions' +--- + += Retrieve AWS user key pairs for all regions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/key-pairs-by-region`# + + + +Retrieves AWS user Key Pairs for all regions. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionToKeyPairs +|link:#regionToKeyPairs[regionToKeyPairs] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#regionToKeyPairs] +[.api-collapsible-fifth-title] +regionToKeyPairs +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-metadata-key-pairs.adoc b/cvo/get-aws-ha-metadata-key-pairs.adoc new file mode 100644 index 00000000..6d7b8deb --- /dev/null +++ b/cvo/get-aws-ha-metadata-key-pairs.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-key-pairs.html' +summary: 'Retrieve AWS user key pairs by region' +--- + += Retrieve AWS user key pairs by region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/key-pairs`# + + + +Retrieves AWS user Key Pairs for a specific region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/get-aws-ha-metadata-manifests.adoc b/cvo/get-aws-ha-metadata-manifests.adoc new file mode 100644 index 00000000..f3c6790e --- /dev/null +++ b/cvo/get-aws-ha-metadata-manifests.adoc @@ -0,0 +1,468 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-manifests.html' +summary: 'Retrieve all NetApp Console manifests' +--- + += Retrieve all NetApp Console manifests + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/manifests`# + + + +Retrieves all NetApp Console manifests. Refer to the API Developers Guide in order to understand how to extract valid region codes, license types, instance types and Cloud Volumes ONTAP version parameters for the creation of a Cloud Volumes ONTAP system. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|globalManifest +|link:#GlobalManifest[GlobalManifest] +|True +a| + +|ontapManifests +|array[link:#CloudOntapManifest[CloudOntapManifest]] +|True +a|ONTAP manifests + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#Region] +[.api-collapsible-fifth-title] +Region + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|code +|string +|False +a| + +|location +|string +|False +a| + +|s3Region +|string +|False +a| + +|=== + + +[#MapStringListString] +[.api-collapsible-fifth-title] +MapStringListString +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#cot_versions] +[.api-collapsible-fifth-title] +cot_versions +Hash mapping strings to link:#MapStringListString[MapStringListString] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#cot_versions_to_upgrade_to] +[.api-collapsible-fifth-title] +cot_versions_to_upgrade_to +Hash mapping strings to link:#MapStringListString[MapStringListString] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#FeatureProperties] +[.api-collapsible-fifth-title] +FeatureProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|start +|string +|False +a| + +|end +|string +|False +a| + +|excludedRegions +|array[string] +|False +a| + +|excludedLicenseTypes +|array[string] +|False +a| + +|=== + + +[#MapStringFeatureProperties] +[.api-collapsible-fifth-title] +MapStringFeatureProperties +Hash mapping strings to link:#FeatureProperties[FeatureProperties] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#supportedFeatures] +[.api-collapsible-fifth-title] +supportedFeatures +Hash mapping strings to link:#MapStringFeatureProperties[MapStringFeatureProperties] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#GlobalManifest] +[.api-collapsible-fifth-title] +GlobalManifest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|license_types +|array[link:#OntapLicenseType[OntapLicenseType]] +|True +a| + +|regions +|array[link:#Region[Region]] +|True +a| + +|azureRegions +|array[link:#Region[Region]] +|False +a| + +|gcpRegions +|array[link:#Region[Region]] +|False +a| + +|cot_versions +|link:#cot_versions[cot_versions] +|True +a| + +|cot_versions_to_upgrade_to +|link:#cot_versions_to_upgrade_to[cot_versions_to_upgrade_to] +|False +a| + +|supportedFeatures +|link:#supportedFeatures[supportedFeatures] +|True +a| + +|=== + + +[#RegionalAmi] +[.api-collapsible-fifth-title] +RegionalAmi + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|False +a| + +|ami_id +|string +|False +a| + +|saas_mp +|boolean +|False +a| + +|=== + + +[#LicenseToAmis] +[.api-collapsible-fifth-title] +LicenseToAmis + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|license_type +|string +|False +a| + +|instance_types +|array[string] +|False +a| + +|amis +|array[link:#RegionalAmi[RegionalAmi]] +|True +a| + +|=== + + +[#CloudOntapManifest] +[.api-collapsible-fifth-title] +CloudOntapManifest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontap_version +|string +|False +a| + +|ontap_image_versions_allowed_to_upgrade_from +|array[string] +|True +a| + +|encryption_enabled_instance_types +|array[string] +|False +a| + +|license_to_ami_mapping +|array[link:#LicenseToAmis[LicenseToAmis]] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-metadata-network-requirements.adoc b/cvo/get-aws-ha-metadata-network-requirements.adoc new file mode 100644 index 00000000..213e643e --- /dev/null +++ b/cvo/get-aws-ha-metadata-network-requirements.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-network-requirements.html' +summary: 'Retrieve the minimum number of required IP addresses' +--- + += Retrieve the minimum number of required IP addresses + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/network-requirements`# + + + +Retrieves the minimum number of required IP addresses for a single Cloud Volumes ONTAP system, HA node, and HA mediator. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nonHaNodeMinimumRequiredIps +|integer +|True +a| + +|haNodeMinimumRequiredIps +|integer +|False +a| + +|haMediatorMinimumRequiredIps +|integer +|False +a| + +|=== + + diff --git a/cvo/get-aws-ha-metadata-packages.adoc b/cvo/get-aws-ha-metadata-packages.adoc new file mode 100644 index 00000000..77fa20ab --- /dev/null +++ b/cvo/get-aws-ha-metadata-packages.adoc @@ -0,0 +1,187 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-packages.html' +summary: 'Retrieve packages configuration' +--- + += Retrieve packages configuration + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/packages`# + + + +Retrieves the packages configuration. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|deploymentModel +|string +|query +|False +a| + +|capacityPackage +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|displayName +|string +|False +a| + +|description +|string +|False +a| + +|licenseType +|string +|False +a| + +|instanceTypeMapping +|array[link:#InstanceTypeRegionMapping[InstanceTypeRegionMapping]] +|True +a| + +|diskType +|string +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|capacityTier +|string +|False +a| + +|instanceTenancy +|string +|False +a| + +|writingSpeedState +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|throughput +|link:#throughput[throughput] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#InstanceTypeRegionMapping] +[.api-collapsible-fifth-title] +InstanceTypeRegionMapping + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|False +a| + +|instanceType +|string +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#throughput] +[.api-collapsible-fifth-title] +throughput + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-metadata-permutations.adoc b/cvo/get-aws-ha-metadata-permutations.adoc new file mode 100644 index 00000000..d7ffad45 --- /dev/null +++ b/cvo/get-aws-ha-metadata-permutations.adoc @@ -0,0 +1,197 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-permutations.html' +summary: 'Retrieve all system configurations' +--- + += Retrieve all system configurations + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/permutations`# + + + +Retrieves all Cloud Volumes ONTAP configurations. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a| + +|license +|link:#OntapLicenseType[OntapLicenseType] +|True +a| + +|instanceType +|string +|False +a| + +|region +|link:#Region[Region] +|True +a| + +|defaultInstance +|boolean +|False +a| + +|features +|array[string] +|True +a| + +|upgradeableFrom +|array[string] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#Region] +[.api-collapsible-fifth-title] +Region + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|code +|string +|False +a| + +|location +|string +|False +a| + +|s3Region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-metadata-regions.adoc b/cvo/get-aws-ha-metadata-regions.adoc new file mode 100644 index 00000000..9243748b --- /dev/null +++ b/cvo/get-aws-ha-metadata-regions.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-regions.html' +summary: 'Retrieve AWS regions' +--- + += Retrieve AWS regions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/regions`# + + + +Retrieves AWS regions over which a Cloud Volumes ONTAP system can be created. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|code +|string +|False +a| + +|location +|string +|False +a| + +|s3Region +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "code": "string", + "location": "string", + "s3Region": "string" +} +==== + diff --git a/cvo/get-aws-ha-metadata-route-tables.adoc b/cvo/get-aws-ha-metadata-route-tables.adoc new file mode 100644 index 00000000..79c3b5bf --- /dev/null +++ b/cvo/get-aws-ha-metadata-route-tables.adoc @@ -0,0 +1,123 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-route-tables.html' +summary: 'Retrieve route tables per VPC and their subnet associations' +--- + += Retrieve route tables per VPC and their subnet associations + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/route-tables`# + + + +Retrieves route tables per VPC and their subnet associations. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|vpcId +|string +|query +|False +a| + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|main +|boolean +|True +a| + +|subnets +|array[string] +|True +a| + +|tags +|array[link:#RouteTableTag[RouteTableTag]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#RouteTableTag] +[.api-collapsible-fifth-title] +RouteTableTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|False +a| + +|value +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-metadata-s3-summary.adoc b/cvo/get-aws-ha-metadata-s3-summary.adoc new file mode 100644 index 00000000..c407970c --- /dev/null +++ b/cvo/get-aws-ha-metadata-s3-summary.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-s3-summary.html' +summary: 'Retrieve S3 buckets summary' +--- + += Retrieve S3 buckets summary + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/s3-summary`# + + + +Retrieves the S3 buckets summary. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSupportable +|boolean +|True +a| + +|numOfBuckets +|integer +|True +a| + +|numOfRegions +|integer +|False +a| + +|=== + + diff --git a/cvo/get-aws-ha-metadata-supported-capacity-tiers.adoc b/cvo/get-aws-ha-metadata-supported-capacity-tiers.adoc new file mode 100644 index 00000000..bf5f8b19 --- /dev/null +++ b/cvo/get-aws-ha-metadata-supported-capacity-tiers.adoc @@ -0,0 +1,156 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-supported-capacity-tiers.html' +summary: 'Retrieve supported capacity tiers for EBS volume types' +--- + += Retrieve supported capacity tiers for EBS volume types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/supported-capacity-tiers`# + + + +Retrieves supported capacity tiers for EBS volume types. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|ontapVersion +|string +|query +|False +a| + +|dataEncryptionType +|string +|query +|False +a| + +|licenseType +|string +|query +|False +a| + +|instanceType +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-metadata-supported-features.adoc b/cvo/get-aws-ha-metadata-supported-features.adoc new file mode 100644 index 00000000..13c2e949 --- /dev/null +++ b/cvo/get-aws-ha-metadata-supported-features.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-supported-features.html' +summary: 'Retrieve supported features' +--- + += Retrieve supported features + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/supported-features`# + + + +Retrieves the supported features. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|ontapVersion +|string +|query +|False +a| + +|dataEncryptionType +|string +|query +|False +a| + +|licenseType +|string +|query +|False +a| + +|instanceType +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|wormSupportedVersion +|boolean +|True +a| + +|cbsSupportedVersion +|boolean +|False +a| + +|httpsStorageAccountSupportedVersion +|boolean +|False +a| + +|tieringWithServiceAccount +|boolean +|False +a| + +|s3CmkEncryptionSupportedVersion +|boolean +|False +a| + +|gp3SupportedVersion +|boolean +|False +a| + +|elasticVolumeSupportedAndEnabled +|boolean +|False +a| + +|wormWithComposeSupported +|boolean +|False +a| + +|isAzureFlashcacheSupported +|boolean +|False +a| + +|wormWithBackupSupported +|boolean +|False +a| + +|azureHaManagedDisksSupported +|boolean +|False +a| + +|awsLocalZones +|boolean +|False +a| + +|isAzureZonalSupported +|boolean +|False +a| + +|=== + + diff --git a/cvo/get-aws-ha-metadata-tag-keys.adoc b/cvo/get-aws-ha-metadata-tag-keys.adoc new file mode 100644 index 00000000..33e7d336 --- /dev/null +++ b/cvo/get-aws-ha-metadata-tag-keys.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-tag-keys.html' +summary: 'Retrieve all tag names' +--- + += Retrieve all tag names + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/tag-keys`# + + + +Retrieves all of the tag names. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a| + +|values +|array[string] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "key": "string", + "values": [ + "string" + ] +} +==== + diff --git a/cvo/get-aws-ha-metadata-vpcs.adoc b/cvo/get-aws-ha-metadata-vpcs.adoc new file mode 100644 index 00000000..359d0953 --- /dev/null +++ b/cvo/get-aws-ha-metadata-vpcs.adoc @@ -0,0 +1,237 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-metadata-vpcs.html' +summary: 'Retrieve VPCs' +--- + += Retrieve VPCs + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/metadata/vpcs`# + + + +Retrieves VPCs. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|True +a|The VPC identifier + + +|state +|string +|True +a|The state of the VPC + + +|cidrBlock +|string +|True +a|VPC Classless Inter-Domain Routing (CIDR) block + + +|tags +|array[link:#VpcTagResponse[VpcTagResponse]] +|True +a|VPC tags + + +|default +|boolean +|True +a|Indicates whether the VPC is the default + + +|subnets +|array[link:#SubnetResponse[SubnetResponse]] +|True +a|Subnets associated with the VPC + + +|securityGroups +|array[link:#SecurityGroupResponse[SecurityGroupResponse]] +|True +a|Security groups associated with the VPC + + +|tenancy +|string +|True +a|Tenancy configuration for the VPC + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#VpcTagResponse] +[.api-collapsible-fifth-title] +VpcTagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|VPC tag key + + +|value +|string +|True +a|VPC tag value + + +|=== + + +[#SubnetResponse] +[.api-collapsible-fifth-title] +SubnetResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subnetId +|string +|True +a|Subnet ID + + +|cidr +|string +|True +a|CIDR + + +|subnetName +|string +|False +a|Subnet name + + +|availabilityZone +|string +|True +a|Availability zone + + +|availableIps +|integer +|True +a|The number of available IP addresses on the subnet + + +|minimumRequiredIps +|integer +|True +a|The minimum required IP addresses for the Cloud Volumes ONTAP create operation + +* format: int32 + + +|outpostArn +|string +|False +a|The ARN of the outpost + + +|=== + + +[#SecurityGroupResponse] +[.api-collapsible-fifth-title] +SecurityGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|securityGroupId +|string +|True +a|Security group ID + + +|description +|string +|True +a|Description + + +|name +|string +|True +a|Specifies the name + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-volumes--snapshots.adoc b/cvo/get-aws-ha-volumes--snapshots.adoc new file mode 100644 index 00000000..f8935633 --- /dev/null +++ b/cvo/get-aws-ha-volumes--snapshots.adoc @@ -0,0 +1,79 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-volumes--snapshots.html' +summary: 'Retrieve a list of snapshot descriptions for the volume' +--- + += Retrieve a list of snapshot descriptions for the volume + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots`# + + + +Returns a list of snapshot descriptions for the volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|accessTime +|integer +|True +a| + +|label +|string +|False +a| + +|=== + + diff --git a/cvo/get-aws-ha-volumes-igroups-.adoc b/cvo/get-aws-ha-volumes-igroups-.adoc new file mode 100644 index 00000000..5cfc9524 --- /dev/null +++ b/cvo/get-aws-ha-volumes-igroups-.adoc @@ -0,0 +1,219 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-volumes-igroups-.html' +summary: 'Retrieve all igroups' +--- + += Retrieve all igroups + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/volumes/igroups/{workingEnvironmentId}/{svmName}`# + + + +Retrieves all igroups. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|igroupName +|string +|True +a| + +|osType +|string +|False +a| + +|portsetName +|string +|False +a| + +|igroupType +|string +|True +a| + +|initiators +|array[string] +|True +a| + +|lunMaps +|array[link:#LunMapsLun[LunMapsLun]] +|True +a| + +|initiatorsWithConnStatus +|array[link:#InitiatorsConnectivityStateNameObject[InitiatorsConnectivityStateNameObject]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "igroupName": "string", + "osType": "string", + "portsetName": "string", + "igroupType": "string", + "initiators": [ + "string" + ], + "lunMaps": [ + { + "lun": { + "name": "string", + "uuid": "string" + } + } + ], + "initiatorsWithConnStatus": [ + { + "connectivity_tracking": { + "connection_state": "string" + }, + "name": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#NameUuidObject] +[.api-collapsible-fifth-title] +NameUuidObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|uuid +|string +|False +a| + +|=== + + +[#LunMapsLun] +[.api-collapsible-fifth-title] +LunMapsLun + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lun +|link:#NameUuidObject[NameUuidObject] +|True +a| + +|=== + + +[#ConnectionState] +[.api-collapsible-fifth-title] +ConnectionState + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connection_state +|string +|False +a| + +|=== + + +[#InitiatorsConnectivityStateNameObject] +[.api-collapsible-fifth-title] +InitiatorsConnectivityStateNameObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connectivity_tracking +|link:#ConnectionState[ConnectionState] +|True +a| + +|name +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-volumes-initiator.adoc b/cvo/get-aws-ha-volumes-initiator.adoc new file mode 100644 index 00000000..f340b1c0 --- /dev/null +++ b/cvo/get-aws-ha-volumes-initiator.adoc @@ -0,0 +1,56 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-volumes-initiator.html' +summary: 'Retrieve all iSCSI initiators' +--- + += Retrieve all iSCSI initiators + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/volumes/initiator`# + + + +Retrieves all iSCSI initiators. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + diff --git a/cvo/get-aws-ha-volumes-volumes-for-backup.adoc b/cvo/get-aws-ha-volumes-volumes-for-backup.adoc new file mode 100644 index 00000000..ab89b8b8 --- /dev/null +++ b/cvo/get-aws-ha-volumes-volumes-for-backup.adoc @@ -0,0 +1,288 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-volumes-volumes-for-backup.html' +summary: 'Retrieve volumes for backup activation' +--- + += Retrieve volumes for backup activation + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/volumes/volumes-for-backup`# + + + +Retrieves all volumes for backup activation. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|offset +|integer +|query +|False +a| + +|limit +|integer +|query +|False +a| + +|search +|string +|query +|False +a| + +|filterBy +|link:#ListFilterByParam[ListFilterByParam] +|query +|False +a| + +|sortBy +|link:#ListSortByParam[ListSortByParam] +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumes +|array[link:#VolumeForBackupResponse[VolumeForBackupResponse]] +|True +a| + +|totalNumberOfVolumes +|integer +|True +a| + +|filteredNumberOfVolumes +|link:#filteredNumberOfVolumes[filteredNumberOfVolumes] +|False +a| + +|hasNextPage +|link:#hasNextPage[hasNextPage] +|False +a| + +|allowedValuesForVolumesListFilter +|link:#AllowedValuesForVolumesListFilter[AllowedValuesForVolumesListFilter] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ListFilterByParam] +[.api-collapsible-fifth-title] +ListFilterByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#ListSortByParam] +[.api-collapsible-fifth-title] +ListSortByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeForBackupResponse] +[.api-collapsible-fifth-title] +VolumeForBackupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|uuid +|string +|False +a| + +|svmName +|string +|False +a| + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|False +a| + +|state +|string +|False +a| + +|providerVolumeType +|string +|False +a| + +|volumeType +|string +|False +a| + +|isBackupOn +|boolean +|True +a| + +|disableReasonBackup +|array[string] +|True +a| + +|=== + + +[#filteredNumberOfVolumes] +[.api-collapsible-fifth-title] +filteredNumberOfVolumes + + +[#hasNextPage] +[.api-collapsible-fifth-title] +hasNextPage + + +[#AllowedValuesForVolumesListFilter] +[.api-collapsible-fifth-title] +AllowedValuesForVolumesListFilter + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeTypes +|array[string] +|False +a| + +|diskTypes +|array[string] +|False +a| + +|svmNames +|array[string] +|False +a| + +|volumeStatus +|array[string] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-volumes.adoc b/cvo/get-aws-ha-volumes.adoc new file mode 100644 index 00000000..85056d5e --- /dev/null +++ b/cvo/get-aws-ha-volumes.adoc @@ -0,0 +1,550 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-volumes.html' +summary: 'Retrieve all volumes' +--- + += Retrieve all volumes + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/volumes`# + + + +Retrieves all volumes. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Volume name + + +|uuid +|string +|True +a|Volume UUID + + +|svmName +|string +|True +a|Volume SVM name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|junctionPath +|string +|True +a|The junction path at which this volume is mounted + + +|volumeTotalInodes +|integer +|False +a|Total volume inodes size + + +|volumeUsedInodes +|integer +|False +a|Used volume inodes size + + +|mountPoint +|string +|False +a|Mount Point + + +|compressionSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|deduplicationSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioning +|boolean +|True +a|Specifies whether thin provisioning is enabled + + +|compression +|boolean +|True +a|Specifies whether compression is enabled + + +|deduplication +|boolean +|True +a|Specifies whether deduplication is enabled + + +|snapshotPolicy +|string +|True +a|The name of the snapshot policy + + +|securityStyle +|string +|True +a|The type of the security style + + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|True +a| + +|shareNames +|array[string] +|True +a|The share names for CIFS + + +|shareInfo +|array[link:#CifsShareInfo[CifsShareInfo]] +|True +a|The share names, permissions, and users for CIFS + + +|parentVolumeName +|string +|True +a|Name of the parent flexible volume for the clone + + +|rootVolume +|boolean +|True +a|Flag to indicate if the volume is a SVM root + + +|state +|string +|True +a|Volume state + + +|volumeType +|string +|True +a|Volume type + + +|aggregateName +|string +|True +a|Aggregate name + + +|parentSnapshot +|string +|False +a|The snapshot name the volume is based on + + +|autoSizeMode +|string +|True +a|The operating mode of autosize + + +|maxGrowSize +|link:#Capacity[Capacity] +|True +a| + +|providerVolumeType +|string +|False +a|Cloud provider volume type + + +|cloneNames +|array[string] +|True +a|Names of cloned copies of the volume + + +|moving +|boolean +|True +a|Specifies if the volume move process is in progress + + +|primaryNoFailoverMountPoint +|string +|False +a|Primary mount point without failover + + +|secondaryNoFailoverMountPoint +|string +|False +a|Secondary mount point without failover + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cifsShareAccessPoint +|string +|False +a|CIFS share access point + + +|primaryCifsShareAccessPoint +|string +|False +a|Primary CIFS share access point + + +|secondaryCifsShareAccessPoint +|string +|False +a|Secondary CIFS share access point + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|tierInactiveUserData +|link:#Capacity[Capacity] +|False +a| + +|tierInactiveUserDataPercent +|integer +|False +a|Tier inactive user data percentage + + +|comment +|string +|False +a|Volume comment + + +|qosPolicyGroupName +|string +|False +a|Quality of service policy group name + + +|snaplockType +|string +|False +a|SnapLock type + + +|constituentsAggregates +|array[string] +|True +a|Aggregates which are used for FlexGroup constituents + + +|snapshotsUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cbsBackupsInfo +|link:#VolumeCbsInfo[VolumeCbsInfo] +|False +a| + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|targetName +|string +|True +a|iSCSI target IQN + + +|iscsiEnabled +|boolean +|True +a|Indicates if the volume is used by the iSCSI protocol + + +|isFlexGroupVolume +|boolean +|True +a|Indicates if the volume is a FlexGroup volume + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#VolumeCbsInfo] +[.api-collapsible-fifth-title] +VolumeCbsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalBackups +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-working-environments-.adoc b/cvo/get-aws-ha-working-environments-.adoc new file mode 100644 index 00000000..ae6ed6a5 --- /dev/null +++ b/cvo/get-aws-ha-working-environments-.adoc @@ -0,0 +1,3254 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-.html' +summary: 'Retrieve an HA system' +--- + += Retrieve an HA system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}`# + + + +Retrieves an HA Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|awsProperties +|link:#AwsProperties[AwsProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|interClusterLifs +|array[link:#InterClusterLif[InterClusterLif]] +|True +a| + +|cronJobSchedules +|array[link:#CronJobSchedule[CronJobSchedule]] +|True +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|cloudProviderName +|string +|False +a| + +|isHA +|boolean +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|haProperties +|link:#AwsHaProperties[AwsHaProperties] +|False +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|cloudSyncProperties +|link:#CloudSyncProperties[CloudSyncProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags + +Instance tags + +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#InstanceResponse] +[.api-collapsible-fifth-title] +InstanceResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Instance ID + + +|name +|string +|True +a|Instance name + + +|instanceType +|string +|True +a|Instance type + + +|state +|string +|True +a|Instance state + + +|publicIpAddress +|string +|True +a|Public IP address that is assigned to the instance + + +|privateIpAddress +|string +|True +a|Private IP address that is assigned to the instance + + +|publicDnsName +|string +|True +a|Public DNS + + +|privateDnsName +|string +|True +a|Private DNS name + + +|imageId +|string +|True +a|Image ID + + +|subnetId +|string +|True +a|Subnet ID + + +|availabilityZone +|string +|True +a|Availability zone + + +|isVsaInstance +|boolean +|True +a|Indicates if the instance is a Cloud Volumes ONTAP instance + + +|isOCCMInstance +|boolean +|True +a|Indicates if the instance is a NetApp Console instance + + +|tags +|link:#tags[tags] +|True +a|Instance tags + + +|productCode +|string +|True +a|Product code + + +|tenancy +|string +|True +a|Instance Tenancy + + +|placementGroup +|string +|True +a|Placement group + + +|keyPairName +|string +|True +a|Key pair + + +|instanceProfileId +|string +|False +a|Instance profile ID + + +|=== + + +[#VpcTagResponse] +[.api-collapsible-fifth-title] +VpcTagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|VPC tag key + + +|value +|string +|True +a|VPC tag value + + +|=== + + +[#VpcBasicResponse] +[.api-collapsible-fifth-title] +VpcBasicResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|True +a|The VPC identifier + + +|state +|string +|True +a|The state of the VPC + + +|cidrBlock +|string +|True +a|VPC Classless Inter-Domain Routing (CIDR) block + + +|tags +|array[link:#VpcTagResponse[VpcTagResponse]] +|True +a|VPC tags + + +|default +|boolean +|True +a|Indicates whether the VPC is the default + + +|=== + + +[#bootDiskSize] +[.api-collapsible-fifth-title] +bootDiskSize + + +[#coreDiskExists] +[.api-collapsible-fifth-title] +coreDiskExists + + +[#AwsProperties] +[.api-collapsible-fifth-title] +AwsProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|availabilityZones +|array[string] +|False +a| + +|instances +|array[link:#InstanceResponse[InstanceResponse]] +|False +a| + +|vpc +|link:#VpcBasicResponse[VpcBasicResponse] +|False +a| + +|accountId +|string +|False +a| + +|roleArn +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|bootDiskSize +|link:#bootDiskSize[bootDiskSize] +|False +a| + +|outpostArn +|string +|False +a| + +|coreDiskExists +|link:#coreDiskExists[coreDiskExists] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#InterClusterLif] +[.api-collapsible-fifth-title] +InterClusterLif + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|port +|string +|False +a| + +|node +|string +|False +a| + +|status +|string +|False +a| + +|isPeered +|boolean +|False +a| + +|=== + + +[#CronJobSchedule] +[.api-collapsible-fifth-title] +CronJobSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|description +|string +|False +a| + +|months +|array[string] +|True +a| + +|days +|array[string] +|False +a| + +|weekDays +|array[string] +|False +a| + +|hours +|array[string] +|False +a| + +|minutes +|array[string] +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MediatorVersionInfo] +[.api-collapsible-fifth-title] +MediatorVersionInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|version +|string +|False +a| + +|description +|string +|False +a| + +|state +|string +|True +a| + +|bootVolumeId +|string +|False +a| + +|=== + + +[#MediatorStatus] +[.api-collapsible-fifth-title] +MediatorStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|statusCode +|integer +|False +a| + +|statusMessage +|string +|False +a| + +|=== + + +[#MediatorUpdateVersionMetadata] +[.api-collapsible-fifth-title] +MediatorUpdateVersionMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersion +|string +|False +a| + +|timeStamp +|integer +|False +a| + +|metadataFileName +|string +|False +a| + +|major +|boolean +|False +a| + +|manifestFileName +|string +|False +a| + +|=== + + +[#AwsHaProperties] +[.api-collapsible-fifth-title] +AwsHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersionInfo +|link:#MediatorVersionInfo[MediatorVersionInfo] +|False +a| + +|mediatorStatus +|link:#MediatorStatus[MediatorStatus] +|False +a| + +|routeTables +|array[string] +|False +a| + +|mediatorVersionsToUpdate +|array[link:#MediatorUpdateVersionMetadata[MediatorUpdateVersionMetadata]] +|False +a| + +|failoverMode +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#CloudSyncStatus] +[.api-collapsible-fifth-title] +CloudSyncStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#DataBrokerPlacement] +[.api-collapsible-fifth-title] +DataBrokerPlacement + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|False +a| + +|subnetId +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|keyPair +|string +|False +a| + +|=== + + +[#DataBrokerProperties] +[.api-collapsible-fifth-title] +DataBrokerProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|dataBrokerPlacement +|link:#DataBrokerPlacement[DataBrokerPlacement] +|False +a| + +|=== + + +[#CloudSyncRelationship] +[.api-collapsible-fifth-title] +CloudSyncRelationship + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|relationshipStatus +|string +|False +a| + +|s3Location +|string +|False +a| + +|id +|string +|False +a| + +|progress +|integer +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#CloudSyncProperties] +[.api-collapsible-fifth-title] +CloudSyncProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSynced +|boolean +|False +a| + +|status +|link:#CloudSyncStatus[CloudSyncStatus] +|False +a| + +|dataBrokerProperties +|link:#DataBrokerProperties[DataBrokerProperties] +|False +a| + +|s3Location +|string +|False +a| + +|relationships +|array[link:#CloudSyncRelationship[CloudSyncRelationship]] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-working-environments-cifs-locks-exist.adoc b/cvo/get-aws-ha-working-environments-cifs-locks-exist.adoc new file mode 100644 index 00000000..965e4e3f --- /dev/null +++ b/cvo/get-aws-ha-working-environments-cifs-locks-exist.adoc @@ -0,0 +1,43 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-cifs-locks-exist.html' +summary: 'Check for non-persistent locks held on CIFS sessions' +--- + += Check for non-persistent locks held on CIFS sessions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist`# + + + +Checks for non-persistent locks held on CIFS sessions. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + + diff --git a/cvo/get-aws-ha-working-environments-cifs.adoc b/cvo/get-aws-ha-working-environments-cifs.adoc new file mode 100644 index 00000000..7c9d55fe --- /dev/null +++ b/cvo/get-aws-ha-working-environments-cifs.adoc @@ -0,0 +1,110 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-cifs.html' +summary: 'Retrieve the CIFS configuration for a system' +--- + += Retrieve the CIFS configuration for a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/cifs`# + + + +Retrieves the CIFS configuration for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svm +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|True +a|DNS domain name + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|authenticationType +|string +|True +a|Authentication type + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "activeDirectoryDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "authenticationType": "string" +} +==== + diff --git a/cvo/get-aws-ha-working-environments-cost-and-usage.adoc b/cvo/get-aws-ha-working-environments-cost-and-usage.adoc new file mode 100644 index 00000000..3f60ef80 --- /dev/null +++ b/cvo/get-aws-ha-working-environments-cost-and-usage.adoc @@ -0,0 +1,241 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-cost-and-usage.html' +summary: 'Retrieve the system cost and usage' +--- + += Retrieve the system cost and usage + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/cost-and-usage`# + + + +Retrieves the system cost and usage. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|start +|string +|query +|False +a| + +|end +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hasPermissions +|boolean +|True +a|Permissions to view the cost and usage details + + +|costByTime +|array[link:#CostByTime[CostByTime]] +|True +a|System cost and usage details + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Money] +[.api-collapsible-fifth-title] +Money + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|True +a|Amount + + +|currency +|string +|True +a|Currency + + +|=== + + +[#Usage] +[.api-collapsible-fifth-title] +Usage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|False +a|Amount + + +|units +|string +|True +a|Units + + +|=== + + +[#CostByUsage] +[.api-collapsible-fifth-title] +CostByUsage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Breakdown element name + + +|cost +|link:#Money[Money] +|True +a| + +|usage +|link:#Usage[Usage] +|True +a| + +|=== + + +[#CostByService] +[.api-collapsible-fifth-title] +CostByService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the cost domain (compute, disk/blob storage, object storage, data transfer) + + +|total +|link:#Money[Money] +|True +a| + +|costByUsage +|array[link:#CostByUsage[CostByUsage]] +|True +a|Cost domain breakdown + + +|=== + + +[#CostByTime] +[.api-collapsible-fifth-title] +CostByTime + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|start +|string +|True +a|Cost period start date + + +|end +|string +|True +a|Cost period end date + + +|estimated +|boolean +|True +a|Indicates whether the cost is estimated + + +|total +|link:#Money[Money] +|True +a| + +|costByService +|array[link:#CostByService[CostByService]] +|True +a|Monthly cost and usage details + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-working-environments-create-request-parameters.adoc b/cvo/get-aws-ha-working-environments-create-request-parameters.adoc new file mode 100644 index 00000000..d8da571f --- /dev/null +++ b/cvo/get-aws-ha-working-environments-create-request-parameters.adoc @@ -0,0 +1,95 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-create-request-parameters.html' +summary: 'Retrieve action parameters' +--- + += Retrieve action parameters + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/create-request-parameters`# + + + +Retrieves the action parameters used in the create request for a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|parameters +|link:#MapStringObject[MapStringObject] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject + + +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject +Hash mapping strings to link:#MapStringObject[MapStringObject] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|True +a| + +|empty +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-working-environments-extra-capacity-licenses.adoc b/cvo/get-aws-ha-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..1768f597 --- /dev/null +++ b/cvo/get-aws-ha-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-extra-capacity-licenses.html' +summary: 'Retrieve extra capacity licenses' +--- + += Retrieve extra capacity licenses + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Retrieves extra capacity licenses for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serialNumber +|string +|True +a| + +|resourceId +|string +|False +a| + +|licenseType +|string +|False +a| + +|expirationDate +|integer +|True +a| + +|license +|string +|False +a| + +|capacity +|number +|True +a| + +|metadata +|string +|False +a| + +|associatedResourceId +|string +|False +a| + +|licensePackage +|string +|False +a| + +|accountId +|string +|False +a| + +|=== + + diff --git a/cvo/get-aws-ha-working-environments-license-instance-type.adoc b/cvo/get-aws-ha-working-environments-license-instance-type.adoc new file mode 100644 index 00000000..d39d2c37 --- /dev/null +++ b/cvo/get-aws-ha-working-environments-license-instance-type.adoc @@ -0,0 +1,146 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-license-instance-type.html' +summary: 'Retrieve all license types and their associated instance types' +--- + += Retrieve all license types and their associated instance types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/license-instance-type`# + + + +Retrieves all license types and their associated instance types for a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenseType +|string +|True +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|instanceTypes +|array[link:#InstanceTypeInfo[InstanceTypeInfo]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#InstanceTypeInfo] +[.api-collapsible-fifth-title] +InstanceTypeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|False +a| + +|supportsEncryption +|boolean +|True +a| + +|supportedFeatures +|array[string] +|True +a| + +|isDefault +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-working-environments-occm-provided-upgrade-versions.adoc b/cvo/get-aws-ha-working-environments-occm-provided-upgrade-versions.adoc new file mode 100644 index 00000000..1aafee8c --- /dev/null +++ b/cvo/get-aws-ha-working-environments-occm-provided-upgrade-versions.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-occm-provided-upgrade-versions.html' +summary: 'Retrieve a list of upgrade versions' +--- + += Retrieve a list of upgrade versions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions`# + + + +Retrieves a list of versions to which this Cloud Volumes ONTAP system can be upgraded. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-aws-ha-working-environments-ontap-available-images.adoc b/cvo/get-aws-ha-working-environments-ontap-available-images.adoc new file mode 100644 index 00000000..97a0b0e7 --- /dev/null +++ b/cvo/get-aws-ha-working-environments-ontap-available-images.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-ontap-available-images.html' +summary: 'Retrieve images already installed on system' +--- + += Retrieve images already installed on system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/ontap-available-images`# + + + +Retrieves images already installed on the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|version +|string +|False +a| + +|isCurrent +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-aws-ha-working-environments-ontap-saving.adoc b/cvo/get-aws-ha-working-environments-ontap-saving.adoc new file mode 100644 index 00000000..57e657fe --- /dev/null +++ b/cvo/get-aws-ha-working-environments-ontap-saving.adoc @@ -0,0 +1,129 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-ontap-saving.html' +summary: 'Retrieve systems ONTAP savings' +--- + += Retrieve systems ONTAP savings + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/ontap-saving`# + + + +Retrieves system ONTAP savings. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|savings +|array[link:#SavingsInfo[SavingsInfo]] +|True +a|List of savings + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "savings": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Money] +[.api-collapsible-fifth-title] +Money + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|True +a|Amount + + +|currency +|string +|True +a|Currency + + +|=== + + +[#SavingsInfo] +[.api-collapsible-fifth-title] +SavingsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of saving element + + +|monthlySaving +|link:#Money[Money] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-working-environments-schedules.adoc b/cvo/get-aws-ha-working-environments-schedules.adoc new file mode 100644 index 00000000..ea3a9598 --- /dev/null +++ b/cvo/get-aws-ha-working-environments-schedules.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-schedules.html' +summary: 'List the start/stop schedules for a system' +--- + += List the start/stop schedules for a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/schedules`# + + + +Lists the start/stop schedules for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "schedule": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-working-environments-support-registration.adoc b/cvo/get-aws-ha-working-environments-support-registration.adoc new file mode 100644 index 00000000..80511d38 --- /dev/null +++ b/cvo/get-aws-ha-working-environments-support-registration.adoc @@ -0,0 +1,101 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-support-registration.html' +summary: 'Retrieve the support registration status of a system' +--- + += Retrieve the support registration status of a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/support-registration`# + + + +Retrieves the support registration status of a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|licenseStartDate +|link:#licenseStartDate[licenseStartDate] +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "nssAccountId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#licenseStartDate] +[.api-collapsible-fifth-title] +licenseStartDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-working-environments-update-eligibility.adoc b/cvo/get-aws-ha-working-environments-update-eligibility.adoc new file mode 100644 index 00000000..4f5bc8c3 --- /dev/null +++ b/cvo/get-aws-ha-working-environments-update-eligibility.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-update-eligibility.html' +summary: 'Retrieve the eligibility support status of a system' +--- + += Retrieve the eligibility support status of a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/update-eligibility`# + + + +Retrieves the eligibility support status of a Cloud Volumes ONTAP system. Valid values are NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|eligibilityResponse +|string +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "eligibilityResponse": "string" +} +==== + diff --git a/cvo/get-aws-ha-working-environments-user-tags.adoc b/cvo/get-aws-ha-working-environments-user-tags.adoc new file mode 100644 index 00000000..e2dc33cc --- /dev/null +++ b/cvo/get-aws-ha-working-environments-user-tags.adoc @@ -0,0 +1,104 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-user-tags.html' +summary: 'Retrieve editable tags for cloud resources' +--- + += Retrieve editable tags for cloud resources + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/user-tags`# + + + +Retrieves the editable tags for the cloud resources in a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tags +|array[link:#CloudResourceTag[CloudResourceTag]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tags": [ + { + "tagKey": "string", + "tagValue": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudResourceTag] +[.api-collapsible-fifth-title] +CloudResourceTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|True +a| + +|tagValue +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-working-environments-validate-byol-to-capacity.adoc b/cvo/get-aws-ha-working-environments-validate-byol-to-capacity.adoc new file mode 100644 index 00000000..606e3cf6 --- /dev/null +++ b/cvo/get-aws-ha-working-environments-validate-byol-to-capacity.adoc @@ -0,0 +1,214 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments-validate-byol-to-capacity.html' +summary: 'Validate prerequisites for converting a system' +--- + += Validate prerequisites for converting a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity`# + + + +Validates the prerequisites for converting an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|validAccount +|boolean +|True +a| + +|validNss +|boolean +|False +a| + +|mpSub +|array[link:#CloudAccountResponse[CloudAccountResponse]] +|True +a| + +|capacityLicenses +|array[link:#CapacityLicenseInfo[CapacityLicenseInfo]] +|True +a| + +|totalPrimaryVolumes +|link:#Capacity[Capacity] +|True +a| + +|totalDpVolumes +|link:#Capacity[Capacity] +|False +a| + +|vmPlan +|string +|False +a| + +|awsOldDeployment +|boolean +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudAccountResponse] +[.api-collapsible-fifth-title] +CloudAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudAccountId +|string +|True +a| + +|provider +|string +|False +a| + +|subscriptionId +|string +|False +a| + +|=== + + +[#TotalCapacity] +[.api-collapsible-fifth-title] +TotalCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacity +|integer +|True +a| + +|units +|string +|False +a| + +|=== + + +[#CapacityLicenseInfo] +[.api-collapsible-fifth-title] +CapacityLicenseInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|flavorType +|string +|False +a| + +|contractType +|string +|False +a| + +|totalLicensedCapacity +|link:#TotalCapacity[TotalCapacity] +|True +a| + +|totalConsumedCapacity +|link:#TotalCapacity[TotalCapacity] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-aws-ha-working-environments.adoc b/cvo/get-aws-ha-working-environments.adoc new file mode 100644 index 00000000..38b6c144 --- /dev/null +++ b/cvo/get-aws-ha-working-environments.adoc @@ -0,0 +1,3254 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-aws-ha-working-environments.html' +summary: 'Retrieve Cloud Volumes ONTAP systems' +--- + += Retrieve Cloud Volumes ONTAP systems + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/ha/working-environments`# + + + +Retrieves Cloud Volumes ONTAP systems visible to the current user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|tenantId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|awsProperties +|link:#AwsProperties[AwsProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|interClusterLifs +|array[link:#InterClusterLif[InterClusterLif]] +|True +a| + +|cronJobSchedules +|array[link:#CronJobSchedule[CronJobSchedule]] +|True +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|cloudProviderName +|string +|False +a| + +|isHA +|boolean +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|haProperties +|link:#AwsHaProperties[AwsHaProperties] +|False +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|cloudSyncProperties +|link:#CloudSyncProperties[CloudSyncProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags + +Instance tags + +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#InstanceResponse] +[.api-collapsible-fifth-title] +InstanceResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Instance ID + + +|name +|string +|True +a|Instance name + + +|instanceType +|string +|True +a|Instance type + + +|state +|string +|True +a|Instance state + + +|publicIpAddress +|string +|True +a|Public IP address that is assigned to the instance + + +|privateIpAddress +|string +|True +a|Private IP address that is assigned to the instance + + +|publicDnsName +|string +|True +a|Public DNS + + +|privateDnsName +|string +|True +a|Private DNS name + + +|imageId +|string +|True +a|Image ID + + +|subnetId +|string +|True +a|Subnet ID + + +|availabilityZone +|string +|True +a|Availability zone + + +|isVsaInstance +|boolean +|True +a|Indicates if the instance is a Cloud Volumes ONTAP instance + + +|isOCCMInstance +|boolean +|True +a|Indicates if the instance is a NetApp Console instance + + +|tags +|link:#tags[tags] +|True +a|Instance tags + + +|productCode +|string +|True +a|Product code + + +|tenancy +|string +|True +a|Instance Tenancy + + +|placementGroup +|string +|True +a|Placement group + + +|keyPairName +|string +|True +a|Key pair + + +|instanceProfileId +|string +|False +a|Instance profile ID + + +|=== + + +[#VpcTagResponse] +[.api-collapsible-fifth-title] +VpcTagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|VPC tag key + + +|value +|string +|True +a|VPC tag value + + +|=== + + +[#VpcBasicResponse] +[.api-collapsible-fifth-title] +VpcBasicResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|True +a|The VPC identifier + + +|state +|string +|True +a|The state of the VPC + + +|cidrBlock +|string +|True +a|VPC Classless Inter-Domain Routing (CIDR) block + + +|tags +|array[link:#VpcTagResponse[VpcTagResponse]] +|True +a|VPC tags + + +|default +|boolean +|True +a|Indicates whether the VPC is the default + + +|=== + + +[#bootDiskSize] +[.api-collapsible-fifth-title] +bootDiskSize + + +[#coreDiskExists] +[.api-collapsible-fifth-title] +coreDiskExists + + +[#AwsProperties] +[.api-collapsible-fifth-title] +AwsProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|availabilityZones +|array[string] +|False +a| + +|instances +|array[link:#InstanceResponse[InstanceResponse]] +|False +a| + +|vpc +|link:#VpcBasicResponse[VpcBasicResponse] +|False +a| + +|accountId +|string +|False +a| + +|roleArn +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|bootDiskSize +|link:#bootDiskSize[bootDiskSize] +|False +a| + +|outpostArn +|string +|False +a| + +|coreDiskExists +|link:#coreDiskExists[coreDiskExists] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#InterClusterLif] +[.api-collapsible-fifth-title] +InterClusterLif + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|port +|string +|False +a| + +|node +|string +|False +a| + +|status +|string +|False +a| + +|isPeered +|boolean +|False +a| + +|=== + + +[#CronJobSchedule] +[.api-collapsible-fifth-title] +CronJobSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|description +|string +|False +a| + +|months +|array[string] +|True +a| + +|days +|array[string] +|False +a| + +|weekDays +|array[string] +|False +a| + +|hours +|array[string] +|False +a| + +|minutes +|array[string] +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MediatorVersionInfo] +[.api-collapsible-fifth-title] +MediatorVersionInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|version +|string +|False +a| + +|description +|string +|False +a| + +|state +|string +|True +a| + +|bootVolumeId +|string +|False +a| + +|=== + + +[#MediatorStatus] +[.api-collapsible-fifth-title] +MediatorStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|statusCode +|integer +|False +a| + +|statusMessage +|string +|False +a| + +|=== + + +[#MediatorUpdateVersionMetadata] +[.api-collapsible-fifth-title] +MediatorUpdateVersionMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersion +|string +|False +a| + +|timeStamp +|integer +|False +a| + +|metadataFileName +|string +|False +a| + +|major +|boolean +|False +a| + +|manifestFileName +|string +|False +a| + +|=== + + +[#AwsHaProperties] +[.api-collapsible-fifth-title] +AwsHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersionInfo +|link:#MediatorVersionInfo[MediatorVersionInfo] +|False +a| + +|mediatorStatus +|link:#MediatorStatus[MediatorStatus] +|False +a| + +|routeTables +|array[string] +|False +a| + +|mediatorVersionsToUpdate +|array[link:#MediatorUpdateVersionMetadata[MediatorUpdateVersionMetadata]] +|False +a| + +|failoverMode +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#CloudSyncStatus] +[.api-collapsible-fifth-title] +CloudSyncStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#DataBrokerPlacement] +[.api-collapsible-fifth-title] +DataBrokerPlacement + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|False +a| + +|subnetId +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|keyPair +|string +|False +a| + +|=== + + +[#DataBrokerProperties] +[.api-collapsible-fifth-title] +DataBrokerProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|dataBrokerPlacement +|link:#DataBrokerPlacement[DataBrokerPlacement] +|False +a| + +|=== + + +[#CloudSyncRelationship] +[.api-collapsible-fifth-title] +CloudSyncRelationship + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|relationshipStatus +|string +|False +a| + +|s3Location +|string +|False +a| + +|id +|string +|False +a| + +|progress +|integer +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#CloudSyncProperties] +[.api-collapsible-fifth-title] +CloudSyncProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSynced +|boolean +|False +a| + +|status +|link:#CloudSyncStatus[CloudSyncStatus] +|False +a| + +|dataBrokerProperties +|link:#DataBrokerProperties[DataBrokerProperties] +|False +a| + +|s3Location +|string +|False +a| + +|relationships +|array[link:#CloudSyncRelationship[CloudSyncRelationship]] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-aggregates-.adoc b/cvo/get-azure-ha-aggregates-.adoc new file mode 100644 index 00000000..a8e57287 --- /dev/null +++ b/cvo/get-azure-ha-aggregates-.adoc @@ -0,0 +1,404 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-aggregates-.html' +summary: 'Retrieve aggregates' +--- + += Retrieve aggregates + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/aggregates/{workingEnvironmentId}`# + + + +Retrieves aggregates. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Aggregate name + + +|availableCapacity +|link:#Capacity[Capacity] +|True +a| + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|usedCapacity +|link:#Capacity[Capacity] +|True +a| + +|volumes +|array[link:#Volume[Volume]] +|True +a|Volumes + + +|providerVolumes +|array[link:#ProviderVolumeResponse[ProviderVolumeResponse]] +|True +a|Provider volumes + + +|disks +|array[link:#Disk[Disk]] +|True +a|Disks + + +|state +|string +|False +a|State + + +|encryptionType +|string +|True +a|Encryption Type + + +|encryptionKeyId +|string +|False +a|Encryption Key + + +|isRoot +|boolean +|True +a|Is Root + + +|homeNode +|string +|True +a|Home node + + +|ownerNode +|string +|False +a|Owner node + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsed +|link:#Capacity[Capacity] +|False +a| + +|sidlEnabled +|boolean +|True +a|SIDL enabled + + +|snaplockType +|string +|True +a|Snaplock type + + +|evCompatibilityType +|string +|True +a|Elastic Volume Compatibility Type + + +|iops +|link:#iops[iops] +|False +a|Aggregate IOPS + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Volume] +[.api-collapsible-fifth-title] +Volume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|totalSize +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioned +|boolean +|True +a|Indicates if the volume is thin-provisioned + + +|isClone +|boolean +|True +a|Indicates if the volume is a clone volume + + +|rootVolume +|boolean +|True +a|Indicates if the volume is the root volume of the SVM + + +|=== + + +[#ProviderVolumeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Specifies the ID + + +|name +|string +|True +a|Specifies the name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|state +|string +|True +a|State + + +|device +|string +|True +a|Device + + +|instanceId +|string +|True +a|InstanceId + + +|diskType +|string +|True +a|Type + + +|encrypted +|boolean +|True +a|Encrypted + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|instance2Id +|string +|False +a|Instance2Id + + +|=== + + +[#VmDiskProperties] +[.api-collapsible-fifth-title] +VmDiskProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectName +|string +|False +a| + +|storageAccountName +|string +|False +a| + +|containerName +|string +|False +a| + +|=== + + +[#Disk] +[.api-collapsible-fifth-title] +Disk + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Name + + +|containerType +|string +|True +a|Container type + + +|ownerNode +|string +|True +a|Owner node + + +|device +|string +|False +a|Device + + +|vmDiskProperties +|link:#VmDiskProperties[VmDiskProperties] +|False +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + +Aggregate IOPS + + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-discovery-discover.adoc b/cvo/get-azure-ha-discovery-discover.adoc new file mode 100644 index 00000000..2ab96507 --- /dev/null +++ b/cvo/get-azure-ha-discovery-discover.adoc @@ -0,0 +1,129 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-discovery-discover.html' +summary: 'Retrieve a list of systems for the Azure region' +--- + += Retrieve a list of systems for the Azure region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/discovery/discover`# + + + +Retrieves a list of discovered systems visible to the current user in the specified Azure region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|publicId +|string +|False +a| + +|region +|string +|False +a| + +|vnetName +|string +|False +a| + +|vnetId +|string +|False +a| + +|subnetId +|string +|False +a| + +|subnetName +|string +|False +a| + +|resourceGroup +|string +|False +a| + +|clusterAddress +|string +|False +a| + +|recoverable +|boolean +|True +a| + +|byol +|boolean +|False +a| + +|registered +|boolean +|False +a| + +|isDirectMarketplace +|boolean +|False +a| + +|=== + + diff --git a/cvo/get-azure-ha-metadata-associated-subscriptions.adoc b/cvo/get-azure-ha-metadata-associated-subscriptions.adoc new file mode 100644 index 00000000..46071351 --- /dev/null +++ b/cvo/get-azure-ha-metadata-associated-subscriptions.adoc @@ -0,0 +1,101 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-associated-subscriptions.html' +summary: 'Retrieve subscriptions' +--- + += Retrieve subscriptions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/associated-subscriptions`# + + + +Retrieves associated subscriptions. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|True +a| + +|name +|string +|False +a| + +|default +|boolean +|True +a| + +|saasSubscriptionId +|string +|False +a| + +|highAvailabilityEnabled +|link:#highAvailabilityEnabled[highAvailabilityEnabled] +|False +a| + +|vMOrchestratorZonalMultiFDEnabled +|link:#vMOrchestratorZonalMultiFDEnabled[vMOrchestratorZonalMultiFDEnabled] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#highAvailabilityEnabled] +[.api-collapsible-fifth-title] +highAvailabilityEnabled + + +[#vMOrchestratorZonalMultiFDEnabled] +[.api-collapsible-fifth-title] +vMOrchestratorZonalMultiFDEnabled + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-metadata-availability-zones.adoc b/cvo/get-azure-ha-metadata-availability-zones.adoc new file mode 100644 index 00000000..1830d052 --- /dev/null +++ b/cvo/get-azure-ha-metadata-availability-zones.adoc @@ -0,0 +1,105 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-availability-zones.html' +summary: 'Retrieve Azure availability zones' +--- + += Retrieve Azure availability zones + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/availability-zones`# + + + +Retrieves Azure availability zones by region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|True +a|region value + + +|zones +|array[link:#zones[zones]] +|True +a|Zone values + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": "string", + "zones": [ + "object" + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#zones] +[.api-collapsible-fifth-title] +zones + +Zone values + + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-metadata-containers.adoc b/cvo/get-azure-ha-metadata-containers.adoc new file mode 100644 index 00000000..8d6ff2fa --- /dev/null +++ b/cvo/get-azure-ha-metadata-containers.adoc @@ -0,0 +1,90 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-containers.html' +summary: 'Retrieve all blob containers' +--- + += Retrieve all blob containers + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/containers`# + + + +Retrieves all blob containers. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|resourceGroupName +|string +|query +|False +a| + +|storageAccountName +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|name +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "string", + "name": "string" +} +==== + diff --git a/cvo/get-azure-ha-metadata-default-snapshot-policies.adoc b/cvo/get-azure-ha-metadata-default-snapshot-policies.adoc new file mode 100644 index 00000000..f05d96db --- /dev/null +++ b/cvo/get-azure-ha-metadata-default-snapshot-policies.adoc @@ -0,0 +1,100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-default-snapshot-policies.html' +summary: 'Retrieve the default snapshot policies' +--- + += Retrieve the default snapshot policies + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/default-snapshot-policies`# + + + +Retrieves the default snapshot policies available on a cluster. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "schedules": [ + {} + ], + "description": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc b/cvo/get-azure-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc new file mode 100644 index 00000000..887f2598 --- /dev/null +++ b/cvo/get-azure-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html' +summary: 'Retrieve unsupported instance types for acceleration and capacity tiering' +--- + += Retrieve unsupported instance types for acceleration and capacity tiering + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering`# + + + +Retrieves the instance types that do not support acceleration and capacity tiering. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceTypes +|array[link:#InstanceTypeResponse[InstanceTypeResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceTypes": [ + { + "instanceType": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#InstanceTypeResponse] +[.api-collapsible-fifth-title] +InstanceTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-metadata-keys-vault.adoc b/cvo/get-azure-ha-metadata-keys-vault.adoc new file mode 100644 index 00000000..b2c34fd8 --- /dev/null +++ b/cvo/get-azure-ha-metadata-keys-vault.adoc @@ -0,0 +1,92 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-keys-vault.html' +summary: 'Retrieve all keys in a vault' +--- + += Retrieve all keys in a vault + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/keys-vault`# + + + +Retrieves all keys in a vault. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|resourceGroupName +|string +|query +|False +a| + +|vaultName +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|keyName +|string +|True +a|Key name + + +|kid +|string +|True +a|Key ID + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "keyName": "string", + "kid": "string" +} +==== + diff --git a/cvo/get-azure-ha-metadata-network-requirements.adoc b/cvo/get-azure-ha-metadata-network-requirements.adoc new file mode 100644 index 00000000..c73a165d --- /dev/null +++ b/cvo/get-azure-ha-metadata-network-requirements.adoc @@ -0,0 +1,44 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-network-requirements.html' +summary: 'Retrieve the minimum number of IP addresses' +--- + += Retrieve the minimum number of IP addresses + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/network-requirements`# + + + +Retrieves the minimum number of required IP addresses for a Cloud Volumes ONTAP system. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vsaMinimumRequiredIps +|integer +|True +a| + +|haVsaMinimumRequiredIps +|integer +|False +a| + +|=== + + diff --git a/cvo/get-azure-ha-metadata-packages.adoc b/cvo/get-azure-ha-metadata-packages.adoc new file mode 100644 index 00000000..33dfd8eb --- /dev/null +++ b/cvo/get-azure-ha-metadata-packages.adoc @@ -0,0 +1,187 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-packages.html' +summary: 'Retrieve the packages configuration' +--- + += Retrieve the packages configuration + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/packages`# + + + +Retrieves the packages configuration. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|deploymentModel +|string +|query +|False +a| + +|capacityPackage +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|displayName +|string +|False +a| + +|description +|string +|False +a| + +|licenseType +|string +|False +a| + +|instanceTypeMapping +|array[link:#InstanceTypeRegionMapping[InstanceTypeRegionMapping]] +|True +a| + +|diskType +|string +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|capacityTier +|string +|False +a| + +|instanceTenancy +|string +|False +a| + +|writingSpeedState +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|throughput +|link:#throughput[throughput] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#InstanceTypeRegionMapping] +[.api-collapsible-fifth-title] +InstanceTypeRegionMapping + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|False +a| + +|instanceType +|string +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#throughput] +[.api-collapsible-fifth-title] +throughput + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-metadata-permutations.adoc b/cvo/get-azure-ha-metadata-permutations.adoc new file mode 100644 index 00000000..32421dde --- /dev/null +++ b/cvo/get-azure-ha-metadata-permutations.adoc @@ -0,0 +1,197 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-permutations.html' +summary: 'Retrieve all ONTAP cloud configurations' +--- + += Retrieve all ONTAP cloud configurations + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/permutations`# + + + +Retrieves all ONTAP cloud configurations. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a| + +|license +|link:#OntapLicenseType[OntapLicenseType] +|True +a| + +|instanceType +|string +|False +a| + +|region +|link:#Region[Region] +|True +a| + +|defaultInstance +|boolean +|False +a| + +|features +|array[string] +|True +a| + +|upgradeableFrom +|array[string] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#Region] +[.api-collapsible-fifth-title] +Region + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|code +|string +|False +a| + +|location +|string +|False +a| + +|s3Region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-metadata-regions.adoc b/cvo/get-azure-ha-metadata-regions.adoc new file mode 100644 index 00000000..0dbfe24b --- /dev/null +++ b/cvo/get-azure-ha-metadata-regions.adoc @@ -0,0 +1,379 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-regions.html' +summary: 'Retrieve Azure regions' +--- + += Retrieve Azure regions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/regions`# + + + +Retrieves the Azure regions where a Cloud Volumes ONTAP system can be created. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|displayName +|string +|True +a| + +|name +|string +|False +a| + +|vnets +|link:#AzureNetworkExtendedResponse[AzureNetworkExtendedResponse] +|False +a| + +|supportsZonesAndPssdV2 +|link:#supportsZonesAndPssdV2[supportsZonesAndPssdV2] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "displayName": "string", + "name": "string", + "vnets": { + "virtualNetworks": [ + { + "name": "string", + "id": "string", + "cidrs": [ + { + "cidr": "string", + "subnets": [ + {} + ] + } + ], + "resourceGroup": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ] + } + ], + "securityGroups": [ + { + "id": "string", + "name": "string", + "resourceGroup": "string" + } + ] + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#AzureSubnetResponse] +[.api-collapsible-fifth-title] +AzureSubnetResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Subnet ID + + +|cidr +|string +|False +a|CIDR + + +|name +|string +|True +a|Subnet name + + +|availableIps +|integer +|True +a|The number of available IP addresses on the subnet + + +|minimumRequiredIps +|integer +|True +a|The minimum needed IP addresses for the Cloud Volumes ONTAP system creation + +* format: int32 + + +|=== + + +[#AzureVirtualNetworkCidrData] +[.api-collapsible-fifth-title] +AzureVirtualNetworkCidrData + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cidr +|string +|True +a|CIDR + + +|subnets +|array[link:#AzureSubnetResponse[AzureSubnetResponse]] +|True +a|Subnets + + +|=== + + +[#TagResponse] +[.api-collapsible-fifth-title] +TagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|Tag key + + +|value +|string +|True +a|Tag value + + +|=== + + +[#AzureVirtualNetworkResponse] +[.api-collapsible-fifth-title] +AzureVirtualNetworkResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Virtual Network name + + +|id +|string +|True +a|Virtual Network ID + + +|cidrs +|array[link:#AzureVirtualNetworkCidrData[AzureVirtualNetworkCidrData]] +|True +a|CIDRs + + +|resourceGroup +|string +|True +a|Resource Group + + +|tags +|array[link:#TagResponse[TagResponse]] +|True +a|Tags + + +|=== + + +[#AzureSecurityGroupResponse] +[.api-collapsible-fifth-title] +AzureSecurityGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Security group ID + + +|name +|string +|True +a|Security group name + + +|resourceGroup +|string +|False +a|Resource group + + +|=== + + +[#AzureNetworkExtendedResponse] +[.api-collapsible-fifth-title] +AzureNetworkExtendedResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|virtualNetworks +|array[link:#AzureVirtualNetworkResponse[AzureVirtualNetworkResponse]] +|False +a| + +|securityGroups +|array[link:#AzureSecurityGroupResponse[AzureSecurityGroupResponse]] +|False +a| + +|=== + + +[#supportsZonesAndPssdV2] +[.api-collapsible-fifth-title] +supportsZonesAndPssdV2 + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-metadata-resource-groups.adoc b/cvo/get-azure-ha-metadata-resource-groups.adoc new file mode 100644 index 00000000..94b457a3 --- /dev/null +++ b/cvo/get-azure-ha-metadata-resource-groups.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-resource-groups.html' +summary: 'Retrieve Azure resource groups' +--- + += Retrieve Azure resource groups + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/resource-groups`# + + + +Retrieves Azure resource groups by region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|id +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "id": "string" +} +==== + diff --git a/cvo/get-azure-ha-metadata-storage-account-types.adoc b/cvo/get-azure-ha-metadata-storage-account-types.adoc new file mode 100644 index 00000000..c7b5cced --- /dev/null +++ b/cvo/get-azure-ha-metadata-storage-account-types.adoc @@ -0,0 +1,163 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-storage-account-types.html' +summary: 'Retrieve Azure storage account types' +--- + += Retrieve Azure storage account types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/storage-account-types`# + + + +Retrieves supported Azure storage account types. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|isMultiZone +|boolean +|query +|False +a| + +|isFlashcacheInstance +|boolean +|query +|False +a| + +|isManagedDiskSupported +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|diskType +|string +|True +a| + +|availabilityTypes +|array[string] +|True +a| + +|sizes +|array[link:#AzureDiskSize[AzureDiskSize]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "diskType": "string", + "availabilityTypes": [ + "string" + ], + "sizes": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#AzureDiskSize] +[.api-collapsible-fifth-title] +AzureDiskSize + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|True +a| + +|description +|string +|False +a| + +|supportedOccmLicenses +|array[string] +|False +a| + +|isDefault +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-metadata-supported-capacity-tiers.adoc b/cvo/get-azure-ha-metadata-supported-capacity-tiers.adoc new file mode 100644 index 00000000..9e2ef61a --- /dev/null +++ b/cvo/get-azure-ha-metadata-supported-capacity-tiers.adoc @@ -0,0 +1,168 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-supported-capacity-tiers.html' +summary: 'Retrieve capacity tiers for Azure disk types' +--- + += Retrieve capacity tiers for Azure disk types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/supported-capacity-tiers`# + + + +Retrieves the supported capacity tiers for Azure disk types. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|ontapVersion +|string +|query +|False +a| + +|dataEncryptionType +|string +|query +|False +a| + +|licenseType +|string +|query +|False +a| + +|instanceType +|string +|query +|False +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-metadata-supported-features.adoc b/cvo/get-azure-ha-metadata-supported-features.adoc new file mode 100644 index 00000000..82f7d856 --- /dev/null +++ b/cvo/get-azure-ha-metadata-supported-features.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-supported-features.html' +summary: 'Retrieve supported features' +--- + += Retrieve supported features + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/supported-features`# + + + +Retrieves the supported features. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|ontapVersion +|string +|query +|False +a| + +|dataEncryptionType +|string +|query +|False +a| + +|licenseType +|string +|query +|False +a| + +|instanceType +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|wormSupportedVersion +|boolean +|True +a| + +|cbsSupportedVersion +|boolean +|False +a| + +|httpsStorageAccountSupportedVersion +|boolean +|False +a| + +|tieringWithServiceAccount +|boolean +|False +a| + +|s3CmkEncryptionSupportedVersion +|boolean +|False +a| + +|gp3SupportedVersion +|boolean +|False +a| + +|elasticVolumeSupportedAndEnabled +|boolean +|False +a| + +|wormWithComposeSupported +|boolean +|False +a| + +|isAzureFlashcacheSupported +|boolean +|False +a| + +|wormWithBackupSupported +|boolean +|False +a| + +|azureHaManagedDisksSupported +|boolean +|False +a| + +|awsLocalZones +|boolean +|False +a| + +|isAzureZonalSupported +|boolean +|False +a| + +|=== + + diff --git a/cvo/get-azure-ha-metadata-tag-keys.adoc b/cvo/get-azure-ha-metadata-tag-keys.adoc new file mode 100644 index 00000000..48cdc7b5 --- /dev/null +++ b/cvo/get-azure-ha-metadata-tag-keys.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-tag-keys.html' +summary: 'Retrieve tag names' +--- + += Retrieve tag names + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/tag-keys`# + + + +Retrieves all of the tag names. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a| + +|values +|array[string] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "key": "string", + "values": [ + "string" + ] +} +==== + diff --git a/cvo/get-azure-ha-metadata-vaults.adoc b/cvo/get-azure-ha-metadata-vaults.adoc new file mode 100644 index 00000000..780a812a --- /dev/null +++ b/cvo/get-azure-ha-metadata-vaults.adoc @@ -0,0 +1,100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-vaults.html' +summary: 'Retrieve all vaults' +--- + += Retrieve all vaults + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/vaults`# + + + +Retrieves all vaults. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|region +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Vault name + + +|resourceGroup +|string +|True +a|Resource group + + +|location +|string +|True +a|Location + + +|vaultUri +|string +|True +a|Vault URI + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "resourceGroup": "string", + "location": "string", + "vaultUri": "string" +} +==== + diff --git a/cvo/get-azure-ha-metadata-vnets.adoc b/cvo/get-azure-ha-metadata-vnets.adoc new file mode 100644 index 00000000..73e9dd81 --- /dev/null +++ b/cvo/get-azure-ha-metadata-vnets.adoc @@ -0,0 +1,293 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-metadata-vnets.html' +summary: 'Retrieve network extended information' +--- + += Retrieve network extended information + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/metadata/vnets`# + + + +Retrieves network extended information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|virtualNetworks +|array[link:#AzureVirtualNetworkResponse[AzureVirtualNetworkResponse]] +|False +a| + +|securityGroups +|array[link:#AzureSecurityGroupResponse[AzureSecurityGroupResponse]] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "virtualNetworks": [ + { + "name": "string", + "id": "string", + "cidrs": [ + { + "cidr": "string", + "subnets": [ + {} + ] + } + ], + "resourceGroup": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ] + } + ], + "securityGroups": [ + { + "id": "string", + "name": "string", + "resourceGroup": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AzureSubnetResponse] +[.api-collapsible-fifth-title] +AzureSubnetResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Subnet ID + + +|cidr +|string +|False +a|CIDR + + +|name +|string +|True +a|Subnet name + + +|availableIps +|integer +|True +a|The number of available IP addresses on the subnet + + +|minimumRequiredIps +|integer +|True +a|The minimum needed IP addresses for the Cloud Volumes ONTAP system creation + +* format: int32 + + +|=== + + +[#AzureVirtualNetworkCidrData] +[.api-collapsible-fifth-title] +AzureVirtualNetworkCidrData + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cidr +|string +|True +a|CIDR + + +|subnets +|array[link:#AzureSubnetResponse[AzureSubnetResponse]] +|True +a|Subnets + + +|=== + + +[#TagResponse] +[.api-collapsible-fifth-title] +TagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|Tag key + + +|value +|string +|True +a|Tag value + + +|=== + + +[#AzureVirtualNetworkResponse] +[.api-collapsible-fifth-title] +AzureVirtualNetworkResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Virtual Network name + + +|id +|string +|True +a|Virtual Network ID + + +|cidrs +|array[link:#AzureVirtualNetworkCidrData[AzureVirtualNetworkCidrData]] +|True +a|CIDRs + + +|resourceGroup +|string +|True +a|Resource Group + + +|tags +|array[link:#TagResponse[TagResponse]] +|True +a|Tags + + +|=== + + +[#AzureSecurityGroupResponse] +[.api-collapsible-fifth-title] +AzureSecurityGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Security group ID + + +|name +|string +|True +a|Security group name + + +|resourceGroup +|string +|False +a|Resource group + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-volumes--snapshots.adoc b/cvo/get-azure-ha-volumes--snapshots.adoc new file mode 100644 index 00000000..4b1fe978 --- /dev/null +++ b/cvo/get-azure-ha-volumes--snapshots.adoc @@ -0,0 +1,79 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-volumes--snapshots.html' +summary: 'Retrieve a list of volume snapshot descriptions' +--- + += Retrieve a list of volume snapshot descriptions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots`# + + + +Returns a list of snapshot descriptions for the volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|accessTime +|integer +|True +a| + +|label +|string +|False +a| + +|=== + + diff --git a/cvo/get-azure-ha-volumes-igroups-.adoc b/cvo/get-azure-ha-volumes-igroups-.adoc new file mode 100644 index 00000000..7b5fcbcf --- /dev/null +++ b/cvo/get-azure-ha-volumes-igroups-.adoc @@ -0,0 +1,219 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-volumes-igroups-.html' +summary: 'Retrieve all igroups' +--- + += Retrieve all igroups + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/volumes/igroups/{workingEnvironmentId}/{svmName}`# + + + +Retrieves all igroups. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|igroupName +|string +|True +a| + +|osType +|string +|False +a| + +|portsetName +|string +|False +a| + +|igroupType +|string +|True +a| + +|initiators +|array[string] +|True +a| + +|lunMaps +|array[link:#LunMapsLun[LunMapsLun]] +|True +a| + +|initiatorsWithConnStatus +|array[link:#InitiatorsConnectivityStateNameObject[InitiatorsConnectivityStateNameObject]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "igroupName": "string", + "osType": "string", + "portsetName": "string", + "igroupType": "string", + "initiators": [ + "string" + ], + "lunMaps": [ + { + "lun": { + "name": "string", + "uuid": "string" + } + } + ], + "initiatorsWithConnStatus": [ + { + "connectivity_tracking": { + "connection_state": "string" + }, + "name": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#NameUuidObject] +[.api-collapsible-fifth-title] +NameUuidObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|uuid +|string +|False +a| + +|=== + + +[#LunMapsLun] +[.api-collapsible-fifth-title] +LunMapsLun + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lun +|link:#NameUuidObject[NameUuidObject] +|True +a| + +|=== + + +[#ConnectionState] +[.api-collapsible-fifth-title] +ConnectionState + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connection_state +|string +|False +a| + +|=== + + +[#InitiatorsConnectivityStateNameObject] +[.api-collapsible-fifth-title] +InitiatorsConnectivityStateNameObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connectivity_tracking +|link:#ConnectionState[ConnectionState] +|True +a| + +|name +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-volumes-initiator.adoc b/cvo/get-azure-ha-volumes-initiator.adoc new file mode 100644 index 00000000..c630a8e9 --- /dev/null +++ b/cvo/get-azure-ha-volumes-initiator.adoc @@ -0,0 +1,56 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-volumes-initiator.html' +summary: 'Retrieve all iSCSI initiators' +--- + += Retrieve all iSCSI initiators + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/volumes/initiator`# + + + +Retrieves all iSCSI initiators. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + diff --git a/cvo/get-azure-ha-volumes-volumes-for-backup.adoc b/cvo/get-azure-ha-volumes-volumes-for-backup.adoc new file mode 100644 index 00000000..5bf2c0ef --- /dev/null +++ b/cvo/get-azure-ha-volumes-volumes-for-backup.adoc @@ -0,0 +1,288 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-volumes-volumes-for-backup.html' +summary: 'Retrieve volumes for backup activation' +--- + += Retrieve volumes for backup activation + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/volumes/volumes-for-backup`# + + + +Retrieves all volumes for backup activation. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|offset +|integer +|query +|False +a| + +|limit +|integer +|query +|False +a| + +|search +|string +|query +|False +a| + +|filterBy +|link:#ListFilterByParam[ListFilterByParam] +|query +|False +a| + +|sortBy +|link:#ListSortByParam[ListSortByParam] +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumes +|array[link:#VolumeForBackupResponse[VolumeForBackupResponse]] +|True +a| + +|totalNumberOfVolumes +|integer +|True +a| + +|filteredNumberOfVolumes +|link:#filteredNumberOfVolumes[filteredNumberOfVolumes] +|False +a| + +|hasNextPage +|link:#hasNextPage[hasNextPage] +|False +a| + +|allowedValuesForVolumesListFilter +|link:#AllowedValuesForVolumesListFilter[AllowedValuesForVolumesListFilter] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ListFilterByParam] +[.api-collapsible-fifth-title] +ListFilterByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#ListSortByParam] +[.api-collapsible-fifth-title] +ListSortByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeForBackupResponse] +[.api-collapsible-fifth-title] +VolumeForBackupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|uuid +|string +|False +a| + +|svmName +|string +|False +a| + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|False +a| + +|state +|string +|False +a| + +|providerVolumeType +|string +|False +a| + +|volumeType +|string +|False +a| + +|isBackupOn +|boolean +|True +a| + +|disableReasonBackup +|array[string] +|True +a| + +|=== + + +[#filteredNumberOfVolumes] +[.api-collapsible-fifth-title] +filteredNumberOfVolumes + + +[#hasNextPage] +[.api-collapsible-fifth-title] +hasNextPage + + +[#AllowedValuesForVolumesListFilter] +[.api-collapsible-fifth-title] +AllowedValuesForVolumesListFilter + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeTypes +|array[string] +|False +a| + +|diskTypes +|array[string] +|False +a| + +|svmNames +|array[string] +|False +a| + +|volumeStatus +|array[string] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-volumes.adoc b/cvo/get-azure-ha-volumes.adoc new file mode 100644 index 00000000..e9d84947 --- /dev/null +++ b/cvo/get-azure-ha-volumes.adoc @@ -0,0 +1,550 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-volumes.html' +summary: 'Retrieve volumes' +--- + += Retrieve volumes + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/volumes`# + + + +Retrieves all volumes. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Volume name + + +|uuid +|string +|True +a|Volume UUID + + +|svmName +|string +|True +a|Volume SVM name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|junctionPath +|string +|True +a|The junction path at which this volume is mounted + + +|volumeTotalInodes +|integer +|False +a|Total volume inodes size + + +|volumeUsedInodes +|integer +|False +a|Used volume inodes size + + +|mountPoint +|string +|False +a|Mount Point + + +|compressionSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|deduplicationSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioning +|boolean +|True +a|Specifies whether thin provisioning is enabled + + +|compression +|boolean +|True +a|Specifies whether compression is enabled + + +|deduplication +|boolean +|True +a|Specifies whether deduplication is enabled + + +|snapshotPolicy +|string +|True +a|The name of the snapshot policy + + +|securityStyle +|string +|True +a|The type of the security style + + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|True +a| + +|shareNames +|array[string] +|True +a|The share names for CIFS + + +|shareInfo +|array[link:#CifsShareInfo[CifsShareInfo]] +|True +a|The share names, permissions, and users for CIFS + + +|parentVolumeName +|string +|True +a|Name of the parent flexible volume for the clone + + +|rootVolume +|boolean +|True +a|Flag to indicate if the volume is a SVM root + + +|state +|string +|True +a|Volume state + + +|volumeType +|string +|True +a|Volume type + + +|aggregateName +|string +|True +a|Aggregate name + + +|parentSnapshot +|string +|False +a|The snapshot name the volume is based on + + +|autoSizeMode +|string +|True +a|The operating mode of autosize + + +|maxGrowSize +|link:#Capacity[Capacity] +|True +a| + +|providerVolumeType +|string +|False +a|Cloud provider volume type + + +|cloneNames +|array[string] +|True +a|Names of cloned copies of the volume + + +|moving +|boolean +|True +a|Specifies if the volume move process is in progress + + +|primaryNoFailoverMountPoint +|string +|False +a|Primary mount point without failover + + +|secondaryNoFailoverMountPoint +|string +|False +a|Secondary mount point without failover + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cifsShareAccessPoint +|string +|False +a|CIFS share access point + + +|primaryCifsShareAccessPoint +|string +|False +a|Primary CIFS share access point + + +|secondaryCifsShareAccessPoint +|string +|False +a|Secondary CIFS share access point + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|tierInactiveUserData +|link:#Capacity[Capacity] +|False +a| + +|tierInactiveUserDataPercent +|integer +|False +a|Tier inactive user data percentage + + +|comment +|string +|False +a|Volume comment + + +|qosPolicyGroupName +|string +|False +a|Quality of service policy group name + + +|snaplockType +|string +|False +a|SnapLock type + + +|constituentsAggregates +|array[string] +|True +a|Aggregates which are used for FlexGroup constituents + + +|snapshotsUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cbsBackupsInfo +|link:#VolumeCbsInfo[VolumeCbsInfo] +|False +a| + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|targetName +|string +|True +a|iSCSI target IQN + + +|iscsiEnabled +|boolean +|True +a|Indicates if the volume is used by the iSCSI protocol + + +|isFlexGroupVolume +|boolean +|True +a|Indicates if the volume is a FlexGroup volume + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#VolumeCbsInfo] +[.api-collapsible-fifth-title] +VolumeCbsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalBackups +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-working-environments-.adoc b/cvo/get-azure-ha-working-environments-.adoc new file mode 100644 index 00000000..d0fd39a6 --- /dev/null +++ b/cvo/get-azure-ha-working-environments-.adoc @@ -0,0 +1,3125 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-.html' +summary: 'Retrieve a system' +--- + += Retrieve a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}`# + + + +Retrieves a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#AzureProperties[AzureProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|False +a| + +|haProperties +|link:#AzureHaProperties[AzureHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "name": "string", + "tenantId": "string", + "svmName": "string", + "creatorUserEmail": "string", + "status": { + "status": "string", + "message": "string", + "extendedFailureReason": "string" + }, + "providerProperties": { + "regionName": "string", + "vnetCidr": "string", + "subscriptionId": "string", + "deploymentId": "string", + "instanceType": "string", + "subscriptionName": "string", + "cloudProviderAccountId": "string", + "dataDisks": [ + { + "name": "string", + "id": "string", + "caching": "string", + "accountType": "string", + "encryptionSet": "string" + } + ] + }, + "clusterProperties": { + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "clusterName": "string", + "ontapVersion": "string", + "accountId": "string", + "productCode": "string", + "amiId": "string", + "systemManagerUrl": "string", + "instanceId": "string", + "platformLicense": "string", + "instanceType": "string", + "publicIp": "string", + "publicDnsName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string" + }, + "ontapClusterProperties": { + "nodes": [ + { + "name": "string", + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "platformLicense": "string", + "platformSerialNumber": "string", + "cloudProviderId": "string" + } + ], + "clusterName": "string", + "clusterUuid": "string", + "ontapVersion": "string", + "systemManagerUrl": "string", + "licensePackageName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string", + "broadcastDomainInfos": [ + {} + ], + "capacityTierInfo": { + "s3BucketName": "string", + "tierLevel": "string" + }, + "userName": "string", + "vscanFileOperationDefaultProfile": "string" + }, + "cloudProviderName": "string", + "snapshotPolicies": [ + { + "name": "string", + "schedules": [ + {} + ], + "description": "string" + } + ], + "actionsRequired": [ + {} + ], + "activeActions": [ + "string" + ], + "replicationProperties": { + "peers": [ + "string" + ], + "replicationTargets": [ + "string" + ] + }, + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ], + "svms": [ + {} + ], + "workingEnvironmentType": "string", + "supportRegistrationProperties": { + "supportRegistrationStatus": "string" + }, + "supportRegistrationInformation": [ + { + "supportRegistrationStatus": "string", + "serialNumber": "string", + "nssAccountId": "string" + } + ], + "capacityFeatures": { + "providerVolumesType": [ + { + "supportedVolumeTypes": [ + "string" + ], + "maxDisksAllow": { + "reason": "string" + } + } + ], + "defaultProviderVolumeType": { + "diskType": "string", + "capacityTier": "string" + }, + "supportedCapacityTiers": { + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] + }, + "existingIops": [ + "object" + ] + }, + "encryptionProperties": { + "keyManagers": [ + { + "publicId": "string", + "name": "string", + "address": "string", + "usernameField": "string", + "usernameValue": "string", + "status": "string" + } + ], + "encryptionCertificates": [ + {} + ], + "awsEncryptionKey": { + "alias": "string", + "keyId": "string", + "status": "string", + "origin": "string" + } + }, + "haProperties": { + "loadBalancerName": "string", + "applicationSecurityGroupName": "string", + "azureHaDeploymentType": "string" + }, + "fpolicyProperties": { + "fileExtensions": [ + "string" + ] + }, + "saasProperties": { + "subscription": { + "id": "string", + "name": "string" + }, + "capacityLicensePackage": "string" + }, + "cbsProperties": { + "cbsBackupStatus": "string", + "cbsRules": [ + { + "snapmirrorLabel": "string" + } + ], + "objectStoreName": "string", + "providerSpecific": { + "azureRgName": "string", + "gcpProjectId": "string", + "gcpRegion": "string" + }, + "cbsPolicyName": "string", + "ipSpace": "string", + "region": "string", + "providerAccountName": "string", + "exclusionReason": "string" + }, + "complianceProperties": { + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" + }, + "monitoringProperties": { + "monitoringStatus": "string", + "monitoringInfo": { + "averageLatency": { + "unit": "string" + }, + "storageAverageThroughput": { + "unit": "string" + }, + "node1AverageThroughput": { + "unit": "string" + }, + "node2AverageThroughput": { + "unit": "string" + } + }, + "tenantUrl": "string" + }, + "licensesInformation": [ + { + "type": "string", + "useType": "string", + "package": "string", + "serialNumbers": [ + "string" + ], + "expirations": [ + "object" + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#AzureResourceGroupResponse] +[.api-collapsible-fifth-title] +AzureResourceGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|location +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|=== + + +[#availabilityZone] +[.api-collapsible-fifth-title] +availabilityZone + + +[#AzureDataDiskResponse] +[.api-collapsible-fifth-title] +AzureDataDiskResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|diskSizeGB +|integer +|False +a| + +|lun +|integer +|False +a| + +|id +|string +|False +a| + +|caching +|string +|False +a| + +|accountType +|string +|False +a| + +|managed +|boolean +|False +a| + +|encryptionSet +|string +|False +a| + +|=== + + +[#AzureProperties] +[.api-collapsible-fifth-title] +AzureProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|resourceGroup +|link:#AzureResourceGroupResponse[AzureResourceGroupResponse] +|False +a| + +|vnetCidr +|string +|False +a| + +|tags +|link:#tags[tags] +|False +a| + +|subscriptionId +|string +|False +a| + +|deploymentId +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceType +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|singleNetworkInterface +|boolean +|False +a| + +|subscriptionName +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|dataDisks +|array[link:#AzureDataDiskResponse[AzureDataDiskResponse]] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#AzureAvailabilitySet] +[.api-collapsible-fifth-title] +AzureAvailabilitySet + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|faultDomain +|integer +|False +a| + +|updateDomain +|integer +|False +a| + +|=== + + +[#AzureHaNodeInfo] +[.api-collapsible-fifth-title] +AzureHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceId +|string +|False +a| + +|primaryIp +|string +|False +a| + +|state +|string +|False +a| + +|serialNumber +|string +|False +a| + +|availabilitySet +|link:#AzureAvailabilitySet[AzureAvailabilitySet] +|True +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|=== + + +[#AzureHaProperties] +[.api-collapsible-fifth-title] +AzureHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|loadBalancerName +|string +|False +a| + +|haEnabledOnLbRules +|boolean +|False +a| + +|node1Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|node2Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|multiZone +|boolean +|False +a| + +|applicationSecurityGroupName +|string +|False +a| + +|azureHaDeploymentType +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-working-environments-available-ips-in-subnet.adoc b/cvo/get-azure-ha-working-environments-available-ips-in-subnet.adoc new file mode 100644 index 00000000..611e7800 --- /dev/null +++ b/cvo/get-azure-ha-working-environments-available-ips-in-subnet.adoc @@ -0,0 +1,57 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-available-ips-in-subnet.html' +summary: 'Retrieve available IP addresses in the subnet of a system' +--- + += Retrieve available IP addresses in the subnet of a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/available-ips-in-subnet`# + + + +Retrieves the number of available IP addresses in the Cloud Volumes ONTAP system's subnet. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|availableIps +|integer +|True +a| + +|=== + + diff --git a/cvo/get-azure-ha-working-environments-avs-private-clouds.adoc b/cvo/get-azure-ha-working-environments-avs-private-clouds.adoc new file mode 100644 index 00000000..46e2ffb5 --- /dev/null +++ b/cvo/get-azure-ha-working-environments-avs-private-clouds.adoc @@ -0,0 +1,202 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-avs-private-clouds.html' +summary: 'Retrieve an Azure VMware Solution private cloud for a subscription' +--- + += Retrieve an Azure VMware Solution private cloud for a subscription + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/avs-private-clouds`# + + + +Retrieves an Azure VMware Solution private cloud for the existing subscription. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|name +|string +|False +a| + +|location +|string +|False +a| + +|zones +|array[string] +|True +a| + +|tags +|link:#tags[tags] +|True +a| + +|properties +|link:#AvsPrivateCloudProperties[AvsPrivateCloudProperties] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#AvsPrivateCloudEndpoints] +[.api-collapsible-fifth-title] +AvsPrivateCloudEndpoints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vcenterIp +|string +|False +a| + +|=== + + +[#AvsPrivateCloudManagCluster] +[.api-collapsible-fifth-title] +AvsPrivateCloudManagCluster + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clusterId +|string +|False +a| + +|displayName +|string +|False +a| + +|clusterSize +|string +|False +a| + +|provisioningState +|string +|False +a| + +|vsanDatastoreName +|string +|False +a| + +|=== + + +[#AvsPrivateCloudProperties] +[.api-collapsible-fifth-title] +AvsPrivateCloudProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provisioningState +|string +|False +a| + +|endpoints +|link:#AvsPrivateCloudEndpoints[AvsPrivateCloudEndpoints] +|True +a| + +|managementCluster +|link:#AvsPrivateCloudManagCluster[AvsPrivateCloudManagCluster] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-working-environments-cifs-locks-exist.adoc b/cvo/get-azure-ha-working-environments-cifs-locks-exist.adoc new file mode 100644 index 00000000..10b4d7cf --- /dev/null +++ b/cvo/get-azure-ha-working-environments-cifs-locks-exist.adoc @@ -0,0 +1,43 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-cifs-locks-exist.html' +summary: 'Check for non-persistent locks' +--- + += Check for non-persistent locks + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist`# + + + +Checks for non-persistent locks held on CIFS sessions. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + + diff --git a/cvo/get-azure-ha-working-environments-cifs.adoc b/cvo/get-azure-ha-working-environments-cifs.adoc new file mode 100644 index 00000000..16b91a6f --- /dev/null +++ b/cvo/get-azure-ha-working-environments-cifs.adoc @@ -0,0 +1,110 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-cifs.html' +summary: 'Retrieve the CIFS configuration for a system' +--- + += Retrieve the CIFS configuration for a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/cifs`# + + + +Retrieves the CIFS configuration for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svm +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|True +a|DNS domain name + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|authenticationType +|string +|True +a|Authentication type + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "activeDirectoryDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "authenticationType": "string" +} +==== + diff --git a/cvo/get-azure-ha-working-environments-cost-and-usage.adoc b/cvo/get-azure-ha-working-environments-cost-and-usage.adoc new file mode 100644 index 00000000..0380aa7b --- /dev/null +++ b/cvo/get-azure-ha-working-environments-cost-and-usage.adoc @@ -0,0 +1,241 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-cost-and-usage.html' +summary: 'Retrieve the system cost and usage' +--- + += Retrieve the system cost and usage + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/cost-and-usage`# + + + +Retrieves the system cost and usage. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|start +|string +|query +|False +a| + +|end +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hasPermissions +|boolean +|True +a|Permissions to view the cost and usage details + + +|costByTime +|array[link:#CostByTime[CostByTime]] +|True +a|System cost and usage details + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Money] +[.api-collapsible-fifth-title] +Money + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|True +a|Amount + + +|currency +|string +|True +a|Currency + + +|=== + + +[#Usage] +[.api-collapsible-fifth-title] +Usage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|False +a|Amount + + +|units +|string +|True +a|Units + + +|=== + + +[#CostByUsage] +[.api-collapsible-fifth-title] +CostByUsage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Breakdown element name + + +|cost +|link:#Money[Money] +|True +a| + +|usage +|link:#Usage[Usage] +|True +a| + +|=== + + +[#CostByService] +[.api-collapsible-fifth-title] +CostByService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the cost domain (compute, disk/blob storage, object storage, data transfer) + + +|total +|link:#Money[Money] +|True +a| + +|costByUsage +|array[link:#CostByUsage[CostByUsage]] +|True +a|Cost domain breakdown + + +|=== + + +[#CostByTime] +[.api-collapsible-fifth-title] +CostByTime + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|start +|string +|True +a|Cost period start date + + +|end +|string +|True +a|Cost period end date + + +|estimated +|boolean +|True +a|Indicates whether the cost is estimated + + +|total +|link:#Money[Money] +|True +a| + +|costByService +|array[link:#CostByService[CostByService]] +|True +a|Monthly cost and usage details + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-working-environments-create-request-parameters.adoc b/cvo/get-azure-ha-working-environments-create-request-parameters.adoc new file mode 100644 index 00000000..3cde3ecb --- /dev/null +++ b/cvo/get-azure-ha-working-environments-create-request-parameters.adoc @@ -0,0 +1,95 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-create-request-parameters.html' +summary: 'Retrieve action parameters' +--- + += Retrieve action parameters + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/create-request-parameters`# + + + +Retrieves the action parameters used in the create request for a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|parameters +|link:#MapStringObject[MapStringObject] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject + + +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject +Hash mapping strings to link:#MapStringObject[MapStringObject] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|True +a| + +|empty +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-working-environments-extra-capacity-licenses.adoc b/cvo/get-azure-ha-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..ac38dc2a --- /dev/null +++ b/cvo/get-azure-ha-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-extra-capacity-licenses.html' +summary: 'Retrieve extra capacity licenses' +--- + += Retrieve extra capacity licenses + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Retrieves extra capacity licenses for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serialNumber +|string +|True +a| + +|resourceId +|string +|False +a| + +|licenseType +|string +|False +a| + +|expirationDate +|integer +|True +a| + +|license +|string +|False +a| + +|capacity +|number +|True +a| + +|metadata +|string +|False +a| + +|associatedResourceId +|string +|False +a| + +|licensePackage +|string +|False +a| + +|accountId +|string +|False +a| + +|=== + + diff --git a/cvo/get-azure-ha-working-environments-license-instance-type.adoc b/cvo/get-azure-ha-working-environments-license-instance-type.adoc new file mode 100644 index 00000000..1760d26a --- /dev/null +++ b/cvo/get-azure-ha-working-environments-license-instance-type.adoc @@ -0,0 +1,146 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-license-instance-type.html' +summary: 'Retrieve all license types and their associated instance types' +--- + += Retrieve all license types and their associated instance types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/license-instance-type`# + + + +Retrieves all license types and their associated instance types for a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenseType +|string +|True +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|instanceTypes +|array[link:#InstanceTypeInfo[InstanceTypeInfo]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#InstanceTypeInfo] +[.api-collapsible-fifth-title] +InstanceTypeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|False +a| + +|supportsEncryption +|boolean +|True +a| + +|supportedFeatures +|array[string] +|True +a| + +|isDefault +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-working-environments-occm-provided-upgrade-versions.adoc b/cvo/get-azure-ha-working-environments-occm-provided-upgrade-versions.adoc new file mode 100644 index 00000000..f6de34fe --- /dev/null +++ b/cvo/get-azure-ha-working-environments-occm-provided-upgrade-versions.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-occm-provided-upgrade-versions.html' +summary: 'Retrieve a list of upgrade versions' +--- + += Retrieve a list of upgrade versions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions`# + + + +Retrieves a list of versions to which this Cloud Volumes ONTAP system can be upgraded. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-azure-ha-working-environments-ontap-available-images.adoc b/cvo/get-azure-ha-working-environments-ontap-available-images.adoc new file mode 100644 index 00000000..74f8e0a1 --- /dev/null +++ b/cvo/get-azure-ha-working-environments-ontap-available-images.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-ontap-available-images.html' +summary: 'Retrieve images already installed on a system' +--- + += Retrieve images already installed on a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/ontap-available-images`# + + + +Retrieves images already installed on the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|version +|string +|False +a| + +|isCurrent +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-azure-ha-working-environments-ontap-saving.adoc b/cvo/get-azure-ha-working-environments-ontap-saving.adoc new file mode 100644 index 00000000..44ae4393 --- /dev/null +++ b/cvo/get-azure-ha-working-environments-ontap-saving.adoc @@ -0,0 +1,129 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-ontap-saving.html' +summary: 'Retrieve system ONTAP savings' +--- + += Retrieve system ONTAP savings + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/ontap-saving`# + + + +Retrieves system ONTAP savings. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|savings +|array[link:#SavingsInfo[SavingsInfo]] +|True +a|List of savings + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "savings": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Money] +[.api-collapsible-fifth-title] +Money + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|True +a|Amount + + +|currency +|string +|True +a|Currency + + +|=== + + +[#SavingsInfo] +[.api-collapsible-fifth-title] +SavingsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of saving element + + +|monthlySaving +|link:#Money[Money] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-working-environments-resource-group-exists-.adoc b/cvo/get-azure-ha-working-environments-resource-group-exists-.adoc new file mode 100644 index 00000000..82b416eb --- /dev/null +++ b/cvo/get-azure-ha-working-environments-resource-group-exists-.adoc @@ -0,0 +1,55 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-resource-group-exists-.html' +summary: 'Check if a resource group with the specified name exists' +--- + += Check if a resource group with the specified name exists + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/resource-group-exists/{resourceGroupName}`# + + + +Checks if a resource group with the specified name already exists. Returns true if a resource group with that name already exists, false otherwise. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resourceGroupName +|string +|path +|True +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + + diff --git a/cvo/get-azure-ha-working-environments-resourcegroups-avs-private-clouds-clusters-hosts.adoc b/cvo/get-azure-ha-working-environments-resourcegroups-avs-private-clouds-clusters-hosts.adoc new file mode 100644 index 00000000..b2bb8499 --- /dev/null +++ b/cvo/get-azure-ha-working-environments-resourcegroups-avs-private-clouds-clusters-hosts.adoc @@ -0,0 +1,90 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-resourcegroups-avs-private-clouds-clusters-hosts.html' +summary: 'Retrieve Azure VMware Solution cluster hosts for a subscription' +--- + += Retrieve Azure VMware Solution cluster hosts for a subscription + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters/{clusterName}/hosts`# + + + +Retrieves Azure VMware Solution cluster hosts for the existing subscription. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|resourceGroupName +|string +|path +|True +a| + +|privateCloudName +|string +|path +|True +a| + +|clusterName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|name +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "string", + "name": "string" +} +==== + diff --git a/cvo/get-azure-ha-working-environments-resourcegroups-avs-private-clouds-clusters.adoc b/cvo/get-azure-ha-working-environments-resourcegroups-avs-private-clouds-clusters.adoc new file mode 100644 index 00000000..91aee5d9 --- /dev/null +++ b/cvo/get-azure-ha-working-environments-resourcegroups-avs-private-clouds-clusters.adoc @@ -0,0 +1,156 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-resourcegroups-avs-private-clouds-clusters.html' +summary: 'Retrieve Azure VMware Solution private cloud clusters for a subscription' +--- + += Retrieve Azure VMware Solution private cloud clusters for a subscription + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters`# + + + +Retrieves Azure VMware Solution private cloud clusters for the existing subscription. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|resourceGroupName +|string +|path +|True +a| + +|privateCloudName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|name +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|properties +|link:#AvsPrivateCloudClusterProperties[AvsPrivateCloudClusterProperties] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|True +a| + +|empty +|boolean +|False +a| + +|=== + + +[#AvsPrivateCloudClusterProperties] +[.api-collapsible-fifth-title] +AvsPrivateCloudClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clusterId +|string +|False +a| + +|clusterSize +|string +|False +a| + +|provisioningState +|string +|False +a| + +|vsanDatastoreName +|string +|False +a| + +|hosts +|array[string] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-working-environments-schedules.adoc b/cvo/get-azure-ha-working-environments-schedules.adoc new file mode 100644 index 00000000..b03b81b2 --- /dev/null +++ b/cvo/get-azure-ha-working-environments-schedules.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-schedules.html' +summary: 'List the start/stop schedules for Cloud Volumes ONTAP' +--- + += List the start/stop schedules for Cloud Volumes ONTAP + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/schedules`# + + + +Lists the start/stop schedules for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "schedule": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-working-environments-support-registration.adoc b/cvo/get-azure-ha-working-environments-support-registration.adoc new file mode 100644 index 00000000..29092efa --- /dev/null +++ b/cvo/get-azure-ha-working-environments-support-registration.adoc @@ -0,0 +1,101 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-support-registration.html' +summary: 'Retrieve the support registration status' +--- + += Retrieve the support registration status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/support-registration`# + + + +Retrieves the support registration status of a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|licenseStartDate +|link:#licenseStartDate[licenseStartDate] +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "nssAccountId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#licenseStartDate] +[.api-collapsible-fifth-title] +licenseStartDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-working-environments-update-eligibility.adoc b/cvo/get-azure-ha-working-environments-update-eligibility.adoc new file mode 100644 index 00000000..d14dc2b3 --- /dev/null +++ b/cvo/get-azure-ha-working-environments-update-eligibility.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-update-eligibility.html' +summary: 'Retrieve the eligibility support status of a system' +--- + += Retrieve the eligibility support status of a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/update-eligibility`# + + + +Retrieves the eligibility support status of a Cloud Volumes ONTAP system. Valid values are NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|eligibilityResponse +|string +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "eligibilityResponse": "string" +} +==== + diff --git a/cvo/get-azure-ha-working-environments-user-tags.adoc b/cvo/get-azure-ha-working-environments-user-tags.adoc new file mode 100644 index 00000000..bd39fa33 --- /dev/null +++ b/cvo/get-azure-ha-working-environments-user-tags.adoc @@ -0,0 +1,104 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-user-tags.html' +summary: 'Retrieve editable tags for the cloud resources' +--- + += Retrieve editable tags for the cloud resources + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/user-tags`# + + + +Retrieves the editable tags for the cloud resources in a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tags +|array[link:#CloudResourceTag[CloudResourceTag]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tags": [ + { + "tagKey": "string", + "tagValue": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudResourceTag] +[.api-collapsible-fifth-title] +CloudResourceTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|True +a| + +|tagValue +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-working-environments-validate-byol-to-capacity.adoc b/cvo/get-azure-ha-working-environments-validate-byol-to-capacity.adoc new file mode 100644 index 00000000..99894b50 --- /dev/null +++ b/cvo/get-azure-ha-working-environments-validate-byol-to-capacity.adoc @@ -0,0 +1,214 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments-validate-byol-to-capacity.html' +summary: 'Validate prerequisites for converting a system' +--- + += Validate prerequisites for converting a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity`# + + + +Validates the prerequisites for converting an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|validAccount +|boolean +|True +a| + +|validNss +|boolean +|False +a| + +|mpSub +|array[link:#CloudAccountResponse[CloudAccountResponse]] +|True +a| + +|capacityLicenses +|array[link:#CapacityLicenseInfo[CapacityLicenseInfo]] +|True +a| + +|totalPrimaryVolumes +|link:#Capacity[Capacity] +|True +a| + +|totalDpVolumes +|link:#Capacity[Capacity] +|False +a| + +|vmPlan +|string +|False +a| + +|awsOldDeployment +|boolean +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudAccountResponse] +[.api-collapsible-fifth-title] +CloudAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudAccountId +|string +|True +a| + +|provider +|string +|False +a| + +|subscriptionId +|string +|False +a| + +|=== + + +[#TotalCapacity] +[.api-collapsible-fifth-title] +TotalCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacity +|integer +|True +a| + +|units +|string +|False +a| + +|=== + + +[#CapacityLicenseInfo] +[.api-collapsible-fifth-title] +CapacityLicenseInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|flavorType +|string +|False +a| + +|contractType +|string +|False +a| + +|totalLicensedCapacity +|link:#TotalCapacity[TotalCapacity] +|True +a| + +|totalConsumedCapacity +|link:#TotalCapacity[TotalCapacity] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-ha-working-environments.adoc b/cvo/get-azure-ha-working-environments.adoc new file mode 100644 index 00000000..b4e609ae --- /dev/null +++ b/cvo/get-azure-ha-working-environments.adoc @@ -0,0 +1,3125 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-ha-working-environments.html' +summary: 'Retrieve HA systems' +--- + += Retrieve HA systems + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/ha/working-environments`# + + + +Retrieves Cloud Volumes ONTAP systems visible to the current user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|tenantId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#AzureProperties[AzureProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|False +a| + +|haProperties +|link:#AzureHaProperties[AzureHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "name": "string", + "tenantId": "string", + "svmName": "string", + "creatorUserEmail": "string", + "status": { + "status": "string", + "message": "string", + "extendedFailureReason": "string" + }, + "providerProperties": { + "regionName": "string", + "vnetCidr": "string", + "subscriptionId": "string", + "deploymentId": "string", + "instanceType": "string", + "subscriptionName": "string", + "cloudProviderAccountId": "string", + "dataDisks": [ + { + "name": "string", + "id": "string", + "caching": "string", + "accountType": "string", + "encryptionSet": "string" + } + ] + }, + "clusterProperties": { + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "clusterName": "string", + "ontapVersion": "string", + "accountId": "string", + "productCode": "string", + "amiId": "string", + "systemManagerUrl": "string", + "instanceId": "string", + "platformLicense": "string", + "instanceType": "string", + "publicIp": "string", + "publicDnsName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string" + }, + "ontapClusterProperties": { + "nodes": [ + { + "name": "string", + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "platformLicense": "string", + "platformSerialNumber": "string", + "cloudProviderId": "string" + } + ], + "clusterName": "string", + "clusterUuid": "string", + "ontapVersion": "string", + "systemManagerUrl": "string", + "licensePackageName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string", + "broadcastDomainInfos": [ + {} + ], + "capacityTierInfo": { + "s3BucketName": "string", + "tierLevel": "string" + }, + "userName": "string", + "vscanFileOperationDefaultProfile": "string" + }, + "cloudProviderName": "string", + "snapshotPolicies": [ + { + "name": "string", + "schedules": [ + {} + ], + "description": "string" + } + ], + "actionsRequired": [ + {} + ], + "activeActions": [ + "string" + ], + "replicationProperties": { + "peers": [ + "string" + ], + "replicationTargets": [ + "string" + ] + }, + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ], + "svms": [ + {} + ], + "workingEnvironmentType": "string", + "supportRegistrationProperties": { + "supportRegistrationStatus": "string" + }, + "supportRegistrationInformation": [ + { + "supportRegistrationStatus": "string", + "serialNumber": "string", + "nssAccountId": "string" + } + ], + "capacityFeatures": { + "providerVolumesType": [ + { + "supportedVolumeTypes": [ + "string" + ], + "maxDisksAllow": { + "reason": "string" + } + } + ], + "defaultProviderVolumeType": { + "diskType": "string", + "capacityTier": "string" + }, + "supportedCapacityTiers": { + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] + }, + "existingIops": [ + "object" + ] + }, + "encryptionProperties": { + "keyManagers": [ + { + "publicId": "string", + "name": "string", + "address": "string", + "usernameField": "string", + "usernameValue": "string", + "status": "string" + } + ], + "encryptionCertificates": [ + {} + ], + "awsEncryptionKey": { + "alias": "string", + "keyId": "string", + "status": "string", + "origin": "string" + } + }, + "haProperties": { + "loadBalancerName": "string", + "applicationSecurityGroupName": "string", + "azureHaDeploymentType": "string" + }, + "fpolicyProperties": { + "fileExtensions": [ + "string" + ] + }, + "saasProperties": { + "subscription": { + "id": "string", + "name": "string" + }, + "capacityLicensePackage": "string" + }, + "cbsProperties": { + "cbsBackupStatus": "string", + "cbsRules": [ + { + "snapmirrorLabel": "string" + } + ], + "objectStoreName": "string", + "providerSpecific": { + "azureRgName": "string", + "gcpProjectId": "string", + "gcpRegion": "string" + }, + "cbsPolicyName": "string", + "ipSpace": "string", + "region": "string", + "providerAccountName": "string", + "exclusionReason": "string" + }, + "complianceProperties": { + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" + }, + "monitoringProperties": { + "monitoringStatus": "string", + "monitoringInfo": { + "averageLatency": { + "unit": "string" + }, + "storageAverageThroughput": { + "unit": "string" + }, + "node1AverageThroughput": { + "unit": "string" + }, + "node2AverageThroughput": { + "unit": "string" + } + }, + "tenantUrl": "string" + }, + "licensesInformation": [ + { + "type": "string", + "useType": "string", + "package": "string", + "serialNumbers": [ + "string" + ], + "expirations": [ + "object" + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#AzureResourceGroupResponse] +[.api-collapsible-fifth-title] +AzureResourceGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|location +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|=== + + +[#availabilityZone] +[.api-collapsible-fifth-title] +availabilityZone + + +[#AzureDataDiskResponse] +[.api-collapsible-fifth-title] +AzureDataDiskResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|diskSizeGB +|integer +|False +a| + +|lun +|integer +|False +a| + +|id +|string +|False +a| + +|caching +|string +|False +a| + +|accountType +|string +|False +a| + +|managed +|boolean +|False +a| + +|encryptionSet +|string +|False +a| + +|=== + + +[#AzureProperties] +[.api-collapsible-fifth-title] +AzureProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|resourceGroup +|link:#AzureResourceGroupResponse[AzureResourceGroupResponse] +|False +a| + +|vnetCidr +|string +|False +a| + +|tags +|link:#tags[tags] +|False +a| + +|subscriptionId +|string +|False +a| + +|deploymentId +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceType +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|singleNetworkInterface +|boolean +|False +a| + +|subscriptionName +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|dataDisks +|array[link:#AzureDataDiskResponse[AzureDataDiskResponse]] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#AzureAvailabilitySet] +[.api-collapsible-fifth-title] +AzureAvailabilitySet + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|faultDomain +|integer +|False +a| + +|updateDomain +|integer +|False +a| + +|=== + + +[#AzureHaNodeInfo] +[.api-collapsible-fifth-title] +AzureHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceId +|string +|False +a| + +|primaryIp +|string +|False +a| + +|state +|string +|False +a| + +|serialNumber +|string +|False +a| + +|availabilitySet +|link:#AzureAvailabilitySet[AzureAvailabilitySet] +|True +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|=== + + +[#AzureHaProperties] +[.api-collapsible-fifth-title] +AzureHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|loadBalancerName +|string +|False +a| + +|haEnabledOnLbRules +|boolean +|False +a| + +|node1Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|node2Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|multiZone +|boolean +|False +a| + +|applicationSecurityGroupName +|string +|False +a| + +|azureHaDeploymentType +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-aggregates-.adoc b/cvo/get-azure-vsa-aggregates-.adoc new file mode 100644 index 00000000..85eb823b --- /dev/null +++ b/cvo/get-azure-vsa-aggregates-.adoc @@ -0,0 +1,404 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-aggregates-.html' +summary: 'Retrieve aggregates' +--- + += Retrieve aggregates + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/aggregates/{workingEnvironmentId}`# + + + +Retrieves aggregates. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Aggregate name + + +|availableCapacity +|link:#Capacity[Capacity] +|True +a| + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|usedCapacity +|link:#Capacity[Capacity] +|True +a| + +|volumes +|array[link:#Volume[Volume]] +|True +a|Volumes + + +|providerVolumes +|array[link:#ProviderVolumeResponse[ProviderVolumeResponse]] +|True +a|Provider volumes + + +|disks +|array[link:#Disk[Disk]] +|True +a|Disks + + +|state +|string +|False +a|State + + +|encryptionType +|string +|True +a|Encryption Type + + +|encryptionKeyId +|string +|False +a|Encryption Key + + +|isRoot +|boolean +|True +a|Is Root + + +|homeNode +|string +|True +a|Home node + + +|ownerNode +|string +|False +a|Owner node + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsed +|link:#Capacity[Capacity] +|False +a| + +|sidlEnabled +|boolean +|True +a|SIDL enabled + + +|snaplockType +|string +|True +a|Snaplock type + + +|evCompatibilityType +|string +|True +a|Elastic Volume Compatibility Type + + +|iops +|link:#iops[iops] +|False +a|Aggregate IOPS + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Volume] +[.api-collapsible-fifth-title] +Volume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|totalSize +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioned +|boolean +|True +a|Indicates if the volume is thin-provisioned + + +|isClone +|boolean +|True +a|Indicates if the volume is a clone volume + + +|rootVolume +|boolean +|True +a|Indicates if the volume is the root volume of the SVM + + +|=== + + +[#ProviderVolumeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Specifies the ID + + +|name +|string +|True +a|Specifies the name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|state +|string +|True +a|State + + +|device +|string +|True +a|Device + + +|instanceId +|string +|True +a|InstanceId + + +|diskType +|string +|True +a|Type + + +|encrypted +|boolean +|True +a|Encrypted + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|instance2Id +|string +|False +a|Instance2Id + + +|=== + + +[#VmDiskProperties] +[.api-collapsible-fifth-title] +VmDiskProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectName +|string +|False +a| + +|storageAccountName +|string +|False +a| + +|containerName +|string +|False +a| + +|=== + + +[#Disk] +[.api-collapsible-fifth-title] +Disk + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Name + + +|containerType +|string +|True +a|Container type + + +|ownerNode +|string +|True +a|Owner node + + +|device +|string +|False +a|Device + + +|vmDiskProperties +|link:#VmDiskProperties[VmDiskProperties] +|False +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + +Aggregate IOPS + + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-discover.adoc b/cvo/get-azure-vsa-discover.adoc new file mode 100644 index 00000000..637f0ce5 --- /dev/null +++ b/cvo/get-azure-vsa-discover.adoc @@ -0,0 +1,129 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-discover.html' +summary: 'Retrieve a list of discovered systems' +--- + += Retrieve a list of discovered systems + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/discover`# + + + +Retrieves a list of discovered systems visible to the current user in the specified Azure region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|id +|string +|False +a| + +|publicId +|string +|False +a| + +|region +|string +|False +a| + +|vnetName +|string +|False +a| + +|vnetId +|string +|False +a| + +|subnetId +|string +|False +a| + +|subnetName +|string +|False +a| + +|resourceGroup +|string +|False +a| + +|clusterAddress +|string +|False +a| + +|recoverable +|boolean +|True +a| + +|byol +|boolean +|False +a| + +|registered +|boolean +|False +a| + +|=== + + diff --git a/cvo/get-azure-vsa-metadata-associated-subscriptions.adoc b/cvo/get-azure-vsa-metadata-associated-subscriptions.adoc new file mode 100644 index 00000000..4e8d0dc6 --- /dev/null +++ b/cvo/get-azure-vsa-metadata-associated-subscriptions.adoc @@ -0,0 +1,101 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-associated-subscriptions.html' +summary: 'Retrieve associated subscriptions' +--- + += Retrieve associated subscriptions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/associated-subscriptions`# + + + +Retrieves associated subscriptions. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|True +a| + +|name +|string +|False +a| + +|default +|boolean +|True +a| + +|saasSubscriptionId +|string +|False +a| + +|highAvailabilityEnabled +|link:#highAvailabilityEnabled[highAvailabilityEnabled] +|False +a| + +|vMOrchestratorZonalMultiFDEnabled +|link:#vMOrchestratorZonalMultiFDEnabled[vMOrchestratorZonalMultiFDEnabled] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#highAvailabilityEnabled] +[.api-collapsible-fifth-title] +highAvailabilityEnabled + + +[#vMOrchestratorZonalMultiFDEnabled] +[.api-collapsible-fifth-title] +vMOrchestratorZonalMultiFDEnabled + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-metadata-availability-zones.adoc b/cvo/get-azure-vsa-metadata-availability-zones.adoc new file mode 100644 index 00000000..87fa2b2c --- /dev/null +++ b/cvo/get-azure-vsa-metadata-availability-zones.adoc @@ -0,0 +1,105 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-availability-zones.html' +summary: 'Retrieve Azure availability zones by region' +--- + += Retrieve Azure availability zones by region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/availability-zones`# + + + +Retrieves Azure availability zones by region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|True +a|region value + + +|zones +|array[link:#zones[zones]] +|True +a|Zone values + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": "string", + "zones": [ + "object" + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#zones] +[.api-collapsible-fifth-title] +zones + +Zone values + + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-metadata-containers.adoc b/cvo/get-azure-vsa-metadata-containers.adoc new file mode 100644 index 00000000..3f402441 --- /dev/null +++ b/cvo/get-azure-vsa-metadata-containers.adoc @@ -0,0 +1,90 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-containers.html' +summary: 'Retrieve all blob containers' +--- + += Retrieve all blob containers + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/containers`# + + + +Retrieves all blob containers. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|resourceGroupName +|string +|query +|False +a| + +|storageAccountName +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|name +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "string", + "name": "string" +} +==== + diff --git a/cvo/get-azure-vsa-metadata-default-snapshot-policies.adoc b/cvo/get-azure-vsa-metadata-default-snapshot-policies.adoc new file mode 100644 index 00000000..661b25f7 --- /dev/null +++ b/cvo/get-azure-vsa-metadata-default-snapshot-policies.adoc @@ -0,0 +1,100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-default-snapshot-policies.html' +summary: 'Retrieve the default snapshot policies' +--- + += Retrieve the default snapshot policies + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/default-snapshot-policies`# + + + +Retrieves the default snapshot policies available on a cluster. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "schedules": [ + {} + ], + "description": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc b/cvo/get-azure-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc new file mode 100644 index 00000000..38b51df8 --- /dev/null +++ b/cvo/get-azure-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html' +summary: 'Retrieve unsupported instance types for acceleration and capacity tiering' +--- + += Retrieve unsupported instance types for acceleration and capacity tiering + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering`# + + + +Retrieves the instance types that do not support acceleration and capacity tiering. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceTypes +|array[link:#InstanceTypeResponse[InstanceTypeResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceTypes": [ + { + "instanceType": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#InstanceTypeResponse] +[.api-collapsible-fifth-title] +InstanceTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-metadata-keys-vault.adoc b/cvo/get-azure-vsa-metadata-keys-vault.adoc new file mode 100644 index 00000000..d4ff1119 --- /dev/null +++ b/cvo/get-azure-vsa-metadata-keys-vault.adoc @@ -0,0 +1,92 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-keys-vault.html' +summary: 'Retrieve all keys in a vault' +--- + += Retrieve all keys in a vault + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/keys-vault`# + + + +Retrieves all keys in a vault. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|resourceGroupName +|string +|query +|False +a| + +|vaultName +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|keyName +|string +|True +a|Key name + + +|kid +|string +|True +a|Key ID + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "keyName": "string", + "kid": "string" +} +==== + diff --git a/cvo/get-azure-vsa-metadata-network-requirements.adoc b/cvo/get-azure-vsa-metadata-network-requirements.adoc new file mode 100644 index 00000000..25e006ae --- /dev/null +++ b/cvo/get-azure-vsa-metadata-network-requirements.adoc @@ -0,0 +1,44 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-network-requirements.html' +summary: 'Retrieve the minimum number of required IP addresses' +--- + += Retrieve the minimum number of required IP addresses + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/network-requirements`# + + + +Retrieves the minimum number of required IP addresses for a Cloud Volumes ONTAP system. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vsaMinimumRequiredIps +|integer +|True +a| + +|haVsaMinimumRequiredIps +|integer +|False +a| + +|=== + + diff --git a/cvo/get-azure-vsa-metadata-packages.adoc b/cvo/get-azure-vsa-metadata-packages.adoc new file mode 100644 index 00000000..b719cccc --- /dev/null +++ b/cvo/get-azure-vsa-metadata-packages.adoc @@ -0,0 +1,187 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-packages.html' +summary: 'Retrieve package configurations' +--- + += Retrieve package configurations + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/packages`# + + + +Retrieves the packages configuration. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|deploymentModel +|string +|query +|False +a| + +|capacityPackage +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|displayName +|string +|False +a| + +|description +|string +|False +a| + +|licenseType +|string +|False +a| + +|instanceTypeMapping +|array[link:#InstanceTypeRegionMapping[InstanceTypeRegionMapping]] +|True +a| + +|diskType +|string +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|capacityTier +|string +|False +a| + +|instanceTenancy +|string +|False +a| + +|writingSpeedState +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|throughput +|link:#throughput[throughput] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#InstanceTypeRegionMapping] +[.api-collapsible-fifth-title] +InstanceTypeRegionMapping + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|False +a| + +|instanceType +|string +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#throughput] +[.api-collapsible-fifth-title] +throughput + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-metadata-permutations.adoc b/cvo/get-azure-vsa-metadata-permutations.adoc new file mode 100644 index 00000000..f57256a0 --- /dev/null +++ b/cvo/get-azure-vsa-metadata-permutations.adoc @@ -0,0 +1,197 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-permutations.html' +summary: 'Retrieve all Cloud Volumes ONTAP configurations' +--- + += Retrieve all Cloud Volumes ONTAP configurations + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/permutations`# + + + +Retrieves all Cloud Volumes ONTAP configurations. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a| + +|license +|link:#OntapLicenseType[OntapLicenseType] +|True +a| + +|instanceType +|string +|False +a| + +|region +|link:#Region[Region] +|True +a| + +|defaultInstance +|boolean +|False +a| + +|features +|array[string] +|True +a| + +|upgradeableFrom +|array[string] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#Region] +[.api-collapsible-fifth-title] +Region + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|code +|string +|False +a| + +|location +|string +|False +a| + +|s3Region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-metadata-regions.adoc b/cvo/get-azure-vsa-metadata-regions.adoc new file mode 100644 index 00000000..6bf5de19 --- /dev/null +++ b/cvo/get-azure-vsa-metadata-regions.adoc @@ -0,0 +1,379 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-regions.html' +summary: 'Retrieve Azure regions' +--- + += Retrieve Azure regions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/regions`# + + + +Retrieves the Azure regions where a Cloud Volumes ONTAP system can be created. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|displayName +|string +|True +a| + +|name +|string +|False +a| + +|vnets +|link:#AzureNetworkExtendedResponse[AzureNetworkExtendedResponse] +|False +a| + +|supportsZonesAndPssdV2 +|link:#supportsZonesAndPssdV2[supportsZonesAndPssdV2] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "displayName": "string", + "name": "string", + "vnets": { + "virtualNetworks": [ + { + "name": "string", + "id": "string", + "cidrs": [ + { + "cidr": "string", + "subnets": [ + {} + ] + } + ], + "resourceGroup": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ] + } + ], + "securityGroups": [ + { + "id": "string", + "name": "string", + "resourceGroup": "string" + } + ] + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#AzureSubnetResponse] +[.api-collapsible-fifth-title] +AzureSubnetResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Subnet ID + + +|cidr +|string +|False +a|CIDR + + +|name +|string +|True +a|Subnet name + + +|availableIps +|integer +|True +a|The number of available IP addresses on the subnet + + +|minimumRequiredIps +|integer +|True +a|The minimum needed IP addresses for the Cloud Volumes ONTAP system creation + +* format: int32 + + +|=== + + +[#AzureVirtualNetworkCidrData] +[.api-collapsible-fifth-title] +AzureVirtualNetworkCidrData + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cidr +|string +|True +a|CIDR + + +|subnets +|array[link:#AzureSubnetResponse[AzureSubnetResponse]] +|True +a|Subnets + + +|=== + + +[#TagResponse] +[.api-collapsible-fifth-title] +TagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|Tag key + + +|value +|string +|True +a|Tag value + + +|=== + + +[#AzureVirtualNetworkResponse] +[.api-collapsible-fifth-title] +AzureVirtualNetworkResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Virtual Network name + + +|id +|string +|True +a|Virtual Network ID + + +|cidrs +|array[link:#AzureVirtualNetworkCidrData[AzureVirtualNetworkCidrData]] +|True +a|CIDRs + + +|resourceGroup +|string +|True +a|Resource Group + + +|tags +|array[link:#TagResponse[TagResponse]] +|True +a|Tags + + +|=== + + +[#AzureSecurityGroupResponse] +[.api-collapsible-fifth-title] +AzureSecurityGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Security group ID + + +|name +|string +|True +a|Security group name + + +|resourceGroup +|string +|False +a|Resource group + + +|=== + + +[#AzureNetworkExtendedResponse] +[.api-collapsible-fifth-title] +AzureNetworkExtendedResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|virtualNetworks +|array[link:#AzureVirtualNetworkResponse[AzureVirtualNetworkResponse]] +|False +a| + +|securityGroups +|array[link:#AzureSecurityGroupResponse[AzureSecurityGroupResponse]] +|False +a| + +|=== + + +[#supportsZonesAndPssdV2] +[.api-collapsible-fifth-title] +supportsZonesAndPssdV2 + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-metadata-resource-groups.adoc b/cvo/get-azure-vsa-metadata-resource-groups.adoc new file mode 100644 index 00000000..cc81b698 --- /dev/null +++ b/cvo/get-azure-vsa-metadata-resource-groups.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-resource-groups.html' +summary: 'Retrieve Azure resource groups by region' +--- + += Retrieve Azure resource groups by region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/resource-groups`# + + + +Retrieves Azure resource groups by region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|id +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "id": "string" +} +==== + diff --git a/cvo/get-azure-vsa-metadata-storage-account-types.adoc b/cvo/get-azure-vsa-metadata-storage-account-types.adoc new file mode 100644 index 00000000..7c9797df --- /dev/null +++ b/cvo/get-azure-vsa-metadata-storage-account-types.adoc @@ -0,0 +1,163 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-storage-account-types.html' +summary: 'Retrieve supported Azure storage account types' +--- + += Retrieve supported Azure storage account types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/storage-account-types`# + + + +Retrieves supported Azure storage account types. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|isMultiZone +|boolean +|query +|False +a| + +|isFlashcacheInstance +|boolean +|query +|False +a| + +|isManagedDiskSupported +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|diskType +|string +|True +a| + +|availabilityTypes +|array[string] +|True +a| + +|sizes +|array[link:#AzureDiskSize[AzureDiskSize]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "diskType": "string", + "availabilityTypes": [ + "string" + ], + "sizes": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#AzureDiskSize] +[.api-collapsible-fifth-title] +AzureDiskSize + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|True +a| + +|description +|string +|False +a| + +|supportedOccmLicenses +|array[string] +|False +a| + +|isDefault +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-metadata-supported-capacity-tiers.adoc b/cvo/get-azure-vsa-metadata-supported-capacity-tiers.adoc new file mode 100644 index 00000000..bb837bee --- /dev/null +++ b/cvo/get-azure-vsa-metadata-supported-capacity-tiers.adoc @@ -0,0 +1,168 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-supported-capacity-tiers.html' +summary: 'Retrieve supported capacity tiers for Azure disk types' +--- + += Retrieve supported capacity tiers for Azure disk types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/supported-capacity-tiers`# + + + +Retrieves the supported capacity tiers for Azure disk types. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|ontapVersion +|string +|query +|False +a| + +|dataEncryptionType +|string +|query +|False +a| + +|licenseType +|string +|query +|False +a| + +|instanceType +|string +|query +|False +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-metadata-supported-features.adoc b/cvo/get-azure-vsa-metadata-supported-features.adoc new file mode 100644 index 00000000..2c163cdf --- /dev/null +++ b/cvo/get-azure-vsa-metadata-supported-features.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-supported-features.html' +summary: 'Retrieve supported features' +--- + += Retrieve supported features + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/supported-features`# + + + +Retrieves the supported features. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|ontapVersion +|string +|query +|False +a| + +|dataEncryptionType +|string +|query +|False +a| + +|licenseType +|string +|query +|False +a| + +|instanceType +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|wormSupportedVersion +|boolean +|True +a| + +|cbsSupportedVersion +|boolean +|False +a| + +|httpsStorageAccountSupportedVersion +|boolean +|False +a| + +|tieringWithServiceAccount +|boolean +|False +a| + +|s3CmkEncryptionSupportedVersion +|boolean +|False +a| + +|gp3SupportedVersion +|boolean +|False +a| + +|elasticVolumeSupportedAndEnabled +|boolean +|False +a| + +|wormWithComposeSupported +|boolean +|False +a| + +|isAzureFlashcacheSupported +|boolean +|False +a| + +|wormWithBackupSupported +|boolean +|False +a| + +|azureHaManagedDisksSupported +|boolean +|False +a| + +|awsLocalZones +|boolean +|False +a| + +|isAzureZonalSupported +|boolean +|False +a| + +|=== + + diff --git a/cvo/get-azure-vsa-metadata-tag-keys.adoc b/cvo/get-azure-vsa-metadata-tag-keys.adoc new file mode 100644 index 00000000..858be95b --- /dev/null +++ b/cvo/get-azure-vsa-metadata-tag-keys.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-tag-keys.html' +summary: 'Retrieve all tag names' +--- + += Retrieve all tag names + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/tag-keys`# + + + +Retrieves all of the tag names. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a| + +|values +|array[string] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "key": "string", + "values": [ + "string" + ] +} +==== + diff --git a/cvo/get-azure-vsa-metadata-vaults.adoc b/cvo/get-azure-vsa-metadata-vaults.adoc new file mode 100644 index 00000000..91a8f070 --- /dev/null +++ b/cvo/get-azure-vsa-metadata-vaults.adoc @@ -0,0 +1,100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-vaults.html' +summary: 'Retrieve all vaults' +--- + += Retrieve all vaults + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/vaults`# + + + +Retrieves all vaults. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|region +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Vault name + + +|resourceGroup +|string +|True +a|Resource group + + +|location +|string +|True +a|Location + + +|vaultUri +|string +|True +a|Vault URI + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "resourceGroup": "string", + "location": "string", + "vaultUri": "string" +} +==== + diff --git a/cvo/get-azure-vsa-metadata-vnets.adoc b/cvo/get-azure-vsa-metadata-vnets.adoc new file mode 100644 index 00000000..26e4245e --- /dev/null +++ b/cvo/get-azure-vsa-metadata-vnets.adoc @@ -0,0 +1,293 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-metadata-vnets.html' +summary: 'Retrieve network extended information' +--- + += Retrieve network extended information + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/metadata/vnets`# + + + +Retrieves network extended information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|virtualNetworks +|array[link:#AzureVirtualNetworkResponse[AzureVirtualNetworkResponse]] +|False +a| + +|securityGroups +|array[link:#AzureSecurityGroupResponse[AzureSecurityGroupResponse]] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "virtualNetworks": [ + { + "name": "string", + "id": "string", + "cidrs": [ + { + "cidr": "string", + "subnets": [ + {} + ] + } + ], + "resourceGroup": "string", + "tags": [ + { + "key": "string", + "value": "string" + } + ] + } + ], + "securityGroups": [ + { + "id": "string", + "name": "string", + "resourceGroup": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AzureSubnetResponse] +[.api-collapsible-fifth-title] +AzureSubnetResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Subnet ID + + +|cidr +|string +|False +a|CIDR + + +|name +|string +|True +a|Subnet name + + +|availableIps +|integer +|True +a|The number of available IP addresses on the subnet + + +|minimumRequiredIps +|integer +|True +a|The minimum needed IP addresses for the Cloud Volumes ONTAP system creation + +* format: int32 + + +|=== + + +[#AzureVirtualNetworkCidrData] +[.api-collapsible-fifth-title] +AzureVirtualNetworkCidrData + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cidr +|string +|True +a|CIDR + + +|subnets +|array[link:#AzureSubnetResponse[AzureSubnetResponse]] +|True +a|Subnets + + +|=== + + +[#TagResponse] +[.api-collapsible-fifth-title] +TagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|Tag key + + +|value +|string +|True +a|Tag value + + +|=== + + +[#AzureVirtualNetworkResponse] +[.api-collapsible-fifth-title] +AzureVirtualNetworkResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Virtual Network name + + +|id +|string +|True +a|Virtual Network ID + + +|cidrs +|array[link:#AzureVirtualNetworkCidrData[AzureVirtualNetworkCidrData]] +|True +a|CIDRs + + +|resourceGroup +|string +|True +a|Resource Group + + +|tags +|array[link:#TagResponse[TagResponse]] +|True +a|Tags + + +|=== + + +[#AzureSecurityGroupResponse] +[.api-collapsible-fifth-title] +AzureSecurityGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Security group ID + + +|name +|string +|True +a|Security group name + + +|resourceGroup +|string +|False +a|Resource group + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-volumes--snapshots.adoc b/cvo/get-azure-vsa-volumes--snapshots.adoc new file mode 100644 index 00000000..95e1e4af --- /dev/null +++ b/cvo/get-azure-vsa-volumes--snapshots.adoc @@ -0,0 +1,79 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-volumes--snapshots.html' +summary: 'Retrieve a list of volume snapshot descriptions' +--- + += Retrieve a list of volume snapshot descriptions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots`# + + + +Returns a list of snapshot descriptions for the volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|accessTime +|integer +|True +a| + +|label +|string +|False +a| + +|=== + + diff --git a/cvo/get-azure-vsa-volumes-igroups-.adoc b/cvo/get-azure-vsa-volumes-igroups-.adoc new file mode 100644 index 00000000..485d47a3 --- /dev/null +++ b/cvo/get-azure-vsa-volumes-igroups-.adoc @@ -0,0 +1,219 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-volumes-igroups-.html' +summary: 'Retrieve all igroups' +--- + += Retrieve all igroups + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/volumes/igroups/{workingEnvironmentId}/{svmName}`# + + + +Retrieves all igroups. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|igroupName +|string +|True +a| + +|osType +|string +|False +a| + +|portsetName +|string +|False +a| + +|igroupType +|string +|True +a| + +|initiators +|array[string] +|True +a| + +|lunMaps +|array[link:#LunMapsLun[LunMapsLun]] +|True +a| + +|initiatorsWithConnStatus +|array[link:#InitiatorsConnectivityStateNameObject[InitiatorsConnectivityStateNameObject]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "igroupName": "string", + "osType": "string", + "portsetName": "string", + "igroupType": "string", + "initiators": [ + "string" + ], + "lunMaps": [ + { + "lun": { + "name": "string", + "uuid": "string" + } + } + ], + "initiatorsWithConnStatus": [ + { + "connectivity_tracking": { + "connection_state": "string" + }, + "name": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#NameUuidObject] +[.api-collapsible-fifth-title] +NameUuidObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|uuid +|string +|False +a| + +|=== + + +[#LunMapsLun] +[.api-collapsible-fifth-title] +LunMapsLun + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lun +|link:#NameUuidObject[NameUuidObject] +|True +a| + +|=== + + +[#ConnectionState] +[.api-collapsible-fifth-title] +ConnectionState + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connection_state +|string +|False +a| + +|=== + + +[#InitiatorsConnectivityStateNameObject] +[.api-collapsible-fifth-title] +InitiatorsConnectivityStateNameObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connectivity_tracking +|link:#ConnectionState[ConnectionState] +|True +a| + +|name +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-volumes-initiator.adoc b/cvo/get-azure-vsa-volumes-initiator.adoc new file mode 100644 index 00000000..2d6314fc --- /dev/null +++ b/cvo/get-azure-vsa-volumes-initiator.adoc @@ -0,0 +1,56 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-volumes-initiator.html' +summary: 'Retrieve all iSCSI initiators' +--- + += Retrieve all iSCSI initiators + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/volumes/initiator`# + + + +Retrieves all iSCSI initiators. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + diff --git a/cvo/get-azure-vsa-volumes-volumes-for-backup.adoc b/cvo/get-azure-vsa-volumes-volumes-for-backup.adoc new file mode 100644 index 00000000..03951028 --- /dev/null +++ b/cvo/get-azure-vsa-volumes-volumes-for-backup.adoc @@ -0,0 +1,288 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-volumes-volumes-for-backup.html' +summary: 'Retrieve volumes for backup activation' +--- + += Retrieve volumes for backup activation + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/volumes/volumes-for-backup`# + + + +Retrieves all volumes for backup activation. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|offset +|integer +|query +|False +a| + +|limit +|integer +|query +|False +a| + +|search +|string +|query +|False +a| + +|filterBy +|link:#ListFilterByParam[ListFilterByParam] +|query +|False +a| + +|sortBy +|link:#ListSortByParam[ListSortByParam] +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumes +|array[link:#VolumeForBackupResponse[VolumeForBackupResponse]] +|True +a| + +|totalNumberOfVolumes +|integer +|True +a| + +|filteredNumberOfVolumes +|link:#filteredNumberOfVolumes[filteredNumberOfVolumes] +|False +a| + +|hasNextPage +|link:#hasNextPage[hasNextPage] +|False +a| + +|allowedValuesForVolumesListFilter +|link:#AllowedValuesForVolumesListFilter[AllowedValuesForVolumesListFilter] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ListFilterByParam] +[.api-collapsible-fifth-title] +ListFilterByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#ListSortByParam] +[.api-collapsible-fifth-title] +ListSortByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeForBackupResponse] +[.api-collapsible-fifth-title] +VolumeForBackupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|uuid +|string +|False +a| + +|svmName +|string +|False +a| + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|False +a| + +|state +|string +|False +a| + +|providerVolumeType +|string +|False +a| + +|volumeType +|string +|False +a| + +|isBackupOn +|boolean +|True +a| + +|disableReasonBackup +|array[string] +|True +a| + +|=== + + +[#filteredNumberOfVolumes] +[.api-collapsible-fifth-title] +filteredNumberOfVolumes + + +[#hasNextPage] +[.api-collapsible-fifth-title] +hasNextPage + + +[#AllowedValuesForVolumesListFilter] +[.api-collapsible-fifth-title] +AllowedValuesForVolumesListFilter + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeTypes +|array[string] +|False +a| + +|diskTypes +|array[string] +|False +a| + +|svmNames +|array[string] +|False +a| + +|volumeStatus +|array[string] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-volumes.adoc b/cvo/get-azure-vsa-volumes.adoc new file mode 100644 index 00000000..0316e874 --- /dev/null +++ b/cvo/get-azure-vsa-volumes.adoc @@ -0,0 +1,550 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-volumes.html' +summary: 'Retrieve all volumes' +--- + += Retrieve all volumes + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/volumes`# + + + +Retrieves all volumes. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Volume name + + +|uuid +|string +|True +a|Volume UUID + + +|svmName +|string +|True +a|Volume SVM name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|junctionPath +|string +|True +a|The junction path at which this volume is mounted + + +|volumeTotalInodes +|integer +|False +a|Total volume inodes size + + +|volumeUsedInodes +|integer +|False +a|Used volume inodes size + + +|mountPoint +|string +|False +a|Mount Point + + +|compressionSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|deduplicationSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioning +|boolean +|True +a|Specifies whether thin provisioning is enabled + + +|compression +|boolean +|True +a|Specifies whether compression is enabled + + +|deduplication +|boolean +|True +a|Specifies whether deduplication is enabled + + +|snapshotPolicy +|string +|True +a|The name of the snapshot policy + + +|securityStyle +|string +|True +a|The type of the security style + + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|True +a| + +|shareNames +|array[string] +|True +a|The share names for CIFS + + +|shareInfo +|array[link:#CifsShareInfo[CifsShareInfo]] +|True +a|The share names, permissions, and users for CIFS + + +|parentVolumeName +|string +|True +a|Name of the parent flexible volume for the clone + + +|rootVolume +|boolean +|True +a|Flag to indicate if the volume is a SVM root + + +|state +|string +|True +a|Volume state + + +|volumeType +|string +|True +a|Volume type + + +|aggregateName +|string +|True +a|Aggregate name + + +|parentSnapshot +|string +|False +a|The snapshot name the volume is based on + + +|autoSizeMode +|string +|True +a|The operating mode of autosize + + +|maxGrowSize +|link:#Capacity[Capacity] +|True +a| + +|providerVolumeType +|string +|False +a|Cloud provider volume type + + +|cloneNames +|array[string] +|True +a|Names of cloned copies of the volume + + +|moving +|boolean +|True +a|Specifies if the volume move process is in progress + + +|primaryNoFailoverMountPoint +|string +|False +a|Primary mount point without failover + + +|secondaryNoFailoverMountPoint +|string +|False +a|Secondary mount point without failover + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cifsShareAccessPoint +|string +|False +a|CIFS share access point + + +|primaryCifsShareAccessPoint +|string +|False +a|Primary CIFS share access point + + +|secondaryCifsShareAccessPoint +|string +|False +a|Secondary CIFS share access point + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|tierInactiveUserData +|link:#Capacity[Capacity] +|False +a| + +|tierInactiveUserDataPercent +|integer +|False +a|Tier inactive user data percentage + + +|comment +|string +|False +a|Volume comment + + +|qosPolicyGroupName +|string +|False +a|Quality of service policy group name + + +|snaplockType +|string +|False +a|SnapLock type + + +|constituentsAggregates +|array[string] +|True +a|Aggregates which are used for FlexGroup constituents + + +|snapshotsUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cbsBackupsInfo +|link:#VolumeCbsInfo[VolumeCbsInfo] +|False +a| + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|targetName +|string +|True +a|iSCSI target IQN + + +|iscsiEnabled +|boolean +|True +a|Indicates if the volume is used by the iSCSI protocol + + +|isFlexGroupVolume +|boolean +|True +a|Indicates if the volume is a FlexGroup volume + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#VolumeCbsInfo] +[.api-collapsible-fifth-title] +VolumeCbsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalBackups +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-working-environments-.adoc b/cvo/get-azure-vsa-working-environments-.adoc new file mode 100644 index 00000000..5d4a8a02 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-.adoc @@ -0,0 +1,3125 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-.html' +summary: 'Retrieve a Cloud Volumes ONTAP system' +--- + += Retrieve a Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}`# + + + +Retrieves a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#AzureProperties[AzureProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|False +a| + +|haProperties +|link:#AzureHaProperties[AzureHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "name": "string", + "tenantId": "string", + "svmName": "string", + "creatorUserEmail": "string", + "status": { + "status": "string", + "message": "string", + "extendedFailureReason": "string" + }, + "providerProperties": { + "regionName": "string", + "vnetCidr": "string", + "subscriptionId": "string", + "deploymentId": "string", + "instanceType": "string", + "subscriptionName": "string", + "cloudProviderAccountId": "string", + "dataDisks": [ + { + "name": "string", + "id": "string", + "caching": "string", + "accountType": "string", + "encryptionSet": "string" + } + ] + }, + "clusterProperties": { + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "clusterName": "string", + "ontapVersion": "string", + "accountId": "string", + "productCode": "string", + "amiId": "string", + "systemManagerUrl": "string", + "instanceId": "string", + "platformLicense": "string", + "instanceType": "string", + "publicIp": "string", + "publicDnsName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string" + }, + "ontapClusterProperties": { + "nodes": [ + { + "name": "string", + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "platformLicense": "string", + "platformSerialNumber": "string", + "cloudProviderId": "string" + } + ], + "clusterName": "string", + "clusterUuid": "string", + "ontapVersion": "string", + "systemManagerUrl": "string", + "licensePackageName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string", + "broadcastDomainInfos": [ + {} + ], + "capacityTierInfo": { + "s3BucketName": "string", + "tierLevel": "string" + }, + "userName": "string", + "vscanFileOperationDefaultProfile": "string" + }, + "cloudProviderName": "string", + "snapshotPolicies": [ + { + "name": "string", + "schedules": [ + {} + ], + "description": "string" + } + ], + "actionsRequired": [ + {} + ], + "activeActions": [ + "string" + ], + "replicationProperties": { + "peers": [ + "string" + ], + "replicationTargets": [ + "string" + ] + }, + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ], + "svms": [ + {} + ], + "workingEnvironmentType": "string", + "supportRegistrationProperties": { + "supportRegistrationStatus": "string" + }, + "supportRegistrationInformation": [ + { + "supportRegistrationStatus": "string", + "serialNumber": "string", + "nssAccountId": "string" + } + ], + "capacityFeatures": { + "providerVolumesType": [ + { + "supportedVolumeTypes": [ + "string" + ], + "maxDisksAllow": { + "reason": "string" + } + } + ], + "defaultProviderVolumeType": { + "diskType": "string", + "capacityTier": "string" + }, + "supportedCapacityTiers": { + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] + }, + "existingIops": [ + "object" + ] + }, + "encryptionProperties": { + "keyManagers": [ + { + "publicId": "string", + "name": "string", + "address": "string", + "usernameField": "string", + "usernameValue": "string", + "status": "string" + } + ], + "encryptionCertificates": [ + {} + ], + "awsEncryptionKey": { + "alias": "string", + "keyId": "string", + "status": "string", + "origin": "string" + } + }, + "haProperties": { + "loadBalancerName": "string", + "applicationSecurityGroupName": "string", + "azureHaDeploymentType": "string" + }, + "fpolicyProperties": { + "fileExtensions": [ + "string" + ] + }, + "saasProperties": { + "subscription": { + "id": "string", + "name": "string" + }, + "capacityLicensePackage": "string" + }, + "cbsProperties": { + "cbsBackupStatus": "string", + "cbsRules": [ + { + "snapmirrorLabel": "string" + } + ], + "objectStoreName": "string", + "providerSpecific": { + "azureRgName": "string", + "gcpProjectId": "string", + "gcpRegion": "string" + }, + "cbsPolicyName": "string", + "ipSpace": "string", + "region": "string", + "providerAccountName": "string", + "exclusionReason": "string" + }, + "complianceProperties": { + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" + }, + "monitoringProperties": { + "monitoringStatus": "string", + "monitoringInfo": { + "averageLatency": { + "unit": "string" + }, + "storageAverageThroughput": { + "unit": "string" + }, + "node1AverageThroughput": { + "unit": "string" + }, + "node2AverageThroughput": { + "unit": "string" + } + }, + "tenantUrl": "string" + }, + "licensesInformation": [ + { + "type": "string", + "useType": "string", + "package": "string", + "serialNumbers": [ + "string" + ], + "expirations": [ + "object" + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#AzureResourceGroupResponse] +[.api-collapsible-fifth-title] +AzureResourceGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|location +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|=== + + +[#availabilityZone] +[.api-collapsible-fifth-title] +availabilityZone + + +[#AzureDataDiskResponse] +[.api-collapsible-fifth-title] +AzureDataDiskResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|diskSizeGB +|integer +|False +a| + +|lun +|integer +|False +a| + +|id +|string +|False +a| + +|caching +|string +|False +a| + +|accountType +|string +|False +a| + +|managed +|boolean +|False +a| + +|encryptionSet +|string +|False +a| + +|=== + + +[#AzureProperties] +[.api-collapsible-fifth-title] +AzureProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|resourceGroup +|link:#AzureResourceGroupResponse[AzureResourceGroupResponse] +|False +a| + +|vnetCidr +|string +|False +a| + +|tags +|link:#tags[tags] +|False +a| + +|subscriptionId +|string +|False +a| + +|deploymentId +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceType +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|singleNetworkInterface +|boolean +|False +a| + +|subscriptionName +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|dataDisks +|array[link:#AzureDataDiskResponse[AzureDataDiskResponse]] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#AzureAvailabilitySet] +[.api-collapsible-fifth-title] +AzureAvailabilitySet + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|faultDomain +|integer +|False +a| + +|updateDomain +|integer +|False +a| + +|=== + + +[#AzureHaNodeInfo] +[.api-collapsible-fifth-title] +AzureHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceId +|string +|False +a| + +|primaryIp +|string +|False +a| + +|state +|string +|False +a| + +|serialNumber +|string +|False +a| + +|availabilitySet +|link:#AzureAvailabilitySet[AzureAvailabilitySet] +|True +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|=== + + +[#AzureHaProperties] +[.api-collapsible-fifth-title] +AzureHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|loadBalancerName +|string +|False +a| + +|haEnabledOnLbRules +|boolean +|False +a| + +|node1Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|node2Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|multiZone +|boolean +|False +a| + +|applicationSecurityGroupName +|string +|False +a| + +|azureHaDeploymentType +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-working-environments-available-ips-in-subnet.adoc b/cvo/get-azure-vsa-working-environments-available-ips-in-subnet.adoc new file mode 100644 index 00000000..97fe3078 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-available-ips-in-subnet.adoc @@ -0,0 +1,57 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-available-ips-in-subnet.html' +summary: 'Retrieve the number of available IP addresses' +--- + += Retrieve the number of available IP addresses + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/available-ips-in-subnet`# + + + +Retrieves the number of available IP addresses in the Cloud Volumes ONTAP system's subnet. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|availableIps +|integer +|True +a| + +|=== + + diff --git a/cvo/get-azure-vsa-working-environments-avs-private-clouds.adoc b/cvo/get-azure-vsa-working-environments-avs-private-clouds.adoc new file mode 100644 index 00000000..ddfe2268 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-avs-private-clouds.adoc @@ -0,0 +1,202 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-avs-private-clouds.html' +summary: 'Retrieve an Azure VMware Solution private cloud' +--- + += Retrieve an Azure VMware Solution private cloud + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/avs-private-clouds`# + + + +Retrieves an Azure VMware Solution private cloud for the existing subscription. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|name +|string +|False +a| + +|location +|string +|False +a| + +|zones +|array[string] +|True +a| + +|tags +|link:#tags[tags] +|True +a| + +|properties +|link:#AvsPrivateCloudProperties[AvsPrivateCloudProperties] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#AvsPrivateCloudEndpoints] +[.api-collapsible-fifth-title] +AvsPrivateCloudEndpoints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vcenterIp +|string +|False +a| + +|=== + + +[#AvsPrivateCloudManagCluster] +[.api-collapsible-fifth-title] +AvsPrivateCloudManagCluster + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clusterId +|string +|False +a| + +|displayName +|string +|False +a| + +|clusterSize +|string +|False +a| + +|provisioningState +|string +|False +a| + +|vsanDatastoreName +|string +|False +a| + +|=== + + +[#AvsPrivateCloudProperties] +[.api-collapsible-fifth-title] +AvsPrivateCloudProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|provisioningState +|string +|False +a| + +|endpoints +|link:#AvsPrivateCloudEndpoints[AvsPrivateCloudEndpoints] +|True +a| + +|managementCluster +|link:#AvsPrivateCloudManagCluster[AvsPrivateCloudManagCluster] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-working-environments-cifs.adoc b/cvo/get-azure-vsa-working-environments-cifs.adoc new file mode 100644 index 00000000..7407a6e6 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-cifs.adoc @@ -0,0 +1,110 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-cifs.html' +summary: 'Retrieve a CIFS configuration' +--- + += Retrieve a CIFS configuration + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/cifs`# + + + +Retrieves the CIFS configuration for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svm +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|True +a|DNS domain name + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|authenticationType +|string +|True +a|Authentication type + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "activeDirectoryDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "authenticationType": "string" +} +==== + diff --git a/cvo/get-azure-vsa-working-environments-cost-and-usage.adoc b/cvo/get-azure-vsa-working-environments-cost-and-usage.adoc new file mode 100644 index 00000000..18eab3c4 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-cost-and-usage.adoc @@ -0,0 +1,241 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-cost-and-usage.html' +summary: 'Retrieve systems cost and usage' +--- + += Retrieve systems cost and usage + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/cost-and-usage`# + + + +Retrieves the system cost and usage. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|start +|string +|query +|False +a| + +|end +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hasPermissions +|boolean +|True +a|Permissions to view the cost and usage details + + +|costByTime +|array[link:#CostByTime[CostByTime]] +|True +a|System cost and usage details + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Money] +[.api-collapsible-fifth-title] +Money + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|True +a|Amount + + +|currency +|string +|True +a|Currency + + +|=== + + +[#Usage] +[.api-collapsible-fifth-title] +Usage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|False +a|Amount + + +|units +|string +|True +a|Units + + +|=== + + +[#CostByUsage] +[.api-collapsible-fifth-title] +CostByUsage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Breakdown element name + + +|cost +|link:#Money[Money] +|True +a| + +|usage +|link:#Usage[Usage] +|True +a| + +|=== + + +[#CostByService] +[.api-collapsible-fifth-title] +CostByService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the cost domain (compute, disk/blob storage, object storage, data transfer) + + +|total +|link:#Money[Money] +|True +a| + +|costByUsage +|array[link:#CostByUsage[CostByUsage]] +|True +a|Cost domain breakdown + + +|=== + + +[#CostByTime] +[.api-collapsible-fifth-title] +CostByTime + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|start +|string +|True +a|Cost period start date + + +|end +|string +|True +a|Cost period end date + + +|estimated +|boolean +|True +a|Indicates whether the cost is estimated + + +|total +|link:#Money[Money] +|True +a| + +|costByService +|array[link:#CostByService[CostByService]] +|True +a|Monthly cost and usage details + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-working-environments-create-request-parameters.adoc b/cvo/get-azure-vsa-working-environments-create-request-parameters.adoc new file mode 100644 index 00000000..ff5baa1b --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-create-request-parameters.adoc @@ -0,0 +1,95 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-create-request-parameters.html' +summary: 'Retrieve the action parameters' +--- + += Retrieve the action parameters + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/create-request-parameters`# + + + +Retrieves the action parameters used in the create request for a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|parameters +|link:#MapStringObject[MapStringObject] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject + + +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject +Hash mapping strings to link:#MapStringObject[MapStringObject] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|True +a| + +|empty +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-working-environments-extra-capacity-licenses.adoc b/cvo/get-azure-vsa-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..05208452 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-extra-capacity-licenses.html' +summary: 'Retrieve extra capacity licenses' +--- + += Retrieve extra capacity licenses + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Retrieves extra capacity licenses for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serialNumber +|string +|True +a| + +|resourceId +|string +|False +a| + +|licenseType +|string +|False +a| + +|expirationDate +|integer +|True +a| + +|license +|string +|False +a| + +|capacity +|number +|True +a| + +|metadata +|string +|False +a| + +|associatedResourceId +|string +|False +a| + +|licensePackage +|string +|False +a| + +|accountId +|string +|False +a| + +|=== + + diff --git a/cvo/get-azure-vsa-working-environments-license-instance-type.adoc b/cvo/get-azure-vsa-working-environments-license-instance-type.adoc new file mode 100644 index 00000000..a47a805e --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-license-instance-type.adoc @@ -0,0 +1,146 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-license-instance-type.html' +summary: 'Retrieve all license types' +--- + += Retrieve all license types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/license-instance-type`# + + + +Retrieves all license types and their associated instance types for a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenseType +|string +|True +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|instanceTypes +|array[link:#InstanceTypeInfo[InstanceTypeInfo]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#InstanceTypeInfo] +[.api-collapsible-fifth-title] +InstanceTypeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|False +a| + +|supportsEncryption +|boolean +|True +a| + +|supportedFeatures +|array[string] +|True +a| + +|isDefault +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-working-environments-occm-provided-upgrade-versions.adoc b/cvo/get-azure-vsa-working-environments-occm-provided-upgrade-versions.adoc new file mode 100644 index 00000000..47977f66 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-occm-provided-upgrade-versions.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-occm-provided-upgrade-versions.html' +summary: 'Retrieve a list of upgrade versions' +--- + += Retrieve a list of upgrade versions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions`# + + + +Retrieves a list of versions to which this Cloud Volumes ONTAP system can be upgraded. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-azure-vsa-working-environments-ontap-available-images.adoc b/cvo/get-azure-vsa-working-environments-ontap-available-images.adoc new file mode 100644 index 00000000..ef56bd97 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-ontap-available-images.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-ontap-available-images.html' +summary: 'Retrieve images already installed' +--- + += Retrieve images already installed + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/ontap-available-images`# + + + +Retrieves images already installed on the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|version +|string +|False +a| + +|isCurrent +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-azure-vsa-working-environments-ontap-saving.adoc b/cvo/get-azure-vsa-working-environments-ontap-saving.adoc new file mode 100644 index 00000000..7da3f269 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-ontap-saving.adoc @@ -0,0 +1,129 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-ontap-saving.html' +summary: 'Retrieve systems ONTAP savings' +--- + += Retrieve systems ONTAP savings + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/ontap-saving`# + + + +Retrieves system ONTAP savings. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|savings +|array[link:#SavingsInfo[SavingsInfo]] +|True +a|List of savings + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "savings": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Money] +[.api-collapsible-fifth-title] +Money + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|True +a|Amount + + +|currency +|string +|True +a|Currency + + +|=== + + +[#SavingsInfo] +[.api-collapsible-fifth-title] +SavingsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of saving element + + +|monthlySaving +|link:#Money[Money] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-working-environments-resource-group-exists-.adoc b/cvo/get-azure-vsa-working-environments-resource-group-exists-.adoc new file mode 100644 index 00000000..c4924e32 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-resource-group-exists-.adoc @@ -0,0 +1,55 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-resource-group-exists-.html' +summary: 'Check if a resource group with the specified name exists' +--- + += Check if a resource group with the specified name exists + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/resource-group-exists/{resourceGroupName}`# + + + +Checks if a resource group with the specified name already exists. Returns true if a resource group with that name already exists, false otherwise. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resourceGroupName +|string +|path +|True +a| + +|subscriptionId +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + + diff --git a/cvo/get-azure-vsa-working-environments-resourcegroups-avs-private-clouds-clusters-hosts.adoc b/cvo/get-azure-vsa-working-environments-resourcegroups-avs-private-clouds-clusters-hosts.adoc new file mode 100644 index 00000000..8d5ae084 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-resourcegroups-avs-private-clouds-clusters-hosts.adoc @@ -0,0 +1,90 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-resourcegroups-avs-private-clouds-clusters-hosts.html' +summary: 'Retrieve Azure VMware Solution cluster hosts' +--- + += Retrieve Azure VMware Solution cluster hosts + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters/{clusterName}/hosts`# + + + +Retrieves Azure VMware Solution cluster hosts for the existing subscription. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|resourceGroupName +|string +|path +|True +a| + +|privateCloudName +|string +|path +|True +a| + +|clusterName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|name +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "string", + "name": "string" +} +==== + diff --git a/cvo/get-azure-vsa-working-environments-resourcegroups-avs-private-clouds-clusters.adoc b/cvo/get-azure-vsa-working-environments-resourcegroups-avs-private-clouds-clusters.adoc new file mode 100644 index 00000000..5a746e09 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-resourcegroups-avs-private-clouds-clusters.adoc @@ -0,0 +1,156 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-resourcegroups-avs-private-clouds-clusters.html' +summary: 'Retrieve Azure VMware Solution private cloud clusters' +--- + += Retrieve Azure VMware Solution private cloud clusters + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters`# + + + +Retrieves Azure VMware Solution private cloud clusters for the existing subscription. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|resourceGroupName +|string +|path +|True +a| + +|privateCloudName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|name +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|properties +|link:#AvsPrivateCloudClusterProperties[AvsPrivateCloudClusterProperties] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|True +a| + +|empty +|boolean +|False +a| + +|=== + + +[#AvsPrivateCloudClusterProperties] +[.api-collapsible-fifth-title] +AvsPrivateCloudClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clusterId +|string +|False +a| + +|clusterSize +|string +|False +a| + +|provisioningState +|string +|False +a| + +|vsanDatastoreName +|string +|False +a| + +|hosts +|array[string] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-working-environments-schedules.adoc b/cvo/get-azure-vsa-working-environments-schedules.adoc new file mode 100644 index 00000000..1515bc0d --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-schedules.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-schedules.html' +summary: 'List the start-stop schedules' +--- + += List the start-stop schedules + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/schedules`# + + + +Lists the start/stop schedules for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "schedule": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-working-environments-support-registration.adoc b/cvo/get-azure-vsa-working-environments-support-registration.adoc new file mode 100644 index 00000000..347c801f --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-support-registration.adoc @@ -0,0 +1,101 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-support-registration.html' +summary: 'Retrieve the support registration status' +--- + += Retrieve the support registration status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/support-registration`# + + + +Retrieves the support registration status of a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|licenseStartDate +|link:#licenseStartDate[licenseStartDate] +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "nssAccountId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#licenseStartDate] +[.api-collapsible-fifth-title] +licenseStartDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-working-environments-update-eligibility.adoc b/cvo/get-azure-vsa-working-environments-update-eligibility.adoc new file mode 100644 index 00000000..2cccc622 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-update-eligibility.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-update-eligibility.html' +summary: 'Retrieve the eligibility support status' +--- + += Retrieve the eligibility support status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/update-eligibility`# + + + +Retrieves the eligibility support status of a Cloud Volumes ONTAP system. Valid values are NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|eligibilityResponse +|string +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "eligibilityResponse": "string" +} +==== + diff --git a/cvo/get-azure-vsa-working-environments-user-tags.adoc b/cvo/get-azure-vsa-working-environments-user-tags.adoc new file mode 100644 index 00000000..d6bd7a48 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-user-tags.adoc @@ -0,0 +1,104 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-user-tags.html' +summary: 'Retrieve editable tags for cloud resources' +--- + += Retrieve editable tags for cloud resources + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/user-tags`# + + + +Retrieves the editable tags for the cloud resources in a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tags +|array[link:#CloudResourceTag[CloudResourceTag]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tags": [ + { + "tagKey": "string", + "tagValue": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudResourceTag] +[.api-collapsible-fifth-title] +CloudResourceTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|True +a| + +|tagValue +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-working-environments-validate-byol-to-capacity.adoc b/cvo/get-azure-vsa-working-environments-validate-byol-to-capacity.adoc new file mode 100644 index 00000000..2b4ec862 --- /dev/null +++ b/cvo/get-azure-vsa-working-environments-validate-byol-to-capacity.adoc @@ -0,0 +1,214 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments-validate-byol-to-capacity.html' +summary: 'Validate prerequisites for converting a system' +--- + += Validate prerequisites for converting a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity`# + + + +Validates the prerequisites for converting an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|validAccount +|boolean +|True +a| + +|validNss +|boolean +|False +a| + +|mpSub +|array[link:#CloudAccountResponse[CloudAccountResponse]] +|True +a| + +|capacityLicenses +|array[link:#CapacityLicenseInfo[CapacityLicenseInfo]] +|True +a| + +|totalPrimaryVolumes +|link:#Capacity[Capacity] +|True +a| + +|totalDpVolumes +|link:#Capacity[Capacity] +|False +a| + +|vmPlan +|string +|False +a| + +|awsOldDeployment +|boolean +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudAccountResponse] +[.api-collapsible-fifth-title] +CloudAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudAccountId +|string +|True +a| + +|provider +|string +|False +a| + +|subscriptionId +|string +|False +a| + +|=== + + +[#TotalCapacity] +[.api-collapsible-fifth-title] +TotalCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacity +|integer +|True +a| + +|units +|string +|False +a| + +|=== + + +[#CapacityLicenseInfo] +[.api-collapsible-fifth-title] +CapacityLicenseInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|flavorType +|string +|False +a| + +|contractType +|string +|False +a| + +|totalLicensedCapacity +|link:#TotalCapacity[TotalCapacity] +|True +a| + +|totalConsumedCapacity +|link:#TotalCapacity[TotalCapacity] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-azure-vsa-working-environments.adoc b/cvo/get-azure-vsa-working-environments.adoc new file mode 100644 index 00000000..6b1bf8dd --- /dev/null +++ b/cvo/get-azure-vsa-working-environments.adoc @@ -0,0 +1,3125 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-azure-vsa-working-environments.html' +summary: 'Retrieve Cloud Volumes ONTAP systems' +--- + += Retrieve Cloud Volumes ONTAP systems + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/azure/vsa/working-environments`# + + + +Retrieves Cloud Volumes ONTAP systems visible to the current user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|tenantId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#AzureProperties[AzureProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|False +a| + +|haProperties +|link:#AzureHaProperties[AzureHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "name": "string", + "tenantId": "string", + "svmName": "string", + "creatorUserEmail": "string", + "status": { + "status": "string", + "message": "string", + "extendedFailureReason": "string" + }, + "providerProperties": { + "regionName": "string", + "vnetCidr": "string", + "subscriptionId": "string", + "deploymentId": "string", + "instanceType": "string", + "subscriptionName": "string", + "cloudProviderAccountId": "string", + "dataDisks": [ + { + "name": "string", + "id": "string", + "caching": "string", + "accountType": "string", + "encryptionSet": "string" + } + ] + }, + "clusterProperties": { + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "clusterName": "string", + "ontapVersion": "string", + "accountId": "string", + "productCode": "string", + "amiId": "string", + "systemManagerUrl": "string", + "instanceId": "string", + "platformLicense": "string", + "instanceType": "string", + "publicIp": "string", + "publicDnsName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string" + }, + "ontapClusterProperties": { + "nodes": [ + { + "name": "string", + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "platformLicense": "string", + "platformSerialNumber": "string", + "cloudProviderId": "string" + } + ], + "clusterName": "string", + "clusterUuid": "string", + "ontapVersion": "string", + "systemManagerUrl": "string", + "licensePackageName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string", + "broadcastDomainInfos": [ + {} + ], + "capacityTierInfo": { + "s3BucketName": "string", + "tierLevel": "string" + }, + "userName": "string", + "vscanFileOperationDefaultProfile": "string" + }, + "cloudProviderName": "string", + "snapshotPolicies": [ + { + "name": "string", + "schedules": [ + {} + ], + "description": "string" + } + ], + "actionsRequired": [ + {} + ], + "activeActions": [ + "string" + ], + "replicationProperties": { + "peers": [ + "string" + ], + "replicationTargets": [ + "string" + ] + }, + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ], + "svms": [ + {} + ], + "workingEnvironmentType": "string", + "supportRegistrationProperties": { + "supportRegistrationStatus": "string" + }, + "supportRegistrationInformation": [ + { + "supportRegistrationStatus": "string", + "serialNumber": "string", + "nssAccountId": "string" + } + ], + "capacityFeatures": { + "providerVolumesType": [ + { + "supportedVolumeTypes": [ + "string" + ], + "maxDisksAllow": { + "reason": "string" + } + } + ], + "defaultProviderVolumeType": { + "diskType": "string", + "capacityTier": "string" + }, + "supportedCapacityTiers": { + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] + }, + "existingIops": [ + "object" + ] + }, + "encryptionProperties": { + "keyManagers": [ + { + "publicId": "string", + "name": "string", + "address": "string", + "usernameField": "string", + "usernameValue": "string", + "status": "string" + } + ], + "encryptionCertificates": [ + {} + ], + "awsEncryptionKey": { + "alias": "string", + "keyId": "string", + "status": "string", + "origin": "string" + } + }, + "haProperties": { + "loadBalancerName": "string", + "applicationSecurityGroupName": "string", + "azureHaDeploymentType": "string" + }, + "fpolicyProperties": { + "fileExtensions": [ + "string" + ] + }, + "saasProperties": { + "subscription": { + "id": "string", + "name": "string" + }, + "capacityLicensePackage": "string" + }, + "cbsProperties": { + "cbsBackupStatus": "string", + "cbsRules": [ + { + "snapmirrorLabel": "string" + } + ], + "objectStoreName": "string", + "providerSpecific": { + "azureRgName": "string", + "gcpProjectId": "string", + "gcpRegion": "string" + }, + "cbsPolicyName": "string", + "ipSpace": "string", + "region": "string", + "providerAccountName": "string", + "exclusionReason": "string" + }, + "complianceProperties": { + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" + }, + "monitoringProperties": { + "monitoringStatus": "string", + "monitoringInfo": { + "averageLatency": { + "unit": "string" + }, + "storageAverageThroughput": { + "unit": "string" + }, + "node1AverageThroughput": { + "unit": "string" + }, + "node2AverageThroughput": { + "unit": "string" + } + }, + "tenantUrl": "string" + }, + "licensesInformation": [ + { + "type": "string", + "useType": "string", + "package": "string", + "serialNumbers": [ + "string" + ], + "expirations": [ + "object" + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#AzureResourceGroupResponse] +[.api-collapsible-fifth-title] +AzureResourceGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|location +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|=== + + +[#availabilityZone] +[.api-collapsible-fifth-title] +availabilityZone + + +[#AzureDataDiskResponse] +[.api-collapsible-fifth-title] +AzureDataDiskResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|diskSizeGB +|integer +|False +a| + +|lun +|integer +|False +a| + +|id +|string +|False +a| + +|caching +|string +|False +a| + +|accountType +|string +|False +a| + +|managed +|boolean +|False +a| + +|encryptionSet +|string +|False +a| + +|=== + + +[#AzureProperties] +[.api-collapsible-fifth-title] +AzureProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|resourceGroup +|link:#AzureResourceGroupResponse[AzureResourceGroupResponse] +|False +a| + +|vnetCidr +|string +|False +a| + +|tags +|link:#tags[tags] +|False +a| + +|subscriptionId +|string +|False +a| + +|deploymentId +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceType +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|singleNetworkInterface +|boolean +|False +a| + +|subscriptionName +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|dataDisks +|array[link:#AzureDataDiskResponse[AzureDataDiskResponse]] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#AzureAvailabilitySet] +[.api-collapsible-fifth-title] +AzureAvailabilitySet + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|faultDomain +|integer +|False +a| + +|updateDomain +|integer +|False +a| + +|=== + + +[#AzureHaNodeInfo] +[.api-collapsible-fifth-title] +AzureHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceId +|string +|False +a| + +|primaryIp +|string +|False +a| + +|state +|string +|False +a| + +|serialNumber +|string +|False +a| + +|availabilitySet +|link:#AzureAvailabilitySet[AzureAvailabilitySet] +|True +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|=== + + +[#AzureHaProperties] +[.api-collapsible-fifth-title] +AzureHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|loadBalancerName +|string +|False +a| + +|haEnabledOnLbRules +|boolean +|False +a| + +|node1Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|node2Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|multiZone +|boolean +|False +a| + +|applicationSecurityGroupName +|string +|False +a| + +|azureHaDeploymentType +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-cloud-compliance-compliance-status.adoc b/cvo/get-cloud-compliance-compliance-status.adoc new file mode 100644 index 00000000..7a4701d1 --- /dev/null +++ b/cvo/get-cloud-compliance-compliance-status.adoc @@ -0,0 +1,205 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-cloud-compliance-compliance-status.html' +summary: 'Retrieve the service cloud compliance status using the service ID' +--- + += Retrieve the service cloud compliance status using the service ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/cloud-compliance/{serviceId}/compliance-status`# + + + +Retrieves the service Cloud Compliance status using the service ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|serviceId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-cloud-compliance-fsx-compliance-status.adoc b/cvo/get-cloud-compliance-fsx-compliance-status.adoc new file mode 100644 index 00000000..0a166bef --- /dev/null +++ b/cvo/get-cloud-compliance-fsx-compliance-status.adoc @@ -0,0 +1,205 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-cloud-compliance-fsx-compliance-status.html' +summary: 'Retrieve the service cloud compliance status using the file system ID' +--- + += Retrieve the service cloud compliance status using the file system ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/cloud-compliance/fsx/{fileSystemId}/compliance-status`# + + + +Retrieves the service Cloud Compliance status using the file system ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-cloud-compliance-info.adoc b/cvo/get-cloud-compliance-info.adoc new file mode 100644 index 00000000..1b8b9dda --- /dev/null +++ b/cvo/get-cloud-compliance-info.adoc @@ -0,0 +1,64 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-cloud-compliance-info.html' +summary: 'Retrieve cloud compliance information' +--- + += Retrieve cloud compliance information + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/cloud-compliance/info`# + + + +Retrieves Cloud Compliance information. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|widgetUrl +|string +|False +a| + +|privateIp +|string +|False +a| + +|healthy +|boolean +|True +a| + +|lastDeploymentError +|string +|False +a| + +|containerActive +|boolean +|False +a| + +|=== + + diff --git a/cvo/get-flexcache-all-relationships.adoc b/cvo/get-flexcache-all-relationships.adoc new file mode 100644 index 00000000..d3195451 --- /dev/null +++ b/cvo/get-flexcache-all-relationships.adoc @@ -0,0 +1,127 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-flexcache-all-relationships.html' +summary: 'Retrieve all FlexCache volume relationships' +--- + += Retrieve all FlexCache volume relationships + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/flexcache/all-relationships`# + + + +Retrieves all FlexCache volume relationships. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workspaceId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|relationships +|array[link:#SourceTarget[SourceTarget]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "relationships": [ + { + "source": { + "id": "string" + }, + "target": { + "id": "string" + } + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Id] +[.api-collapsible-fifth-title] +Id + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|=== + + +[#SourceTarget] +[.api-collapsible-fifth-title] +SourceTarget + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|source +|link:#Id[Id] +|True +a| + +|target +|link:#Id[Id] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-flexcache-caches.adoc b/cvo/get-flexcache-caches.adoc new file mode 100644 index 00000000..37e399ab --- /dev/null +++ b/cvo/get-flexcache-caches.adoc @@ -0,0 +1,182 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-flexcache-caches.html' +summary: 'Retrieve all FlexCache volumes lists' +--- + += Retrieve all FlexCache volumes lists + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/flexcache/caches`# + + + +Retrieves all FlexCache volume lists. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workspaceId +|string +|query +|False +a| + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|source +|link:#FlexCacheSide[FlexCacheSide] +|True +a| + +|destination +|link:#FlexCacheSide[FlexCacheSide] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "source": { + "workingEnvironmentId": "string", + "workingEnvironmentType": "string", + "clusterName": "string", + "svm": "string", + "volume": "string", + "uuid": "string" + }, + "destination": { + "workingEnvironmentId": "string", + "workingEnvironmentType": "string", + "clusterName": "string", + "svm": "string", + "volume": "string", + "uuid": "string" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#FlexCacheSide] +[.api-collapsible-fifth-title] +FlexCacheSide + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|False +a|System ID + + +|workingEnvironmentType +|string +|False +a|System type + + +|clusterName +|string +|False +a|Cluster name + + +|svm +|string +|False +a|SVM name + + +|volume +|string +|False +a|Volume name + + +|uuid +|string +|False +a|Volume UUID + + +|size +|link:#Capacity[Capacity] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-fsx-volumes--snapshots.adoc b/cvo/get-fsx-volumes--snapshots.adoc new file mode 100644 index 00000000..2af40e17 --- /dev/null +++ b/cvo/get-fsx-volumes--snapshots.adoc @@ -0,0 +1,79 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-fsx-volumes--snapshots.html' +summary: 'Retrieve a list of snapshot descriptions for a volume' +--- + += Retrieve a list of snapshot descriptions for a volume + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/snapshots`# + + + +Returns a list of snapshot descriptions for the volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|accessTime +|integer +|True +a| + +|label +|string +|False +a| + +|=== + + diff --git a/cvo/get-fsx-volumes-.adoc b/cvo/get-fsx-volumes-.adoc new file mode 100644 index 00000000..e326f5b3 --- /dev/null +++ b/cvo/get-fsx-volumes-.adoc @@ -0,0 +1,605 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-fsx-volumes-.html' +summary: 'Retrieve a volume using the ID' +--- + += Retrieve a volume using the ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/fsx/volumes/{fileSystemId}/{volumeId}`# + + + +Retrieves volume using the ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|fileSystemId +|string +|path +|True +a| + +|volumeId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Volume name + + +|uuid +|string +|True +a|Volume UUID + + +|svmName +|string +|True +a|Volume SVM name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|junctionPath +|string +|True +a|The junction path at which this volume is mounted + + +|volumeTotalInodes +|integer +|False +a|Total volume inodes size + + +|volumeUsedInodes +|integer +|False +a|Used volume inodes size + + +|mountPoint +|string +|False +a|Mount Point + + +|compressionSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|deduplicationSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioning +|boolean +|True +a|Specifies whether thin provisioning is enabled + + +|compression +|boolean +|True +a|Specifies whether compression is enabled + + +|deduplication +|boolean +|True +a|Specifies whether deduplication is enabled + + +|snapshotPolicy +|string +|True +a|The name of the snapshot policy + + +|securityStyle +|string +|True +a|The type of the security style + + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|True +a| + +|shareNames +|array[string] +|True +a|The share names for CIFS + + +|shareInfo +|array[link:#CifsShareInfo[CifsShareInfo]] +|True +a|The share names, permissions, and users for CIFS + + +|parentVolumeName +|string +|True +a|Name of the parent flexible volume for the clone + + +|rootVolume +|boolean +|True +a|Flag to indicate if the volume is a SVM root + + +|state +|string +|True +a|Volume state + + +|volumeType +|string +|True +a|Volume type + + +|aggregateName +|string +|True +a|Aggregate name + + +|parentSnapshot +|string +|False +a|The snapshot name the volume is based on + + +|autoSizeMode +|string +|True +a|The operating mode of autosize + + +|maxGrowSize +|link:#Capacity[Capacity] +|True +a| + +|providerVolumeType +|string +|False +a|Cloud provider volume type + + +|cloneNames +|array[string] +|True +a|Names of cloned copies of the volume + + +|moving +|boolean +|True +a|Specifies if the volume move process is in progress + + +|primaryNoFailoverMountPoint +|string +|False +a|Primary mount point without failover + + +|secondaryNoFailoverMountPoint +|string +|False +a|Secondary mount point without failover + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cifsShareAccessPoint +|string +|False +a|CIFS share access point + + +|primaryCifsShareAccessPoint +|string +|False +a|Primary CIFS share access point + + +|secondaryCifsShareAccessPoint +|string +|False +a|Secondary CIFS share access point + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|tierInactiveUserData +|link:#Capacity[Capacity] +|False +a| + +|tierInactiveUserDataPercent +|integer +|False +a|Tier inactive user data percentage + + +|comment +|string +|False +a|Volume comment + + +|qosPolicyGroupName +|string +|False +a|Quality of service policy group name + + +|snaplockType +|string +|False +a|SnapLock type + + +|constituentsAggregates +|array[string] +|True +a|Aggregates which are used for FlexGroup constituents + + +|snapshotsUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cbsBackupsInfo +|link:#VolumeCbsInfo[VolumeCbsInfo] +|False +a| + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|targetName +|string +|True +a|iSCSI target IQN + + +|iscsiEnabled +|boolean +|True +a|Indicates if the volume is used by the iSCSI protocol + + +|isFlexGroupVolume +|boolean +|True +a|Indicates if the volume is a FlexGroup volume + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#VolumeCbsInfo] +[.api-collapsible-fifth-title] +VolumeCbsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalBackups +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-fsx-volumes-count.adoc b/cvo/get-fsx-volumes-count.adoc new file mode 100644 index 00000000..7f57b6a0 --- /dev/null +++ b/cvo/get-fsx-volumes-count.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-fsx-volumes-count.html' +summary: 'Retrieve the volume count' +--- + += Retrieve the volume count + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/fsx/volumes/{fileSystemId}/count`# + + + +Retrieves the volume count. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|svm +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + + diff --git a/cvo/get-fsx-volumes-igroups-.adoc b/cvo/get-fsx-volumes-igroups-.adoc new file mode 100644 index 00000000..b3904a5d --- /dev/null +++ b/cvo/get-fsx-volumes-igroups-.adoc @@ -0,0 +1,219 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-fsx-volumes-igroups-.html' +summary: 'Retrieve all igroups' +--- + += Retrieve all igroups + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/fsx/volumes/igroups/{fileSystemId}/{svmName}`# + + + +Retrieves all igroups. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|igroupName +|string +|True +a| + +|osType +|string +|False +a| + +|portsetName +|string +|False +a| + +|igroupType +|string +|True +a| + +|initiators +|array[string] +|True +a| + +|lunMaps +|array[link:#LunMapsLun[LunMapsLun]] +|True +a| + +|initiatorsWithConnStatus +|array[link:#InitiatorsConnectivityStateNameObject[InitiatorsConnectivityStateNameObject]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "igroupName": "string", + "osType": "string", + "portsetName": "string", + "igroupType": "string", + "initiators": [ + "string" + ], + "lunMaps": [ + { + "lun": { + "name": "string", + "uuid": "string" + } + } + ], + "initiatorsWithConnStatus": [ + { + "connectivity_tracking": { + "connection_state": "string" + }, + "name": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#NameUuidObject] +[.api-collapsible-fifth-title] +NameUuidObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|uuid +|string +|False +a| + +|=== + + +[#LunMapsLun] +[.api-collapsible-fifth-title] +LunMapsLun + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lun +|link:#NameUuidObject[NameUuidObject] +|True +a| + +|=== + + +[#ConnectionState] +[.api-collapsible-fifth-title] +ConnectionState + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connection_state +|string +|False +a| + +|=== + + +[#InitiatorsConnectivityStateNameObject] +[.api-collapsible-fifth-title] +InitiatorsConnectivityStateNameObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connectivity_tracking +|link:#ConnectionState[ConnectionState] +|True +a| + +|name +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-fsx-volumes-initiator.adoc b/cvo/get-fsx-volumes-initiator.adoc new file mode 100644 index 00000000..331ed0ea --- /dev/null +++ b/cvo/get-fsx-volumes-initiator.adoc @@ -0,0 +1,56 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-fsx-volumes-initiator.html' +summary: 'Retrieve all iSCSI initiators' +--- + += Retrieve all iSCSI initiators + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/fsx/volumes/initiator`# + + + +Retrieves all iSCSI initiators. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + diff --git a/cvo/get-fsx-volumes-nfs-clients.adoc b/cvo/get-fsx-volumes-nfs-clients.adoc new file mode 100644 index 00000000..3e9e5664 --- /dev/null +++ b/cvo/get-fsx-volumes-nfs-clients.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-fsx-volumes-nfs-clients.html' +summary: 'Retrieve an NFS clients list for an FSx system' +--- + += Retrieve an NFS clients list for an FSx system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/fsx/volumes/{fileSystemId}/nfs-clients`# + + + +Retrieves an NFS client list for an existing FSx system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|svm +|string +|query +|False +a| + +|volume +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volume +|string +|True +a| + +|svm +|string +|False +a| + +|exportPolicy +|string +|False +a| + +|clientIp +|string +|False +a| + +|idleDuration +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "volume": "string", + "svm": "string", + "exportPolicy": "string", + "clientIp": "string", + "idleDuration": "string" +} +==== + diff --git a/cvo/get-fsx-volumes-shares.adoc b/cvo/get-fsx-volumes-shares.adoc new file mode 100644 index 00000000..b363802f --- /dev/null +++ b/cvo/get-fsx-volumes-shares.adoc @@ -0,0 +1,134 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-fsx-volumes-shares.html' +summary: 'Retrieve a CIFS share list for an FSx system' +--- + += Retrieve a CIFS share list for an FSx system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/fsx/volumes/{fileSystemId}/shares`# + + + +Retrieves a CIFS share list for an existing FSx system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|svm +|string +|query +|False +a| + +|volume +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|volume +|string +|False +a| + +|path +|string +|False +a| + +|permissions +|array[link:#SharePermissions[SharePermissions]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "volume": "string", + "path": "string", + "permissions": [ + { + "userOrGroup": "string", + "permission": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SharePermissions] +[.api-collapsible-fifth-title] +SharePermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|userOrGroup +|string +|False +a| + +|permission +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-fsx-working-environments-cifs.adoc b/cvo/get-fsx-working-environments-cifs.adoc new file mode 100644 index 00000000..44bb07ed --- /dev/null +++ b/cvo/get-fsx-working-environments-cifs.adoc @@ -0,0 +1,110 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-fsx-working-environments-cifs.html' +summary: 'Retrieve CIFS configuration for an FSx system' +--- + += Retrieve CIFS configuration for an FSx system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/fsx/working-environments/{fileSystemId}/cifs`# + + + +Retrieves a CIFS configuration for an existing FSx system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|svm +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|True +a|DNS domain name + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|authenticationType +|string +|True +a|Authentication type + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "activeDirectoryDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "authenticationType": "string" +} +==== + diff --git a/cvo/get-fsx-working-environments-export-policies.adoc b/cvo/get-fsx-working-environments-export-policies.adoc new file mode 100644 index 00000000..0d814f57 --- /dev/null +++ b/cvo/get-fsx-working-environments-export-policies.adoc @@ -0,0 +1,147 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-fsx-working-environments-export-policies.html' +summary: 'Retrieve an export policies list for an FSx system' +--- + += Retrieve an export policies list for an FSx system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/fsx/working-environments/{fileSystemId}/export-policies`# + + + +Retrieves an export policies list for an existing FSx system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|svm +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|svm +|string +|False +a| + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "svm": "string", + "rules": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-fsx-working-environments-interfaces.adoc b/cvo/get-fsx-working-environments-interfaces.adoc new file mode 100644 index 00000000..8c121d38 --- /dev/null +++ b/cvo/get-fsx-working-environments-interfaces.adoc @@ -0,0 +1,110 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-fsx-working-environments-interfaces.html' +summary: 'Retrieve network interfaces lists for an FSx system' +--- + += Retrieve network interfaces lists for an FSx system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/fsx/working-environments/{fileSystemId}/interfaces`# + + + +Retrieves a network interfaces list for an existing FSx system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|svm +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|address +|string +|False +a| + +|svm +|string +|False +a| + +|role +|string +|False +a| + +|status +|string +|False +a| + +|ipSpace +|string +|False +a| + +|dataProtocols +|array[string] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "address": "string", + "svm": "string", + "role": "string", + "status": "string", + "ipSpace": "string", + "dataProtocols": [ + "string" + ] +} +==== + diff --git a/cvo/get-fsx-working-environments-snapshot-policies.adoc b/cvo/get-fsx-working-environments-snapshot-policies.adoc new file mode 100644 index 00000000..9af4a2bd --- /dev/null +++ b/cvo/get-fsx-working-environments-snapshot-policies.adoc @@ -0,0 +1,118 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-fsx-working-environments-snapshot-policies.html' +summary: 'Retrieve snapshot policies for an FSx system' +--- + += Retrieve snapshot policies for an FSx system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/fsx/working-environments/{fileSystemId}/snapshot-policies`# + + + +Retrieves the snapshot policies for an existing FSx system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "schedules": [ + {} + ], + "description": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-fsx-working-environments-svms.adoc b/cvo/get-fsx-working-environments-svms.adoc new file mode 100644 index 00000000..c6347221 --- /dev/null +++ b/cvo/get-fsx-working-environments-svms.adoc @@ -0,0 +1,86 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-fsx-working-environments-svms.html' +summary: 'Retrieve an SVM list for an FSx system' +--- + += Retrieve an SVM list for an FSx system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/fsx/working-environments/{fileSystemId}/svms`# + + + +Retrieves an SVM list for an existing FSx system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|state +|string +|False +a| + +|language +|string +|False +a| + +|allowedProtocols +|array[string] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "state": "string", + "language": "string", + "allowedProtocols": [ + "string" + ] +} +==== + diff --git a/cvo/get-gcp-ha-aggregates-.adoc b/cvo/get-gcp-ha-aggregates-.adoc new file mode 100644 index 00000000..81d0bd9f --- /dev/null +++ b/cvo/get-gcp-ha-aggregates-.adoc @@ -0,0 +1,404 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-aggregates-.html' +summary: 'Retrieve aggregates' +--- + += Retrieve aggregates + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/aggregates/{workingEnvironmentId}`# + + + +Retrieves aggregates. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Aggregate name + + +|availableCapacity +|link:#Capacity[Capacity] +|True +a| + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|usedCapacity +|link:#Capacity[Capacity] +|True +a| + +|volumes +|array[link:#Volume[Volume]] +|True +a|Volumes + + +|providerVolumes +|array[link:#ProviderVolumeResponse[ProviderVolumeResponse]] +|True +a|Provider volumes + + +|disks +|array[link:#Disk[Disk]] +|True +a|Disks + + +|state +|string +|False +a|State + + +|encryptionType +|string +|True +a|Encryption Type + + +|encryptionKeyId +|string +|False +a|Encryption Key + + +|isRoot +|boolean +|True +a|Is Root + + +|homeNode +|string +|True +a|Home node + + +|ownerNode +|string +|False +a|Owner node + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsed +|link:#Capacity[Capacity] +|False +a| + +|sidlEnabled +|boolean +|True +a|SIDL enabled + + +|snaplockType +|string +|True +a|Snaplock type + + +|evCompatibilityType +|string +|True +a|Elastic Volume Compatibility Type + + +|iops +|link:#iops[iops] +|False +a|Aggregate IOPS + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Volume] +[.api-collapsible-fifth-title] +Volume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|totalSize +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioned +|boolean +|True +a|Indicates if the volume is thin-provisioned + + +|isClone +|boolean +|True +a|Indicates if the volume is a clone volume + + +|rootVolume +|boolean +|True +a|Indicates if the volume is the root volume of the SVM + + +|=== + + +[#ProviderVolumeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Specifies the ID + + +|name +|string +|True +a|Specifies the name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|state +|string +|True +a|State + + +|device +|string +|True +a|Device + + +|instanceId +|string +|True +a|InstanceId + + +|diskType +|string +|True +a|Type + + +|encrypted +|boolean +|True +a|Encrypted + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|instance2Id +|string +|False +a|Instance2Id + + +|=== + + +[#VmDiskProperties] +[.api-collapsible-fifth-title] +VmDiskProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectName +|string +|False +a| + +|storageAccountName +|string +|False +a| + +|containerName +|string +|False +a| + +|=== + + +[#Disk] +[.api-collapsible-fifth-title] +Disk + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Name + + +|containerType +|string +|True +a|Container type + + +|ownerNode +|string +|True +a|Owner node + + +|device +|string +|False +a|Device + + +|vmDiskProperties +|link:#VmDiskProperties[VmDiskProperties] +|False +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + +Aggregate IOPS + + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-discovery-discover.adoc b/cvo/get-gcp-ha-discovery-discover.adoc new file mode 100644 index 00000000..cafa995c --- /dev/null +++ b/cvo/get-gcp-ha-discovery-discover.adoc @@ -0,0 +1,103 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-discovery-discover.html' +summary: 'Retrieve a list of HA systems for a Google Cloud region' +--- + += Retrieve a list of HA systems for a Google Cloud region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/discovery/discover`# + + + +Retrieves a list of discovered systems visible to the current user in the specified Google Cloud region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|project +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|id +|string +|False +a| + +|publicId +|string +|False +a| + +|zones +|array[string] +|True +a| + +|vpcs +|array[string] +|False +a| + +|subnetIds +|array[string] +|False +a| + +|projectName +|string +|False +a| + +|clusterAddress +|string +|False +a| + +|recoverable +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-gcp-ha-metadata-buckets.adoc b/cvo/get-gcp-ha-metadata-buckets.adoc new file mode 100644 index 00000000..a10139a4 --- /dev/null +++ b/cvo/get-gcp-ha-metadata-buckets.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-buckets.html' +summary: 'Retrieve all cloud storage buckets' +--- + += Retrieve all cloud storage buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/buckets`# + + + +Retrieves all cloud storage buckets. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|projectId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|location +|string +|False +a| + +|storageClass +|string +|False +a| + +|kmsKeyName +|string +|False +a| + +|labels +|link:#MapStringString[MapStringString] +|True +a|Instance tags + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#MapStringString] +[.api-collapsible-fifth-title] +MapStringString + +Instance tags + +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-metadata-default-snapshot-policies.adoc b/cvo/get-gcp-ha-metadata-default-snapshot-policies.adoc new file mode 100644 index 00000000..0f04ca0f --- /dev/null +++ b/cvo/get-gcp-ha-metadata-default-snapshot-policies.adoc @@ -0,0 +1,100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-default-snapshot-policies.html' +summary: 'Retrieve the default snapshot policies' +--- + += Retrieve the default snapshot policies + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/default-snapshot-policies`# + + + +Retrieves the default snapshot policies available on a cluster. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "schedules": [ + {} + ], + "description": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-metadata-gcp-disk-types.adoc b/cvo/get-gcp-ha-metadata-gcp-disk-types.adoc new file mode 100644 index 00000000..cb55c0ca --- /dev/null +++ b/cvo/get-gcp-ha-metadata-gcp-disk-types.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-gcp-disk-types.html' +summary: 'Retrieve the supported disk types' +--- + += Retrieve the supported disk types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/gcp-disk-types`# + + + +Retrieves the supported Google Cloud disk types. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|True +a| + +|supportedDiskTypes +|array[string] +|True +a| + +|supportedOccmLicenses +|array[string] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-metadata-gcp-encryption-keys.adoc b/cvo/get-gcp-ha-metadata-gcp-encryption-keys.adoc new file mode 100644 index 00000000..788742ba --- /dev/null +++ b/cvo/get-gcp-ha-metadata-gcp-encryption-keys.adoc @@ -0,0 +1,90 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-gcp-encryption-keys.html' +summary: 'Retrieve Google Cloud encryption keys for a region' +--- + += Retrieve Google Cloud encryption keys for a region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/gcp-encryption-keys`# + + + +Retrieves Google Cloud encryption keys for a specific region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|project +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|id +|string +|False +a| + +|keyRing +|string +|False +a| + +|location +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "id": "string", + "keyRing": "string", + "location": "string" +} +==== + diff --git a/cvo/get-gcp-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc b/cvo/get-gcp-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc new file mode 100644 index 00000000..740891e3 --- /dev/null +++ b/cvo/get-gcp-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html' +summary: 'Retrieve instance types that do not support acceleration and capacity tiering' +--- + += Retrieve instance types that do not support acceleration and capacity tiering + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering`# + + + +Retrieves the instance types that do not support acceleration and capacity tiering. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceTypes +|array[link:#InstanceTypeResponse[InstanceTypeResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceTypes": [ + { + "instanceType": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#InstanceTypeResponse] +[.api-collapsible-fifth-title] +InstanceTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-metadata-network-requirements.adoc b/cvo/get-gcp-ha-metadata-network-requirements.adoc new file mode 100644 index 00000000..3a4228bc --- /dev/null +++ b/cvo/get-gcp-ha-metadata-network-requirements.adoc @@ -0,0 +1,44 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-network-requirements.html' +summary: 'Retrieve the minimum number of IP addresses for a system' +--- + += Retrieve the minimum number of IP addresses for a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/network-requirements`# + + + +Retrieves the minimum number of required IP addresses for a Cloud Volumes ONTAP system. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vsaMinimumRequiredIps +|integer +|True +a| + +|haVsaMinimumRequiredIps +|integer +|False +a| + +|=== + + diff --git a/cvo/get-gcp-ha-metadata-packages.adoc b/cvo/get-gcp-ha-metadata-packages.adoc new file mode 100644 index 00000000..42f9c8af --- /dev/null +++ b/cvo/get-gcp-ha-metadata-packages.adoc @@ -0,0 +1,187 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-packages.html' +summary: 'Retrieve the packages configuration' +--- + += Retrieve the packages configuration + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/packages`# + + + +Retrieves the packages configuration. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|deploymentModel +|string +|query +|False +a| + +|capacityPackage +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|displayName +|string +|False +a| + +|description +|string +|False +a| + +|licenseType +|string +|False +a| + +|instanceTypeMapping +|array[link:#InstanceTypeRegionMapping[InstanceTypeRegionMapping]] +|True +a| + +|diskType +|string +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|capacityTier +|string +|False +a| + +|instanceTenancy +|string +|False +a| + +|writingSpeedState +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|throughput +|link:#throughput[throughput] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#InstanceTypeRegionMapping] +[.api-collapsible-fifth-title] +InstanceTypeRegionMapping + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|False +a| + +|instanceType +|string +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#throughput] +[.api-collapsible-fifth-title] +throughput + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-metadata-permutations.adoc b/cvo/get-gcp-ha-metadata-permutations.adoc new file mode 100644 index 00000000..eb8d5a53 --- /dev/null +++ b/cvo/get-gcp-ha-metadata-permutations.adoc @@ -0,0 +1,197 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-permutations.html' +summary: 'Retrieve all Cloud Volumes ONTAP configurations' +--- + += Retrieve all Cloud Volumes ONTAP configurations + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/permutations`# + + + +Retrieves all Cloud Volumes ONTAP configurations. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a| + +|license +|link:#OntapLicenseType[OntapLicenseType] +|True +a| + +|instanceType +|string +|False +a| + +|region +|link:#Region[Region] +|True +a| + +|defaultInstance +|boolean +|False +a| + +|features +|array[string] +|True +a| + +|upgradeableFrom +|array[string] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#Region] +[.api-collapsible-fifth-title] +Region + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|code +|string +|False +a| + +|location +|string +|False +a| + +|s3Region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-metadata-projects.adoc b/cvo/get-gcp-ha-metadata-projects.adoc new file mode 100644 index 00000000..d2f1e3a0 --- /dev/null +++ b/cvo/get-gcp-ha-metadata-projects.adoc @@ -0,0 +1,137 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-projects.html' +summary: 'Retrieve a list of projects' +--- + += Retrieve a list of projects + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/projects`# + + + +Retrieves a list of projects for which the user has permission. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|projects +|array[link:#GcpProjectResponse[GcpProjectResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "projects": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parent] +[.api-collapsible-fifth-title] +parent +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#GcpProjectResponse] +[.api-collapsible-fifth-title] +GcpProjectResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isDefault +|boolean +|True +a| + +|projectNumber +|string +|True +a| + +|projectId +|string +|False +a| + +|lifecycleState +|string +|False +a| + +|name +|string +|False +a| + +|createTime +|string +|False +a| + +|parent +|link:#parent[parent] +|True +a| + +|subscriptionId +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-metadata-regions.adoc b/cvo/get-gcp-ha-metadata-regions.adoc new file mode 100644 index 00000000..ff211079 --- /dev/null +++ b/cvo/get-gcp-ha-metadata-regions.adoc @@ -0,0 +1,292 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-regions.html' +summary: 'Retrieve Google Cloud regions' +--- + += Retrieve Google Cloud regions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/regions`# + + + +Retrieves Google Cloud regions where a Cloud Volumes ONTAP system can be created. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project +|string +|query +|False +a| + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|displayName +|string +|True +a| + +|name +|string +|False +a| + +|zones +|array[link:#GcpZoneResponse[GcpZoneResponse]] +|True +a| + +|vpcs +|array[link:#GcpVirtualNetworkResponse[GcpVirtualNetworkResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "displayName": "string", + "name": "string", + "zones": [ + { + "name": "string" + } + ], + "vpcs": [ + { + "name": "string", + "subnets": [ + {} + ], + "firewalls": [ + { + "name": "string", + "vpc": "string", + "targetServiceAccount": [ + "string" + ] + } + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#GcpZoneResponse] +[.api-collapsible-fifth-title] +GcpZoneResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Zone Name + + +|=== + + +[#GcpSubnetResponse] +[.api-collapsible-fifth-title] +GcpSubnetResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ipCidrRange +|string +|True +a|Classless Inter-Domain Routing (CIDR) + + +|name +|string +|True +a|Subnet name + + +|path +|string +|True +a|Subnet path + + +|availableIps +|integer +|True +a|The number of available IP addresses on the subnet + + +|minimumRequiredIps +|integer +|True +a|The minimum needed IP addresses for the Cloud Volumes ONTAP system creation + +* format: int32 + + +|=== + + +[#GcpFirewallResponse] +[.api-collapsible-fifth-title] +GcpFirewallResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Firewall Name + + +|vpc +|string +|True +a|VPC + + +|targetServiceAccount +|array[string] +|True +a|Target Service Account + + +|=== + + +[#GcpVirtualNetworkResponse] +[.api-collapsible-fifth-title] +GcpVirtualNetworkResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Virtual Network Name + + +|subnets +|array[link:#GcpSubnetResponse[GcpSubnetResponse]] +|True +a|Subnets + + +|firewalls +|array[link:#GcpFirewallResponse[GcpFirewallResponse]] +|True +a|Firewalls + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-metadata-service-accounts.adoc b/cvo/get-gcp-ha-metadata-service-accounts.adoc new file mode 100644 index 00000000..9ac740db --- /dev/null +++ b/cvo/get-gcp-ha-metadata-service-accounts.adoc @@ -0,0 +1,116 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-service-accounts.html' +summary: 'Retrieve a list of service accounts' +--- + += Retrieve a list of service accounts + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/service-accounts`# + + + +Retrieves a list of Service Accounts from the project. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accounts +|array[link:#GcpServiceAccountResponse[GcpServiceAccountResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accounts": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#GcpServiceAccountResponse] +[.api-collapsible-fifth-title] +GcpServiceAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|projectId +|string +|False +a| + +|email +|string +|False +a| + +|displayName +|string +|False +a| + +|isEnabled +|boolean +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-metadata-supported-capacity-tiers.adoc b/cvo/get-gcp-ha-metadata-supported-capacity-tiers.adoc new file mode 100644 index 00000000..6222c5ce --- /dev/null +++ b/cvo/get-gcp-ha-metadata-supported-capacity-tiers.adoc @@ -0,0 +1,156 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-supported-capacity-tiers.html' +summary: 'Retrieve supported capacity tiers for Google Cloud disk types' +--- + += Retrieve supported capacity tiers for Google Cloud disk types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/supported-capacity-tiers`# + + + +Retrieves the supported capacity tiers for Google Cloud disk types. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|ontapVersion +|string +|query +|False +a| + +|dataEncryptionType +|string +|query +|False +a| + +|licenseType +|string +|query +|False +a| + +|instanceType +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-metadata-supported-features.adoc b/cvo/get-gcp-ha-metadata-supported-features.adoc new file mode 100644 index 00000000..d1b77336 --- /dev/null +++ b/cvo/get-gcp-ha-metadata-supported-features.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-supported-features.html' +summary: 'Retrieve supported features' +--- + += Retrieve supported features + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/supported-features`# + + + +Retrieves the supported features. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|ontapVersion +|string +|query +|False +a| + +|dataEncryptionType +|string +|query +|False +a| + +|licenseType +|string +|query +|False +a| + +|instanceType +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|wormSupportedVersion +|boolean +|True +a| + +|cbsSupportedVersion +|boolean +|False +a| + +|httpsStorageAccountSupportedVersion +|boolean +|False +a| + +|tieringWithServiceAccount +|boolean +|False +a| + +|s3CmkEncryptionSupportedVersion +|boolean +|False +a| + +|gp3SupportedVersion +|boolean +|False +a| + +|elasticVolumeSupportedAndEnabled +|boolean +|False +a| + +|wormWithComposeSupported +|boolean +|False +a| + +|isAzureFlashcacheSupported +|boolean +|False +a| + +|wormWithBackupSupported +|boolean +|False +a| + +|azureHaManagedDisksSupported +|boolean +|False +a| + +|awsLocalZones +|boolean +|False +a| + +|isAzureZonalSupported +|boolean +|False +a| + +|=== + + diff --git a/cvo/get-gcp-ha-metadata-tag-keys.adoc b/cvo/get-gcp-ha-metadata-tag-keys.adoc new file mode 100644 index 00000000..a35e22a3 --- /dev/null +++ b/cvo/get-gcp-ha-metadata-tag-keys.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-tag-keys.html' +summary: 'Retrieve all labels for a project ID and region' +--- + += Retrieve all labels for a project ID and region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/tag-keys`# + + + +Retrieves all labels in the specified project ID and region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|projectId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a| + +|values +|array[string] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "key": "string", + "values": [ + "string" + ] +} +==== + diff --git a/cvo/get-gcp-ha-metadata-vpcs.adoc b/cvo/get-gcp-ha-metadata-vpcs.adoc new file mode 100644 index 00000000..5661655b --- /dev/null +++ b/cvo/get-gcp-ha-metadata-vpcs.adoc @@ -0,0 +1,175 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-vpcs.html' +summary: 'Retrieve Google Cloud networks and subnetworks' +--- + += Retrieve Google Cloud networks and subnetworks + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/vpcs`# + + + +Retrieves Google Cloud networks and subnetworks where a Cloud Volumes ONTAP system can be created. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|project +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Virtual Network Name + + +|vpcPath +|string +|True +a|Virtual Network path + + +|subnets +|array[link:#GcpSubnetResponse[GcpSubnetResponse]] +|True +a|Subnets + + +|firewalls +|array[link:#GcpFirewallResponse[GcpFirewallResponse]] +|True +a|Firewalls + + +|isShared +|boolean +|True +a|isShared + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#GcpSubnetResponse] +[.api-collapsible-fifth-title] +GcpSubnetResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ipCidrRange +|string +|True +a|Classless Inter-Domain Routing (CIDR) + + +|name +|string +|True +a|Subnet name + + +|path +|string +|True +a|Subnet path + + +|availableIps +|integer +|True +a|The number of available IP addresses on the subnet + + +|minimumRequiredIps +|integer +|True +a|The minimum needed IP addresses for the Cloud Volumes ONTAP system creation + +* format: int32 + + +|=== + + +[#GcpFirewallResponse] +[.api-collapsible-fifth-title] +GcpFirewallResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Firewall Name + + +|vpc +|string +|True +a|VPC + + +|targetServiceAccount +|array[string] +|True +a|Target Service Account + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-metadata-workerpools.adoc b/cvo/get-gcp-ha-metadata-workerpools.adoc new file mode 100644 index 00000000..727f2363 --- /dev/null +++ b/cvo/get-gcp-ha-metadata-workerpools.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-workerpools.html' +summary: 'Retrieve Google Cloud worker pools for a Cloud Volumes ONTAP system' +--- + += Retrieve Google Cloud worker pools for a Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/workerPools`# + + + +Retrieves Google Cloud worker pools using Infrastructure Manager (IM) in which a private mode Cloud Volumes ONTAP system can be created. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project +|string +|query +|False +a|The project ID to use for the request + + +|region +|string +|query +|True +a|The region in which to list worker pools + + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|True +a| + +|defined +|boolean +|False +a| + +|=== + + diff --git a/cvo/get-gcp-ha-metadata-zones.adoc b/cvo/get-gcp-ha-metadata-zones.adoc new file mode 100644 index 00000000..45b1d33f --- /dev/null +++ b/cvo/get-gcp-ha-metadata-zones.adoc @@ -0,0 +1,117 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-metadata-zones.html' +summary: 'Retrieve Google Cloud regions and zones' +--- + += Retrieve Google Cloud regions and zones + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/metadata/zones`# + + + +Retrieves Google Cloud regions and zones where a Cloud Volumes ONTAP system can be created. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|displayName +|string +|True +a| + +|name +|string +|False +a| + +|location +|string +|False +a| + +|zones +|array[link:#GcpZoneResponse[GcpZoneResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "displayName": "string", + "name": "string", + "location": "string", + "zones": [ + { + "name": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#GcpZoneResponse] +[.api-collapsible-fifth-title] +GcpZoneResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Zone Name + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-volumes--snapshots.adoc b/cvo/get-gcp-ha-volumes--snapshots.adoc new file mode 100644 index 00000000..42864eb8 --- /dev/null +++ b/cvo/get-gcp-ha-volumes--snapshots.adoc @@ -0,0 +1,79 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-volumes--snapshots.html' +summary: 'Retrieve a list of snapshot descriptions' +--- + += Retrieve a list of snapshot descriptions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots`# + + + +Returns a list of snapshot descriptions for the volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|accessTime +|integer +|True +a| + +|label +|string +|False +a| + +|=== + + diff --git a/cvo/get-gcp-ha-volumes-igroups-.adoc b/cvo/get-gcp-ha-volumes-igroups-.adoc new file mode 100644 index 00000000..aa70d0ab --- /dev/null +++ b/cvo/get-gcp-ha-volumes-igroups-.adoc @@ -0,0 +1,219 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-volumes-igroups-.html' +summary: 'Retrieve all igroups' +--- + += Retrieve all igroups + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/volumes/igroups/{workingEnvironmentId}/{svmName}`# + + + +Retrieves all igroups. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|igroupName +|string +|True +a| + +|osType +|string +|False +a| + +|portsetName +|string +|False +a| + +|igroupType +|string +|True +a| + +|initiators +|array[string] +|True +a| + +|lunMaps +|array[link:#LunMapsLun[LunMapsLun]] +|True +a| + +|initiatorsWithConnStatus +|array[link:#InitiatorsConnectivityStateNameObject[InitiatorsConnectivityStateNameObject]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "igroupName": "string", + "osType": "string", + "portsetName": "string", + "igroupType": "string", + "initiators": [ + "string" + ], + "lunMaps": [ + { + "lun": { + "name": "string", + "uuid": "string" + } + } + ], + "initiatorsWithConnStatus": [ + { + "connectivity_tracking": { + "connection_state": "string" + }, + "name": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#NameUuidObject] +[.api-collapsible-fifth-title] +NameUuidObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|uuid +|string +|False +a| + +|=== + + +[#LunMapsLun] +[.api-collapsible-fifth-title] +LunMapsLun + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lun +|link:#NameUuidObject[NameUuidObject] +|True +a| + +|=== + + +[#ConnectionState] +[.api-collapsible-fifth-title] +ConnectionState + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connection_state +|string +|False +a| + +|=== + + +[#InitiatorsConnectivityStateNameObject] +[.api-collapsible-fifth-title] +InitiatorsConnectivityStateNameObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connectivity_tracking +|link:#ConnectionState[ConnectionState] +|True +a| + +|name +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-volumes-initiator.adoc b/cvo/get-gcp-ha-volumes-initiator.adoc new file mode 100644 index 00000000..f9f7d04f --- /dev/null +++ b/cvo/get-gcp-ha-volumes-initiator.adoc @@ -0,0 +1,56 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-volumes-initiator.html' +summary: 'Retrieve all iSCSI initiators' +--- + += Retrieve all iSCSI initiators + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/volumes/initiator`# + + + +Retrieves all iSCSI initiators. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + diff --git a/cvo/get-gcp-ha-volumes-volumes-for-backup.adoc b/cvo/get-gcp-ha-volumes-volumes-for-backup.adoc new file mode 100644 index 00000000..193258e2 --- /dev/null +++ b/cvo/get-gcp-ha-volumes-volumes-for-backup.adoc @@ -0,0 +1,288 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-volumes-volumes-for-backup.html' +summary: 'Retrieve volumes for backup activation' +--- + += Retrieve volumes for backup activation + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/volumes/volumes-for-backup`# + + + +Retrieves all volumes for backup activation. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|offset +|integer +|query +|False +a| + +|limit +|integer +|query +|False +a| + +|search +|string +|query +|False +a| + +|filterBy +|link:#ListFilterByParam[ListFilterByParam] +|query +|False +a| + +|sortBy +|link:#ListSortByParam[ListSortByParam] +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumes +|array[link:#VolumeForBackupResponse[VolumeForBackupResponse]] +|True +a| + +|totalNumberOfVolumes +|integer +|True +a| + +|filteredNumberOfVolumes +|link:#filteredNumberOfVolumes[filteredNumberOfVolumes] +|False +a| + +|hasNextPage +|link:#hasNextPage[hasNextPage] +|False +a| + +|allowedValuesForVolumesListFilter +|link:#AllowedValuesForVolumesListFilter[AllowedValuesForVolumesListFilter] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ListFilterByParam] +[.api-collapsible-fifth-title] +ListFilterByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#ListSortByParam] +[.api-collapsible-fifth-title] +ListSortByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeForBackupResponse] +[.api-collapsible-fifth-title] +VolumeForBackupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|uuid +|string +|False +a| + +|svmName +|string +|False +a| + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|False +a| + +|state +|string +|False +a| + +|providerVolumeType +|string +|False +a| + +|volumeType +|string +|False +a| + +|isBackupOn +|boolean +|True +a| + +|disableReasonBackup +|array[string] +|True +a| + +|=== + + +[#filteredNumberOfVolumes] +[.api-collapsible-fifth-title] +filteredNumberOfVolumes + + +[#hasNextPage] +[.api-collapsible-fifth-title] +hasNextPage + + +[#AllowedValuesForVolumesListFilter] +[.api-collapsible-fifth-title] +AllowedValuesForVolumesListFilter + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeTypes +|array[string] +|False +a| + +|diskTypes +|array[string] +|False +a| + +|svmNames +|array[string] +|False +a| + +|volumeStatus +|array[string] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-volumes.adoc b/cvo/get-gcp-ha-volumes.adoc new file mode 100644 index 00000000..3532dd35 --- /dev/null +++ b/cvo/get-gcp-ha-volumes.adoc @@ -0,0 +1,550 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-volumes.html' +summary: 'Retrieve volumes' +--- + += Retrieve volumes + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/volumes`# + + + +Retrieves all volumes. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Volume name + + +|uuid +|string +|True +a|Volume UUID + + +|svmName +|string +|True +a|Volume SVM name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|junctionPath +|string +|True +a|The junction path at which this volume is mounted + + +|volumeTotalInodes +|integer +|False +a|Total volume inodes size + + +|volumeUsedInodes +|integer +|False +a|Used volume inodes size + + +|mountPoint +|string +|False +a|Mount Point + + +|compressionSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|deduplicationSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioning +|boolean +|True +a|Specifies whether thin provisioning is enabled + + +|compression +|boolean +|True +a|Specifies whether compression is enabled + + +|deduplication +|boolean +|True +a|Specifies whether deduplication is enabled + + +|snapshotPolicy +|string +|True +a|The name of the snapshot policy + + +|securityStyle +|string +|True +a|The type of the security style + + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|True +a| + +|shareNames +|array[string] +|True +a|The share names for CIFS + + +|shareInfo +|array[link:#CifsShareInfo[CifsShareInfo]] +|True +a|The share names, permissions, and users for CIFS + + +|parentVolumeName +|string +|True +a|Name of the parent flexible volume for the clone + + +|rootVolume +|boolean +|True +a|Flag to indicate if the volume is a SVM root + + +|state +|string +|True +a|Volume state + + +|volumeType +|string +|True +a|Volume type + + +|aggregateName +|string +|True +a|Aggregate name + + +|parentSnapshot +|string +|False +a|The snapshot name the volume is based on + + +|autoSizeMode +|string +|True +a|The operating mode of autosize + + +|maxGrowSize +|link:#Capacity[Capacity] +|True +a| + +|providerVolumeType +|string +|False +a|Cloud provider volume type + + +|cloneNames +|array[string] +|True +a|Names of cloned copies of the volume + + +|moving +|boolean +|True +a|Specifies if the volume move process is in progress + + +|primaryNoFailoverMountPoint +|string +|False +a|Primary mount point without failover + + +|secondaryNoFailoverMountPoint +|string +|False +a|Secondary mount point without failover + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cifsShareAccessPoint +|string +|False +a|CIFS share access point + + +|primaryCifsShareAccessPoint +|string +|False +a|Primary CIFS share access point + + +|secondaryCifsShareAccessPoint +|string +|False +a|Secondary CIFS share access point + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|tierInactiveUserData +|link:#Capacity[Capacity] +|False +a| + +|tierInactiveUserDataPercent +|integer +|False +a|Tier inactive user data percentage + + +|comment +|string +|False +a|Volume comment + + +|qosPolicyGroupName +|string +|False +a|Quality of service policy group name + + +|snaplockType +|string +|False +a|SnapLock type + + +|constituentsAggregates +|array[string] +|True +a|Aggregates which are used for FlexGroup constituents + + +|snapshotsUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cbsBackupsInfo +|link:#VolumeCbsInfo[VolumeCbsInfo] +|False +a| + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|targetName +|string +|True +a|iSCSI target IQN + + +|iscsiEnabled +|boolean +|True +a|Indicates if the volume is used by the iSCSI protocol + + +|isFlexGroupVolume +|boolean +|True +a|Indicates if the volume is a FlexGroup volume + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#VolumeCbsInfo] +[.api-collapsible-fifth-title] +VolumeCbsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalBackups +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-working-environments-.adoc b/cvo/get-gcp-ha-working-environments-.adoc new file mode 100644 index 00000000..8db5f171 --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-.adoc @@ -0,0 +1,2741 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-.html' +summary: 'Retrieve a system' +--- + += Retrieve a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}`# + + + +Retrieves a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#GcpProperties[GcpProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|True +a| + +|haProperties +|link:#GcpHaProperties[GcpHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#labels] +[.api-collapsible-fifth-title] +labels +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#GcpProperties] +[.api-collapsible-fifth-title] +GcpProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|regionName +|string +|False +a| + +|zoneName +|array[string] +|False +a| + +|instanceType +|string +|False +a| + +|subnetCidr +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|projectName +|string +|False +a| + +|deploymentName +|string +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#GcpHaMediatorInfo] +[.api-collapsible-fifth-title] +GcpHaMediatorInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInstanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|version +|string +|False +a| + +|=== + + +[#GcpHaNodeInfo] +[.api-collapsible-fifth-title] +GcpHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|=== + + +[#GcpHaProperties] +[.api-collapsible-fifth-title] +GcpHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInfo +|link:#GcpHaMediatorInfo[GcpHaMediatorInfo] +|False +a| + +|node1Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|node2Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|projectName +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-working-environments-cifs-locks-exist.adoc b/cvo/get-gcp-ha-working-environments-cifs-locks-exist.adoc new file mode 100644 index 00000000..7e5e139d --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-cifs-locks-exist.adoc @@ -0,0 +1,43 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-cifs-locks-exist.html' +summary: 'Check for non-persistent locks held on CIFS sessions' +--- + += Check for non-persistent locks held on CIFS sessions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist`# + + + +Checks for non-persistent locks held on CIFS sessions. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + + diff --git a/cvo/get-gcp-ha-working-environments-cifs.adoc b/cvo/get-gcp-ha-working-environments-cifs.adoc new file mode 100644 index 00000000..f45f3cc8 --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-cifs.adoc @@ -0,0 +1,110 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-cifs.html' +summary: 'Retrieve the CIFS configuration for a system' +--- + += Retrieve the CIFS configuration for a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/cifs`# + + + +Retrieves the CIFS configuration for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svm +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|True +a|DNS domain name + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|authenticationType +|string +|True +a|Authentication type + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "activeDirectoryDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "authenticationType": "string" +} +==== + diff --git a/cvo/get-gcp-ha-working-environments-cost-and-usage.adoc b/cvo/get-gcp-ha-working-environments-cost-and-usage.adoc new file mode 100644 index 00000000..e98bbf30 --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-cost-and-usage.adoc @@ -0,0 +1,241 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-cost-and-usage.html' +summary: 'Retrieve the system cost and usage' +--- + += Retrieve the system cost and usage + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/cost-and-usage`# + + + +Retrieves the system cost and usage. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|start +|string +|query +|False +a| + +|end +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hasPermissions +|boolean +|True +a|Permissions to view the cost and usage details + + +|costByTime +|array[link:#CostByTime[CostByTime]] +|True +a|System cost and usage details + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Money] +[.api-collapsible-fifth-title] +Money + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|True +a|Amount + + +|currency +|string +|True +a|Currency + + +|=== + + +[#Usage] +[.api-collapsible-fifth-title] +Usage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|False +a|Amount + + +|units +|string +|True +a|Units + + +|=== + + +[#CostByUsage] +[.api-collapsible-fifth-title] +CostByUsage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Breakdown element name + + +|cost +|link:#Money[Money] +|True +a| + +|usage +|link:#Usage[Usage] +|True +a| + +|=== + + +[#CostByService] +[.api-collapsible-fifth-title] +CostByService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the cost domain (compute, disk/blob storage, object storage, data transfer) + + +|total +|link:#Money[Money] +|True +a| + +|costByUsage +|array[link:#CostByUsage[CostByUsage]] +|True +a|Cost domain breakdown + + +|=== + + +[#CostByTime] +[.api-collapsible-fifth-title] +CostByTime + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|start +|string +|True +a|Cost period start date + + +|end +|string +|True +a|Cost period end date + + +|estimated +|boolean +|True +a|Indicates whether the cost is estimated + + +|total +|link:#Money[Money] +|True +a| + +|costByService +|array[link:#CostByService[CostByService]] +|True +a|Monthly cost and usage details + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-working-environments-create-request-parameters.adoc b/cvo/get-gcp-ha-working-environments-create-request-parameters.adoc new file mode 100644 index 00000000..6eb53696 --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-create-request-parameters.adoc @@ -0,0 +1,95 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-create-request-parameters.html' +summary: 'Retrieve action parameters' +--- + += Retrieve action parameters + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/create-request-parameters`# + + + +Retrieves the action parameters used in the create request for a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|parameters +|link:#MapStringObject[MapStringObject] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject + + +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject +Hash mapping strings to link:#MapStringObject[MapStringObject] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|True +a| + +|empty +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-working-environments-extra-capacity-licenses.adoc b/cvo/get-gcp-ha-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..6940500f --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-extra-capacity-licenses.html' +summary: 'Retrieve extra capacity licenses' +--- + += Retrieve extra capacity licenses + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Retrieves extra capacity licenses for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serialNumber +|string +|True +a| + +|resourceId +|string +|False +a| + +|licenseType +|string +|False +a| + +|expirationDate +|integer +|True +a| + +|license +|string +|False +a| + +|capacity +|number +|True +a| + +|metadata +|string +|False +a| + +|associatedResourceId +|string +|False +a| + +|licensePackage +|string +|False +a| + +|accountId +|string +|False +a| + +|=== + + diff --git a/cvo/get-gcp-ha-working-environments-license-instance-type.adoc b/cvo/get-gcp-ha-working-environments-license-instance-type.adoc new file mode 100644 index 00000000..bb4fb913 --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-license-instance-type.adoc @@ -0,0 +1,146 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-license-instance-type.html' +summary: 'Retrieve all license types for a system' +--- + += Retrieve all license types for a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/license-instance-type`# + + + +Retrieves all license types and their associated instance types for a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenseType +|string +|True +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|instanceTypes +|array[link:#InstanceTypeInfo[InstanceTypeInfo]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#InstanceTypeInfo] +[.api-collapsible-fifth-title] +InstanceTypeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|False +a| + +|supportsEncryption +|boolean +|True +a| + +|supportedFeatures +|array[string] +|True +a| + +|isDefault +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-working-environments-occm-provided-upgrade-versions.adoc b/cvo/get-gcp-ha-working-environments-occm-provided-upgrade-versions.adoc new file mode 100644 index 00000000..8a6e13f1 --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-occm-provided-upgrade-versions.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-occm-provided-upgrade-versions.html' +summary: 'Retrieve a list of upgrade versions' +--- + += Retrieve a list of upgrade versions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions`# + + + +Retrieves a list of versions to which this Cloud Volumes ONTAP system can be upgraded. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-gcp-ha-working-environments-ontap-available-images.adoc b/cvo/get-gcp-ha-working-environments-ontap-available-images.adoc new file mode 100644 index 00000000..d13e2707 --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-ontap-available-images.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-ontap-available-images.html' +summary: 'Retrieve images already installed on a system' +--- + += Retrieve images already installed on a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/ontap-available-images`# + + + +Retrieves images already installed on the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|version +|string +|False +a| + +|isCurrent +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-gcp-ha-working-environments-ontap-saving.adoc b/cvo/get-gcp-ha-working-environments-ontap-saving.adoc new file mode 100644 index 00000000..00f68707 --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-ontap-saving.adoc @@ -0,0 +1,129 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-ontap-saving.html' +summary: 'Retrieve system ONTAP savings' +--- + += Retrieve system ONTAP savings + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/ontap-saving`# + + + +Retrieves system ONTAP savings. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|savings +|array[link:#SavingsInfo[SavingsInfo]] +|True +a|List of savings + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "savings": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Money] +[.api-collapsible-fifth-title] +Money + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|True +a|Amount + + +|currency +|string +|True +a|Currency + + +|=== + + +[#SavingsInfo] +[.api-collapsible-fifth-title] +SavingsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of saving element + + +|monthlySaving +|link:#Money[Money] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-working-environments-schedules.adoc b/cvo/get-gcp-ha-working-environments-schedules.adoc new file mode 100644 index 00000000..f06b1be6 --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-schedules.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-schedules.html' +summary: 'List the start/stop schedules for Cloud Volumes ONTAP' +--- + += List the start/stop schedules for Cloud Volumes ONTAP + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/schedules`# + + + +Lists the start/stop schedules for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "schedule": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-working-environments-support-registration.adoc b/cvo/get-gcp-ha-working-environments-support-registration.adoc new file mode 100644 index 00000000..259b1485 --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-support-registration.adoc @@ -0,0 +1,101 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-support-registration.html' +summary: 'Retrieve the support registration status' +--- + += Retrieve the support registration status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/support-registration`# + + + +Retrieves the support registration status of a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|licenseStartDate +|link:#licenseStartDate[licenseStartDate] +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "nssAccountId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#licenseStartDate] +[.api-collapsible-fifth-title] +licenseStartDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-working-environments-update-eligibility.adoc b/cvo/get-gcp-ha-working-environments-update-eligibility.adoc new file mode 100644 index 00000000..b2f03046 --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-update-eligibility.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-update-eligibility.html' +summary: 'Retrieve the eligibility support status' +--- + += Retrieve the eligibility support status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/update-eligibility`# + + + +Retrieves the eligibility support status of a Cloud Volumes ONTAP system. Valid values are NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|eligibilityResponse +|string +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "eligibilityResponse": "string" +} +==== + diff --git a/cvo/get-gcp-ha-working-environments-user-tags.adoc b/cvo/get-gcp-ha-working-environments-user-tags.adoc new file mode 100644 index 00000000..624f0ae0 --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-user-tags.adoc @@ -0,0 +1,104 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-user-tags.html' +summary: 'Retrieve editable tags for cloud resources' +--- + += Retrieve editable tags for cloud resources + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/user-tags`# + + + +Retrieves the editable tags for the cloud resources in a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tags +|array[link:#CloudResourceTag[CloudResourceTag]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tags": [ + { + "tagKey": "string", + "tagValue": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudResourceTag] +[.api-collapsible-fifth-title] +CloudResourceTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|True +a| + +|tagValue +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-working-environments-validate-byol-to-capacity.adoc b/cvo/get-gcp-ha-working-environments-validate-byol-to-capacity.adoc new file mode 100644 index 00000000..dbb3d95a --- /dev/null +++ b/cvo/get-gcp-ha-working-environments-validate-byol-to-capacity.adoc @@ -0,0 +1,214 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments-validate-byol-to-capacity.html' +summary: 'Validate prerequisites for converting a system' +--- + += Validate prerequisites for converting a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity`# + + + +Validates the prerequisites for converting an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|validAccount +|boolean +|True +a| + +|validNss +|boolean +|False +a| + +|mpSub +|array[link:#CloudAccountResponse[CloudAccountResponse]] +|True +a| + +|capacityLicenses +|array[link:#CapacityLicenseInfo[CapacityLicenseInfo]] +|True +a| + +|totalPrimaryVolumes +|link:#Capacity[Capacity] +|True +a| + +|totalDpVolumes +|link:#Capacity[Capacity] +|False +a| + +|vmPlan +|string +|False +a| + +|awsOldDeployment +|boolean +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudAccountResponse] +[.api-collapsible-fifth-title] +CloudAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudAccountId +|string +|True +a| + +|provider +|string +|False +a| + +|subscriptionId +|string +|False +a| + +|=== + + +[#TotalCapacity] +[.api-collapsible-fifth-title] +TotalCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacity +|integer +|True +a| + +|units +|string +|False +a| + +|=== + + +[#CapacityLicenseInfo] +[.api-collapsible-fifth-title] +CapacityLicenseInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|flavorType +|string +|False +a| + +|contractType +|string +|False +a| + +|totalLicensedCapacity +|link:#TotalCapacity[TotalCapacity] +|True +a| + +|totalConsumedCapacity +|link:#TotalCapacity[TotalCapacity] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-ha-working-environments.adoc b/cvo/get-gcp-ha-working-environments.adoc new file mode 100644 index 00000000..c837065a --- /dev/null +++ b/cvo/get-gcp-ha-working-environments.adoc @@ -0,0 +1,2741 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-ha-working-environments.html' +summary: 'Retrieve Cloud Volumes ONTAP systems' +--- + += Retrieve Cloud Volumes ONTAP systems + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/ha/working-environments`# + + + +Retrieves Cloud Volumes ONTAP systems visible to the current user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|tenantId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#GcpProperties[GcpProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|True +a| + +|haProperties +|link:#GcpHaProperties[GcpHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#labels] +[.api-collapsible-fifth-title] +labels +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#GcpProperties] +[.api-collapsible-fifth-title] +GcpProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|regionName +|string +|False +a| + +|zoneName +|array[string] +|False +a| + +|instanceType +|string +|False +a| + +|subnetCidr +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|projectName +|string +|False +a| + +|deploymentName +|string +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#GcpHaMediatorInfo] +[.api-collapsible-fifth-title] +GcpHaMediatorInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInstanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|version +|string +|False +a| + +|=== + + +[#GcpHaNodeInfo] +[.api-collapsible-fifth-title] +GcpHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|=== + + +[#GcpHaProperties] +[.api-collapsible-fifth-title] +GcpHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInfo +|link:#GcpHaMediatorInfo[GcpHaMediatorInfo] +|False +a| + +|node1Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|node2Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|projectName +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-aggregates-.adoc b/cvo/get-gcp-vsa-aggregates-.adoc new file mode 100644 index 00000000..c627f370 --- /dev/null +++ b/cvo/get-gcp-vsa-aggregates-.adoc @@ -0,0 +1,404 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-aggregates-.html' +summary: 'Retrieve aggregates' +--- + += Retrieve aggregates + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/aggregates/{workingEnvironmentId}`# + + + +Retrieves aggregates. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Aggregate name + + +|availableCapacity +|link:#Capacity[Capacity] +|True +a| + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|usedCapacity +|link:#Capacity[Capacity] +|True +a| + +|volumes +|array[link:#Volume[Volume]] +|True +a|Volumes + + +|providerVolumes +|array[link:#ProviderVolumeResponse[ProviderVolumeResponse]] +|True +a|Provider volumes + + +|disks +|array[link:#Disk[Disk]] +|True +a|Disks + + +|state +|string +|False +a|State + + +|encryptionType +|string +|True +a|Encryption Type + + +|encryptionKeyId +|string +|False +a|Encryption Key + + +|isRoot +|boolean +|True +a|Is Root + + +|homeNode +|string +|True +a|Home node + + +|ownerNode +|string +|False +a|Owner node + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsed +|link:#Capacity[Capacity] +|False +a| + +|sidlEnabled +|boolean +|True +a|SIDL enabled + + +|snaplockType +|string +|True +a|Snaplock type + + +|evCompatibilityType +|string +|True +a|Elastic Volume Compatibility Type + + +|iops +|link:#iops[iops] +|False +a|Aggregate IOPS + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Volume] +[.api-collapsible-fifth-title] +Volume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|totalSize +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioned +|boolean +|True +a|Indicates if the volume is thin-provisioned + + +|isClone +|boolean +|True +a|Indicates if the volume is a clone volume + + +|rootVolume +|boolean +|True +a|Indicates if the volume is the root volume of the SVM + + +|=== + + +[#ProviderVolumeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Specifies the ID + + +|name +|string +|True +a|Specifies the name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|state +|string +|True +a|State + + +|device +|string +|True +a|Device + + +|instanceId +|string +|True +a|InstanceId + + +|diskType +|string +|True +a|Type + + +|encrypted +|boolean +|True +a|Encrypted + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|instance2Id +|string +|False +a|Instance2Id + + +|=== + + +[#VmDiskProperties] +[.api-collapsible-fifth-title] +VmDiskProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectName +|string +|False +a| + +|storageAccountName +|string +|False +a| + +|containerName +|string +|False +a| + +|=== + + +[#Disk] +[.api-collapsible-fifth-title] +Disk + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Name + + +|containerType +|string +|True +a|Container type + + +|ownerNode +|string +|True +a|Owner node + + +|device +|string +|False +a|Device + + +|vmDiskProperties +|link:#VmDiskProperties[VmDiskProperties] +|False +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + +Aggregate IOPS + + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-discover.adoc b/cvo/get-gcp-vsa-discover.adoc new file mode 100644 index 00000000..2033f569 --- /dev/null +++ b/cvo/get-gcp-vsa-discover.adoc @@ -0,0 +1,108 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-discover.html' +summary: 'Retrieve a list of systems for a Google Cloud zone' +--- + += Retrieve a list of systems for a Google Cloud zone + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/discover`# + + + +Retrieves a list of discovered systems visible to the current user in the specified Google Cloud zone. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|project +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|id +|string +|False +a| + +|publicId +|string +|False +a| + +|zone +|string +|False +a| + +|vnetName +|string +|False +a| + +|vnetId +|string +|False +a| + +|projectName +|string +|False +a| + +|subnetName +|string +|False +a| + +|clusterAddress +|string +|False +a| + +|recoverable +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-gcp-vsa-metadata-buckets.adoc b/cvo/get-gcp-vsa-metadata-buckets.adoc new file mode 100644 index 00000000..9156b656 --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-buckets.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-buckets.html' +summary: 'Retrieve all cloud storage buckets' +--- + += Retrieve all cloud storage buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/buckets`# + + + +Retrieves all cloud storage buckets. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|projectId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|location +|string +|False +a| + +|storageClass +|string +|False +a| + +|kmsKeyName +|string +|False +a| + +|labels +|link:#MapStringString[MapStringString] +|True +a|Instance tags + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#MapStringString] +[.api-collapsible-fifth-title] +MapStringString + +Instance tags + +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-metadata-default-snapshot-policies.adoc b/cvo/get-gcp-vsa-metadata-default-snapshot-policies.adoc new file mode 100644 index 00000000..4df26895 --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-default-snapshot-policies.adoc @@ -0,0 +1,100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-default-snapshot-policies.html' +summary: 'Retrieve default snapshot policies' +--- + += Retrieve default snapshot policies + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/default-snapshot-policies`# + + + +Retrieves the default snapshot policies available on a cluster. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "schedules": [ + {} + ], + "description": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-metadata-gcp-disk-types.adoc b/cvo/get-gcp-vsa-metadata-gcp-disk-types.adoc new file mode 100644 index 00000000..8fa8f2f6 --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-gcp-disk-types.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-gcp-disk-types.html' +summary: 'Retrieve the supported Google Cloud disk types' +--- + += Retrieve the supported Google Cloud disk types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/gcp-disk-types`# + + + +Retrieves the supported Google Cloud disk types. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|True +a| + +|supportedDiskTypes +|array[string] +|True +a| + +|supportedOccmLicenses +|array[string] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-metadata-gcp-encryption-keys.adoc b/cvo/get-gcp-vsa-metadata-gcp-encryption-keys.adoc new file mode 100644 index 00000000..0ad39b32 --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-gcp-encryption-keys.adoc @@ -0,0 +1,90 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-gcp-encryption-keys.html' +summary: 'Retrieve Google Cloud encryption keys for a region' +--- + += Retrieve Google Cloud encryption keys for a region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/gcp-encryption-keys`# + + + +Retrieves Google Cloud encryption keys for a specific region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|project +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|id +|string +|False +a| + +|keyRing +|string +|False +a| + +|location +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "id": "string", + "keyRing": "string", + "location": "string" +} +==== + diff --git a/cvo/get-gcp-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc b/cvo/get-gcp-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc new file mode 100644 index 00000000..9026e6c9 --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html' +summary: 'Retrieve the instance types that do not support acceleration and capacity tiering' +--- + += Retrieve the instance types that do not support acceleration and capacity tiering + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering`# + + + +Retrieves the instance types that do not support acceleration and capacity tiering. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceTypes +|array[link:#InstanceTypeResponse[InstanceTypeResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceTypes": [ + { + "instanceType": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#InstanceTypeResponse] +[.api-collapsible-fifth-title] +InstanceTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-metadata-network-requirements.adoc b/cvo/get-gcp-vsa-metadata-network-requirements.adoc new file mode 100644 index 00000000..6096c565 --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-network-requirements.adoc @@ -0,0 +1,44 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-network-requirements.html' +summary: 'Retrieve the minimum number of IP addresses for a system' +--- + += Retrieve the minimum number of IP addresses for a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/network-requirements`# + + + +Retrieves the minimum number of required IP addresses for a Cloud Volumes ONTAP system. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vsaMinimumRequiredIps +|integer +|True +a| + +|haVsaMinimumRequiredIps +|integer +|False +a| + +|=== + + diff --git a/cvo/get-gcp-vsa-metadata-packages.adoc b/cvo/get-gcp-vsa-metadata-packages.adoc new file mode 100644 index 00000000..5e0120d6 --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-packages.adoc @@ -0,0 +1,187 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-packages.html' +summary: 'Retrieve the packages configuration' +--- + += Retrieve the packages configuration + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/packages`# + + + +Retrieves the packages configuration. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|deploymentModel +|string +|query +|False +a| + +|capacityPackage +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|displayName +|string +|False +a| + +|description +|string +|False +a| + +|licenseType +|string +|False +a| + +|instanceTypeMapping +|array[link:#InstanceTypeRegionMapping[InstanceTypeRegionMapping]] +|True +a| + +|diskType +|string +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|capacityTier +|string +|False +a| + +|instanceTenancy +|string +|False +a| + +|writingSpeedState +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|throughput +|link:#throughput[throughput] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#InstanceTypeRegionMapping] +[.api-collapsible-fifth-title] +InstanceTypeRegionMapping + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|False +a| + +|instanceType +|string +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#throughput] +[.api-collapsible-fifth-title] +throughput + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-metadata-permutations.adoc b/cvo/get-gcp-vsa-metadata-permutations.adoc new file mode 100644 index 00000000..309b3f3f --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-permutations.adoc @@ -0,0 +1,197 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-permutations.html' +summary: 'Retrieve all Cloud Volumes ONTAP configurations' +--- + += Retrieve all Cloud Volumes ONTAP configurations + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/permutations`# + + + +Retrieves all Cloud Volumes ONTAP configurations. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a| + +|license +|link:#OntapLicenseType[OntapLicenseType] +|True +a| + +|instanceType +|string +|False +a| + +|region +|link:#Region[Region] +|True +a| + +|defaultInstance +|boolean +|False +a| + +|features +|array[string] +|True +a| + +|upgradeableFrom +|array[string] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#Region] +[.api-collapsible-fifth-title] +Region + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|code +|string +|False +a| + +|location +|string +|False +a| + +|s3Region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-metadata-projects.adoc b/cvo/get-gcp-vsa-metadata-projects.adoc new file mode 100644 index 00000000..8e1c2f7e --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-projects.adoc @@ -0,0 +1,137 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-projects.html' +summary: 'Retrieve a list of projects' +--- + += Retrieve a list of projects + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/projects`# + + + +Retrieves a list of projects for which the user has permission. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|projects +|array[link:#GcpProjectResponse[GcpProjectResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "projects": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parent] +[.api-collapsible-fifth-title] +parent +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#GcpProjectResponse] +[.api-collapsible-fifth-title] +GcpProjectResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isDefault +|boolean +|True +a| + +|projectNumber +|string +|True +a| + +|projectId +|string +|False +a| + +|lifecycleState +|string +|False +a| + +|name +|string +|False +a| + +|createTime +|string +|False +a| + +|parent +|link:#parent[parent] +|True +a| + +|subscriptionId +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-metadata-regions.adoc b/cvo/get-gcp-vsa-metadata-regions.adoc new file mode 100644 index 00000000..58f8fa40 --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-regions.adoc @@ -0,0 +1,292 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-regions.html' +summary: 'Retrieve Google Cloud regions' +--- + += Retrieve Google Cloud regions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/regions`# + + + +Retrieves Google Cloud regions where a Cloud Volumes ONTAP system can be created. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project +|string +|query +|False +a| + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|displayName +|string +|True +a| + +|name +|string +|False +a| + +|zones +|array[link:#GcpZoneResponse[GcpZoneResponse]] +|True +a| + +|vpcs +|array[link:#GcpVirtualNetworkResponse[GcpVirtualNetworkResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "displayName": "string", + "name": "string", + "zones": [ + { + "name": "string" + } + ], + "vpcs": [ + { + "name": "string", + "subnets": [ + {} + ], + "firewalls": [ + { + "name": "string", + "vpc": "string", + "targetServiceAccount": [ + "string" + ] + } + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#GcpZoneResponse] +[.api-collapsible-fifth-title] +GcpZoneResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Zone Name + + +|=== + + +[#GcpSubnetResponse] +[.api-collapsible-fifth-title] +GcpSubnetResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ipCidrRange +|string +|True +a|Classless Inter-Domain Routing (CIDR) + + +|name +|string +|True +a|Subnet name + + +|path +|string +|True +a|Subnet path + + +|availableIps +|integer +|True +a|The number of available IP addresses on the subnet + + +|minimumRequiredIps +|integer +|True +a|The minimum needed IP addresses for the Cloud Volumes ONTAP system creation + +* format: int32 + + +|=== + + +[#GcpFirewallResponse] +[.api-collapsible-fifth-title] +GcpFirewallResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Firewall Name + + +|vpc +|string +|True +a|VPC + + +|targetServiceAccount +|array[string] +|True +a|Target Service Account + + +|=== + + +[#GcpVirtualNetworkResponse] +[.api-collapsible-fifth-title] +GcpVirtualNetworkResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Virtual Network Name + + +|subnets +|array[link:#GcpSubnetResponse[GcpSubnetResponse]] +|True +a|Subnets + + +|firewalls +|array[link:#GcpFirewallResponse[GcpFirewallResponse]] +|True +a|Firewalls + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-metadata-service-accounts.adoc b/cvo/get-gcp-vsa-metadata-service-accounts.adoc new file mode 100644 index 00000000..2bc79410 --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-service-accounts.adoc @@ -0,0 +1,116 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-service-accounts.html' +summary: 'Retrieve a list of service accounts' +--- + += Retrieve a list of service accounts + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/service-accounts`# + + + +Retrieves a list of Service Accounts from the project. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accounts +|array[link:#GcpServiceAccountResponse[GcpServiceAccountResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accounts": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#GcpServiceAccountResponse] +[.api-collapsible-fifth-title] +GcpServiceAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|projectId +|string +|False +a| + +|email +|string +|False +a| + +|displayName +|string +|False +a| + +|isEnabled +|boolean +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-metadata-supported-capacity-tiers.adoc b/cvo/get-gcp-vsa-metadata-supported-capacity-tiers.adoc new file mode 100644 index 00000000..2994ded5 --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-supported-capacity-tiers.adoc @@ -0,0 +1,156 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-supported-capacity-tiers.html' +summary: 'Retrieve supported capacity tiers for Google Cloud disk types' +--- + += Retrieve supported capacity tiers for Google Cloud disk types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/supported-capacity-tiers`# + + + +Retrieves the supported capacity tiers for Google Cloud disk types. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|ontapVersion +|string +|query +|False +a| + +|dataEncryptionType +|string +|query +|False +a| + +|licenseType +|string +|query +|False +a| + +|instanceType +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-metadata-supported-features.adoc b/cvo/get-gcp-vsa-metadata-supported-features.adoc new file mode 100644 index 00000000..51808661 --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-supported-features.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-supported-features.html' +summary: 'Retrieve supported features' +--- + += Retrieve supported features + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/supported-features`# + + + +Retrieves the supported features. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|ontapVersion +|string +|query +|False +a| + +|dataEncryptionType +|string +|query +|False +a| + +|licenseType +|string +|query +|False +a| + +|instanceType +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|wormSupportedVersion +|boolean +|True +a| + +|cbsSupportedVersion +|boolean +|False +a| + +|httpsStorageAccountSupportedVersion +|boolean +|False +a| + +|tieringWithServiceAccount +|boolean +|False +a| + +|s3CmkEncryptionSupportedVersion +|boolean +|False +a| + +|gp3SupportedVersion +|boolean +|False +a| + +|elasticVolumeSupportedAndEnabled +|boolean +|False +a| + +|wormWithComposeSupported +|boolean +|False +a| + +|isAzureFlashcacheSupported +|boolean +|False +a| + +|wormWithBackupSupported +|boolean +|False +a| + +|azureHaManagedDisksSupported +|boolean +|False +a| + +|awsLocalZones +|boolean +|False +a| + +|isAzureZonalSupported +|boolean +|False +a| + +|=== + + diff --git a/cvo/get-gcp-vsa-metadata-tag-keys.adoc b/cvo/get-gcp-vsa-metadata-tag-keys.adoc new file mode 100644 index 00000000..2db2c45d --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-tag-keys.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-tag-keys.html' +summary: 'Retrieve all the labels for a project ID and zone' +--- + += Retrieve all the labels for a project ID and zone + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/tag-keys`# + + + +Retrieves all of the labels for the specific project ID and zone. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|projectId +|string +|query +|False +a| + +|zone +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a| + +|values +|array[string] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "key": "string", + "values": [ + "string" + ] +} +==== + diff --git a/cvo/get-gcp-vsa-metadata-workerpools.adoc b/cvo/get-gcp-vsa-metadata-workerpools.adoc new file mode 100644 index 00000000..1381aa90 --- /dev/null +++ b/cvo/get-gcp-vsa-metadata-workerpools.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-metadata-workerpools.html' +summary: 'Retrieve Google Cloud worker pools for a Cloud Volumes ONTAP system' +--- + += Retrieve Google Cloud worker pools for a Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/metadata/workerPools`# + + + +Retrieves Google Cloud worker pools using Infrastructure Manager (IM) in which a private mode Cloud Volumes ONTAP system can be created. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project +|string +|query +|False +a|The project ID to use for the request + + +|region +|string +|query +|True +a|The region in which to list worker pools + + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|True +a| + +|defined +|boolean +|False +a| + +|=== + + diff --git a/cvo/get-gcp-vsa-volumes--snapshots.adoc b/cvo/get-gcp-vsa-volumes--snapshots.adoc new file mode 100644 index 00000000..bf84b7b2 --- /dev/null +++ b/cvo/get-gcp-vsa-volumes--snapshots.adoc @@ -0,0 +1,79 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-volumes--snapshots.html' +summary: 'Retrieve a list of snapshot descriptions for a volume' +--- + += Retrieve a list of snapshot descriptions for a volume + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots`# + + + +Returns a list of snapshot descriptions for the volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|accessTime +|integer +|True +a| + +|label +|string +|False +a| + +|=== + + diff --git a/cvo/get-gcp-vsa-volumes-igroups-.adoc b/cvo/get-gcp-vsa-volumes-igroups-.adoc new file mode 100644 index 00000000..dae5a0d8 --- /dev/null +++ b/cvo/get-gcp-vsa-volumes-igroups-.adoc @@ -0,0 +1,219 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-volumes-igroups-.html' +summary: 'Retrieve all igroups' +--- + += Retrieve all igroups + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/volumes/igroups/{workingEnvironmentId}/{svmName}`# + + + +Retrieves all igroups. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|igroupName +|string +|True +a| + +|osType +|string +|False +a| + +|portsetName +|string +|False +a| + +|igroupType +|string +|True +a| + +|initiators +|array[string] +|True +a| + +|lunMaps +|array[link:#LunMapsLun[LunMapsLun]] +|True +a| + +|initiatorsWithConnStatus +|array[link:#InitiatorsConnectivityStateNameObject[InitiatorsConnectivityStateNameObject]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "igroupName": "string", + "osType": "string", + "portsetName": "string", + "igroupType": "string", + "initiators": [ + "string" + ], + "lunMaps": [ + { + "lun": { + "name": "string", + "uuid": "string" + } + } + ], + "initiatorsWithConnStatus": [ + { + "connectivity_tracking": { + "connection_state": "string" + }, + "name": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#NameUuidObject] +[.api-collapsible-fifth-title] +NameUuidObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|uuid +|string +|False +a| + +|=== + + +[#LunMapsLun] +[.api-collapsible-fifth-title] +LunMapsLun + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lun +|link:#NameUuidObject[NameUuidObject] +|True +a| + +|=== + + +[#ConnectionState] +[.api-collapsible-fifth-title] +ConnectionState + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connection_state +|string +|False +a| + +|=== + + +[#InitiatorsConnectivityStateNameObject] +[.api-collapsible-fifth-title] +InitiatorsConnectivityStateNameObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connectivity_tracking +|link:#ConnectionState[ConnectionState] +|True +a| + +|name +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-volumes-initiator.adoc b/cvo/get-gcp-vsa-volumes-initiator.adoc new file mode 100644 index 00000000..eac61366 --- /dev/null +++ b/cvo/get-gcp-vsa-volumes-initiator.adoc @@ -0,0 +1,56 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-volumes-initiator.html' +summary: 'Retrieve all iSCSI initiators' +--- + += Retrieve all iSCSI initiators + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/volumes/initiator`# + + + +Retrieves all iSCSI initiators. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + diff --git a/cvo/get-gcp-vsa-volumes-volumes-for-backup.adoc b/cvo/get-gcp-vsa-volumes-volumes-for-backup.adoc new file mode 100644 index 00000000..b68a7bd6 --- /dev/null +++ b/cvo/get-gcp-vsa-volumes-volumes-for-backup.adoc @@ -0,0 +1,288 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-volumes-volumes-for-backup.html' +summary: 'Retrieve volumes for backup activation' +--- + += Retrieve volumes for backup activation + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/volumes/volumes-for-backup`# + + + +Retrieves all volumes for backup activation. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|offset +|integer +|query +|False +a| + +|limit +|integer +|query +|False +a| + +|search +|string +|query +|False +a| + +|filterBy +|link:#ListFilterByParam[ListFilterByParam] +|query +|False +a| + +|sortBy +|link:#ListSortByParam[ListSortByParam] +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumes +|array[link:#VolumeForBackupResponse[VolumeForBackupResponse]] +|True +a| + +|totalNumberOfVolumes +|integer +|True +a| + +|filteredNumberOfVolumes +|link:#filteredNumberOfVolumes[filteredNumberOfVolumes] +|False +a| + +|hasNextPage +|link:#hasNextPage[hasNextPage] +|False +a| + +|allowedValuesForVolumesListFilter +|link:#AllowedValuesForVolumesListFilter[AllowedValuesForVolumesListFilter] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ListFilterByParam] +[.api-collapsible-fifth-title] +ListFilterByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#ListSortByParam] +[.api-collapsible-fifth-title] +ListSortByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeForBackupResponse] +[.api-collapsible-fifth-title] +VolumeForBackupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|uuid +|string +|False +a| + +|svmName +|string +|False +a| + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|False +a| + +|state +|string +|False +a| + +|providerVolumeType +|string +|False +a| + +|volumeType +|string +|False +a| + +|isBackupOn +|boolean +|True +a| + +|disableReasonBackup +|array[string] +|True +a| + +|=== + + +[#filteredNumberOfVolumes] +[.api-collapsible-fifth-title] +filteredNumberOfVolumes + + +[#hasNextPage] +[.api-collapsible-fifth-title] +hasNextPage + + +[#AllowedValuesForVolumesListFilter] +[.api-collapsible-fifth-title] +AllowedValuesForVolumesListFilter + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeTypes +|array[string] +|False +a| + +|diskTypes +|array[string] +|False +a| + +|svmNames +|array[string] +|False +a| + +|volumeStatus +|array[string] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-volumes.adoc b/cvo/get-gcp-vsa-volumes.adoc new file mode 100644 index 00000000..1875bc38 --- /dev/null +++ b/cvo/get-gcp-vsa-volumes.adoc @@ -0,0 +1,550 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-volumes.html' +summary: 'Retrieve volumes' +--- + += Retrieve volumes + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/volumes`# + + + +Retrieves all volumes. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Volume name + + +|uuid +|string +|True +a|Volume UUID + + +|svmName +|string +|True +a|Volume SVM name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|junctionPath +|string +|True +a|The junction path at which this volume is mounted + + +|volumeTotalInodes +|integer +|False +a|Total volume inodes size + + +|volumeUsedInodes +|integer +|False +a|Used volume inodes size + + +|mountPoint +|string +|False +a|Mount Point + + +|compressionSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|deduplicationSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioning +|boolean +|True +a|Specifies whether thin provisioning is enabled + + +|compression +|boolean +|True +a|Specifies whether compression is enabled + + +|deduplication +|boolean +|True +a|Specifies whether deduplication is enabled + + +|snapshotPolicy +|string +|True +a|The name of the snapshot policy + + +|securityStyle +|string +|True +a|The type of the security style + + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|True +a| + +|shareNames +|array[string] +|True +a|The share names for CIFS + + +|shareInfo +|array[link:#CifsShareInfo[CifsShareInfo]] +|True +a|The share names, permissions, and users for CIFS + + +|parentVolumeName +|string +|True +a|Name of the parent flexible volume for the clone + + +|rootVolume +|boolean +|True +a|Flag to indicate if the volume is a SVM root + + +|state +|string +|True +a|Volume state + + +|volumeType +|string +|True +a|Volume type + + +|aggregateName +|string +|True +a|Aggregate name + + +|parentSnapshot +|string +|False +a|The snapshot name the volume is based on + + +|autoSizeMode +|string +|True +a|The operating mode of autosize + + +|maxGrowSize +|link:#Capacity[Capacity] +|True +a| + +|providerVolumeType +|string +|False +a|Cloud provider volume type + + +|cloneNames +|array[string] +|True +a|Names of cloned copies of the volume + + +|moving +|boolean +|True +a|Specifies if the volume move process is in progress + + +|primaryNoFailoverMountPoint +|string +|False +a|Primary mount point without failover + + +|secondaryNoFailoverMountPoint +|string +|False +a|Secondary mount point without failover + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cifsShareAccessPoint +|string +|False +a|CIFS share access point + + +|primaryCifsShareAccessPoint +|string +|False +a|Primary CIFS share access point + + +|secondaryCifsShareAccessPoint +|string +|False +a|Secondary CIFS share access point + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|tierInactiveUserData +|link:#Capacity[Capacity] +|False +a| + +|tierInactiveUserDataPercent +|integer +|False +a|Tier inactive user data percentage + + +|comment +|string +|False +a|Volume comment + + +|qosPolicyGroupName +|string +|False +a|Quality of service policy group name + + +|snaplockType +|string +|False +a|SnapLock type + + +|constituentsAggregates +|array[string] +|True +a|Aggregates which are used for FlexGroup constituents + + +|snapshotsUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cbsBackupsInfo +|link:#VolumeCbsInfo[VolumeCbsInfo] +|False +a| + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|targetName +|string +|True +a|iSCSI target IQN + + +|iscsiEnabled +|boolean +|True +a|Indicates if the volume is used by the iSCSI protocol + + +|isFlexGroupVolume +|boolean +|True +a|Indicates if the volume is a FlexGroup volume + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#VolumeCbsInfo] +[.api-collapsible-fifth-title] +VolumeCbsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalBackups +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-working-environments-.adoc b/cvo/get-gcp-vsa-working-environments-.adoc new file mode 100644 index 00000000..87ccc71a --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-.adoc @@ -0,0 +1,2741 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-.html' +summary: 'Retrieve a Cloud Volumes ONTAP system' +--- + += Retrieve a Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}`# + + + +Retrieves a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#GcpProperties[GcpProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|True +a| + +|haProperties +|link:#GcpHaProperties[GcpHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#labels] +[.api-collapsible-fifth-title] +labels +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#GcpProperties] +[.api-collapsible-fifth-title] +GcpProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|regionName +|string +|False +a| + +|zoneName +|array[string] +|False +a| + +|instanceType +|string +|False +a| + +|subnetCidr +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|projectName +|string +|False +a| + +|deploymentName +|string +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#GcpHaMediatorInfo] +[.api-collapsible-fifth-title] +GcpHaMediatorInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInstanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|version +|string +|False +a| + +|=== + + +[#GcpHaNodeInfo] +[.api-collapsible-fifth-title] +GcpHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|=== + + +[#GcpHaProperties] +[.api-collapsible-fifth-title] +GcpHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInfo +|link:#GcpHaMediatorInfo[GcpHaMediatorInfo] +|False +a| + +|node1Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|node2Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|projectName +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-working-environments-cifs.adoc b/cvo/get-gcp-vsa-working-environments-cifs.adoc new file mode 100644 index 00000000..8db02ecb --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-cifs.adoc @@ -0,0 +1,110 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-cifs.html' +summary: 'Retrieve a CIFS configuration' +--- + += Retrieve a CIFS configuration + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/cifs`# + + + +Retrieves the CIFS configuration for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svm +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|True +a|DNS domain name + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|authenticationType +|string +|True +a|Authentication type + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "activeDirectoryDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "authenticationType": "string" +} +==== + diff --git a/cvo/get-gcp-vsa-working-environments-cost-and-usage.adoc b/cvo/get-gcp-vsa-working-environments-cost-and-usage.adoc new file mode 100644 index 00000000..aa645603 --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-cost-and-usage.adoc @@ -0,0 +1,241 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-cost-and-usage.html' +summary: 'Retrieve system cost and usage' +--- + += Retrieve system cost and usage + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/cost-and-usage`# + + + +Retrieves the system cost and usage. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|start +|string +|query +|False +a| + +|end +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hasPermissions +|boolean +|True +a|Permissions to view the cost and usage details + + +|costByTime +|array[link:#CostByTime[CostByTime]] +|True +a|System cost and usage details + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Money] +[.api-collapsible-fifth-title] +Money + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|True +a|Amount + + +|currency +|string +|True +a|Currency + + +|=== + + +[#Usage] +[.api-collapsible-fifth-title] +Usage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|False +a|Amount + + +|units +|string +|True +a|Units + + +|=== + + +[#CostByUsage] +[.api-collapsible-fifth-title] +CostByUsage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Breakdown element name + + +|cost +|link:#Money[Money] +|True +a| + +|usage +|link:#Usage[Usage] +|True +a| + +|=== + + +[#CostByService] +[.api-collapsible-fifth-title] +CostByService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the cost domain (compute, disk/blob storage, object storage, data transfer) + + +|total +|link:#Money[Money] +|True +a| + +|costByUsage +|array[link:#CostByUsage[CostByUsage]] +|True +a|Cost domain breakdown + + +|=== + + +[#CostByTime] +[.api-collapsible-fifth-title] +CostByTime + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|start +|string +|True +a|Cost period start date + + +|end +|string +|True +a|Cost period end date + + +|estimated +|boolean +|True +a|Indicates whether the cost is estimated + + +|total +|link:#Money[Money] +|True +a| + +|costByService +|array[link:#CostByService[CostByService]] +|True +a|Monthly cost and usage details + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-working-environments-create-request-parameters.adoc b/cvo/get-gcp-vsa-working-environments-create-request-parameters.adoc new file mode 100644 index 00000000..cba79a9d --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-create-request-parameters.adoc @@ -0,0 +1,95 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-create-request-parameters.html' +summary: 'Retrieve the action parameters' +--- + += Retrieve the action parameters + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/create-request-parameters`# + + + +Retrieves the action parameters used in the create request for a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|parameters +|link:#MapStringObject[MapStringObject] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject + + +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject +Hash mapping strings to link:#MapStringObject[MapStringObject] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|True +a| + +|empty +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-working-environments-extra-capacity-licenses.adoc b/cvo/get-gcp-vsa-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..9f237cca --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-extra-capacity-licenses.html' +summary: 'Retrieve extra capacity licenses' +--- + += Retrieve extra capacity licenses + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Retrieves extra capacity licenses for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serialNumber +|string +|True +a| + +|resourceId +|string +|False +a| + +|licenseType +|string +|False +a| + +|expirationDate +|integer +|True +a| + +|license +|string +|False +a| + +|capacity +|number +|True +a| + +|metadata +|string +|False +a| + +|associatedResourceId +|string +|False +a| + +|licensePackage +|string +|False +a| + +|accountId +|string +|False +a| + +|=== + + diff --git a/cvo/get-gcp-vsa-working-environments-license-instance-type.adoc b/cvo/get-gcp-vsa-working-environments-license-instance-type.adoc new file mode 100644 index 00000000..e5b28a9b --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-license-instance-type.adoc @@ -0,0 +1,146 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-license-instance-type.html' +summary: 'Retrieve all license types and their associated instance types' +--- + += Retrieve all license types and their associated instance types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/license-instance-type`# + + + +Retrieves all license types and their associated instance types for a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenseType +|string +|True +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|instanceTypes +|array[link:#InstanceTypeInfo[InstanceTypeInfo]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#InstanceTypeInfo] +[.api-collapsible-fifth-title] +InstanceTypeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|False +a| + +|supportsEncryption +|boolean +|True +a| + +|supportedFeatures +|array[string] +|True +a| + +|isDefault +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-working-environments-occm-provided-upgrade-versions.adoc b/cvo/get-gcp-vsa-working-environments-occm-provided-upgrade-versions.adoc new file mode 100644 index 00000000..639fea80 --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-occm-provided-upgrade-versions.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-occm-provided-upgrade-versions.html' +summary: 'Retrieve a list of upgrade versions' +--- + += Retrieve a list of upgrade versions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions`# + + + +Retrieves a list of versions to which this Cloud Volumes ONTAP system can be upgraded. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-gcp-vsa-working-environments-ontap-available-images.adoc b/cvo/get-gcp-vsa-working-environments-ontap-available-images.adoc new file mode 100644 index 00000000..1fcfd934 --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-ontap-available-images.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-ontap-available-images.html' +summary: 'Retrieve images already installed' +--- + += Retrieve images already installed + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/ontap-available-images`# + + + +Retrieves images already installed on the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|version +|string +|False +a| + +|isCurrent +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-gcp-vsa-working-environments-ontap-saving.adoc b/cvo/get-gcp-vsa-working-environments-ontap-saving.adoc new file mode 100644 index 00000000..bf5a2369 --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-ontap-saving.adoc @@ -0,0 +1,129 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-ontap-saving.html' +summary: 'Retrieve system ONTAP savings' +--- + += Retrieve system ONTAP savings + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/ontap-saving`# + + + +Retrieves system ONTAP savings. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|savings +|array[link:#SavingsInfo[SavingsInfo]] +|True +a|List of savings + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "savings": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Money] +[.api-collapsible-fifth-title] +Money + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|True +a|Amount + + +|currency +|string +|True +a|Currency + + +|=== + + +[#SavingsInfo] +[.api-collapsible-fifth-title] +SavingsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of saving element + + +|monthlySaving +|link:#Money[Money] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-working-environments-schedules.adoc b/cvo/get-gcp-vsa-working-environments-schedules.adoc new file mode 100644 index 00000000..d26bfa0e --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-schedules.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-schedules.html' +summary: 'List the start/stop schedules' +--- + += List the start/stop schedules + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/schedules`# + + + +Lists the start/stop schedules for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "schedule": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-working-environments-support-registration.adoc b/cvo/get-gcp-vsa-working-environments-support-registration.adoc new file mode 100644 index 00000000..09778125 --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-support-registration.adoc @@ -0,0 +1,101 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-support-registration.html' +summary: 'Retrieve the registration support status' +--- + += Retrieve the registration support status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/support-registration`# + + + +Retrieves the support registration status of a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|licenseStartDate +|link:#licenseStartDate[licenseStartDate] +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "nssAccountId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#licenseStartDate] +[.api-collapsible-fifth-title] +licenseStartDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-working-environments-update-eligibility.adoc b/cvo/get-gcp-vsa-working-environments-update-eligibility.adoc new file mode 100644 index 00000000..c662989f --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-update-eligibility.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-update-eligibility.html' +summary: 'Retrieve the eligibility support status' +--- + += Retrieve the eligibility support status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/update-eligibility`# + + + +Retrieves the eligibility support status of a Cloud Volumes ONTAP system. Valid values are NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|eligibilityResponse +|string +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "eligibilityResponse": "string" +} +==== + diff --git a/cvo/get-gcp-vsa-working-environments-user-tags.adoc b/cvo/get-gcp-vsa-working-environments-user-tags.adoc new file mode 100644 index 00000000..e3017c73 --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-user-tags.adoc @@ -0,0 +1,104 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-user-tags.html' +summary: 'Retrieve editable tags' +--- + += Retrieve editable tags + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/user-tags`# + + + +Retrieves the editable tags for the cloud resources in a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tags +|array[link:#CloudResourceTag[CloudResourceTag]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tags": [ + { + "tagKey": "string", + "tagValue": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudResourceTag] +[.api-collapsible-fifth-title] +CloudResourceTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|True +a| + +|tagValue +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-working-environments-validate-byol-to-capacity.adoc b/cvo/get-gcp-vsa-working-environments-validate-byol-to-capacity.adoc new file mode 100644 index 00000000..096be8ad --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments-validate-byol-to-capacity.adoc @@ -0,0 +1,214 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments-validate-byol-to-capacity.html' +summary: 'Validate prerequisites for converting a system' +--- + += Validate prerequisites for converting a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity`# + + + +Validates the prerequisites for converting an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|validAccount +|boolean +|True +a| + +|validNss +|boolean +|False +a| + +|mpSub +|array[link:#CloudAccountResponse[CloudAccountResponse]] +|True +a| + +|capacityLicenses +|array[link:#CapacityLicenseInfo[CapacityLicenseInfo]] +|True +a| + +|totalPrimaryVolumes +|link:#Capacity[Capacity] +|True +a| + +|totalDpVolumes +|link:#Capacity[Capacity] +|False +a| + +|vmPlan +|string +|False +a| + +|awsOldDeployment +|boolean +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudAccountResponse] +[.api-collapsible-fifth-title] +CloudAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudAccountId +|string +|True +a| + +|provider +|string +|False +a| + +|subscriptionId +|string +|False +a| + +|=== + + +[#TotalCapacity] +[.api-collapsible-fifth-title] +TotalCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacity +|integer +|True +a| + +|units +|string +|False +a| + +|=== + + +[#CapacityLicenseInfo] +[.api-collapsible-fifth-title] +CapacityLicenseInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|flavorType +|string +|False +a| + +|contractType +|string +|False +a| + +|totalLicensedCapacity +|link:#TotalCapacity[TotalCapacity] +|True +a| + +|totalConsumedCapacity +|link:#TotalCapacity[TotalCapacity] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-gcp-vsa-working-environments.adoc b/cvo/get-gcp-vsa-working-environments.adoc new file mode 100644 index 00000000..dad54215 --- /dev/null +++ b/cvo/get-gcp-vsa-working-environments.adoc @@ -0,0 +1,2741 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-gcp-vsa-working-environments.html' +summary: 'Retrieve Cloud Volumes ONTAP systems' +--- + += Retrieve Cloud Volumes ONTAP systems + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/gcp/vsa/working-environments`# + + + +Retrieves Cloud Volumes ONTAP systems visible to the current user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|tenantId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#GcpProperties[GcpProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|True +a| + +|haProperties +|link:#GcpHaProperties[GcpHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#labels] +[.api-collapsible-fifth-title] +labels +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#GcpProperties] +[.api-collapsible-fifth-title] +GcpProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|regionName +|string +|False +a| + +|zoneName +|array[string] +|False +a| + +|instanceType +|string +|False +a| + +|subnetCidr +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|projectName +|string +|False +a| + +|deploymentName +|string +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#GcpHaMediatorInfo] +[.api-collapsible-fifth-title] +GcpHaMediatorInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInstanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|version +|string +|False +a| + +|=== + + +[#GcpHaNodeInfo] +[.api-collapsible-fifth-title] +GcpHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|=== + + +[#GcpHaProperties] +[.api-collapsible-fifth-title] +GcpHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInfo +|link:#GcpHaMediatorInfo[GcpHaMediatorInfo] +|False +a| + +|node1Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|node2Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|projectName +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-monitoring-info.adoc b/cvo/get-monitoring-info.adoc new file mode 100644 index 00000000..d1d3d43c --- /dev/null +++ b/cvo/get-monitoring-info.adoc @@ -0,0 +1,59 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-monitoring-info.html' +summary: 'Retrieve monitoring information' +--- + += Retrieve monitoring information + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/monitoring/info`# + + + +Retrieves monitoring information. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|healthy +|boolean +|True +a| + +|url +|string +|False +a| + +|lastDeploymentError +|string +|False +a| + +|id +|string +|False +a| + +|=== + + diff --git a/cvo/get-occm-asup-download-ontap-cloud-asups.adoc b/cvo/get-occm-asup-download-ontap-cloud-asups.adoc new file mode 100644 index 00000000..179f7a10 --- /dev/null +++ b/cvo/get-occm-asup-download-ontap-cloud-asups.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-asup-download-ontap-cloud-asups.html' +summary: 'Download a compressed file of all the AutoSupport files from all VSAs' +--- + += Download a compressed file of all the AutoSupport files from all VSAs + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/asup/download-ontap-cloud-asups`# + + + +Downloads a compressed file of all AutoSupport files from all VSAs. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/get-occm-asup-download-signed.adoc b/cvo/get-occm-asup-download-signed.adoc new file mode 100644 index 00000000..7657f138 --- /dev/null +++ b/cvo/get-occm-asup-download-signed.adoc @@ -0,0 +1,25 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-asup-download-signed.html' +summary: 'Retrieve the signed URL for the NetApp Console support data' +--- + += Retrieve the signed URL for the NetApp Console support data + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/asup/download-signed`# + + + +Retrieves the signed URL for NetApp Console support data. + + +== Error + +``` +Status: Default, Default response +``` + + + diff --git a/cvo/get-occm-asup-download.adoc b/cvo/get-occm-asup-download.adoc new file mode 100644 index 00000000..2b97bb7d --- /dev/null +++ b/cvo/get-occm-asup-download.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-asup-download.html' +summary: 'Download NetApp Console support data' +--- + += Download NetApp Console support data + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/asup/download`# + + + +Downloads NetApp Console support data. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/get-occm-asup.adoc b/cvo/get-occm-asup.adoc new file mode 100644 index 00000000..e3615a74 --- /dev/null +++ b/cvo/get-occm-asup.adoc @@ -0,0 +1,136 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-asup.html' +summary: 'Retrieve the AutoSupport configuration' +--- + += Retrieve the AutoSupport configuration + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/asup`# + + + +Retrieves the AutoSupport configuration. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|enabled +|boolean +|True +a| + +|site +|string +|True +a| + +|company +|string +|False +a| + +|hostName +|string +|False +a| + +|os +|string +|False +a| + +|schedule +|link:#AsupSchedule[AsupSchedule] +|True +a| + +|url +|string +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AsupInterval] +[.api-collapsible-fifth-title] +AsupInterval + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#AsupSchedule] +[.api-collapsible-fifth-title] +AsupSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dayOfWeek +|integer +|True +a| + +|hourOfDay +|integer +|False +a| + +|interval +|link:#AsupInterval[AsupInterval] +|True +a| + +|minuteOfHour +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-occm-config.adoc b/cvo/get-occm-config.adoc new file mode 100644 index 00000000..38758bbb --- /dev/null +++ b/cvo/get-occm-config.adoc @@ -0,0 +1,310 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-config.html' +summary: 'Retrieve NetApp Console configuration parameters' +--- + += Retrieve NetApp Console configuration parameters + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/config`# + + + +Retrieves NetApp Console configuration parameters. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|simplicatorUri +|string +|True +a| + +|proxyUri +|string +|False +a| + +|debugLogLevel +|string +|False +a| + +|cacheConfig +|string +|False +a| + +|keyManagerPort +|integer +|True +a| + +|ipaManualUrl +|string +|False +a| + +|certificateValidityPeriod +|integer +|False +a| + +|maxAggregateFreeSpacePercentage +|integer +|False +a| + +|maxEvAggregateFreeSpacePercentage +|integer +|False +a| + +|asupSite +|string +|False +a| + +|asupCompany +|string +|False +a| + +|maxVolumeGrowSizePercentage +|integer +|False +a| + +|autoVsaCapacityManagement +|boolean +|True +a| + +|enableColdDataReportingOnStartup +|boolean +|False +a| + +|useVolumeViewAsDefault +|boolean +|False +a| + +|proxyUserName +|string +|False +a| + +|proxyPassword +|string +|False +a| + +|proxyDomain +|string +|False +a| + +|autoUpgrade +|boolean +|False +a| + +|cotRollback +|boolean +|False +a| + +|cloudSyncConstants +|link:#CloudSyncConstants[CloudSyncConstants] +|True +a| + +|licenseMaxCapacityUsedPercentage +|integer +|False +a| + +|s3EbsRatio +|integer +|False +a| + +|ebsSizeToPiopsRatio +|integer +|False +a| + +|autoOntapUpgrade +|boolean +|False +a| + +|sysMgrUserCred +|boolean +|False +a| + +|gcpInfrastructureManager +|boolean +|False +a| + +|overrideCifsLocks +|boolean +|False +a| + +|usePrivateLink +|boolean +|False +a| + +|directApiTraffic +|boolean +|False +a| + +|useAccelerationForImageDownload +|boolean +|False +a| + +|maxDownloadSessions +|integer +|False +a| + +|rollbackOnAzurePrivateLinkFailure +|boolean +|False +a| + +|gcpInstanceMetadataItems +|link:#GcpInstanceMetadataItems[GcpInstanceMetadataItems] +|False +a| + +|userPrivateDnsZoneSettings +|link:#UserPrivateDnsZoneSettings[UserPrivateDnsZoneSettings] +|False +a| + +|proxyMode +|string +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudSyncConstants] +[.api-collapsible-fifth-title] +CloudSyncConstants + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|reminderPeriod +|integer +|False +a| + +|warningPeriod +|integer +|False +a| + +|=== + + +[#GcpInstanceMetadataItems] +[.api-collapsible-fifth-title] +GcpInstanceMetadataItems + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|blockProjectSshKeys +|boolean +|False +a| + +|serialPortEnable +|boolean +|False +a| + +|enableOsLogin +|boolean +|False +a| + +|enableOsLoginSk +|boolean +|False +a| + +|=== + + +[#UserPrivateDnsZoneSettings] +[.api-collapsible-fifth-title] +UserPrivateDnsZoneSettings + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|useExisting +|boolean +|False +a| + +|resourceGroup +|string +|False +a| + +|subscription +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-occm-encryption-certificate.adoc b/cvo/get-occm-encryption-certificate.adoc new file mode 100644 index 00000000..6842b5bb --- /dev/null +++ b/cvo/get-occm-encryption-certificate.adoc @@ -0,0 +1,74 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-encryption-certificate.html' +summary: 'Retrieve the installed certificate' +--- + += Retrieve the installed certificate + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/encryption/certificate`# + + + +Retrieves the installed certificate, if one exists. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + diff --git a/cvo/get-occm-encryption-csr.adoc b/cvo/get-occm-encryption-csr.adoc new file mode 100644 index 00000000..a8803a78 --- /dev/null +++ b/cvo/get-occm-encryption-csr.adoc @@ -0,0 +1,48 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-encryption-csr.html' +summary: 'Retrieve a generated certificate signing request' +--- + += Retrieve a generated certificate signing request + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/encryption/csr`# + + + +Retrieves the most recently generated certificate signing request (CSR), if it exists. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|csr +|string +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "csr": "string" +} +==== + diff --git a/cvo/get-occm-encryption-key-managers-.adoc b/cvo/get-occm-encryption-key-managers-.adoc new file mode 100644 index 00000000..4ed11c99 --- /dev/null +++ b/cvo/get-occm-encryption-key-managers-.adoc @@ -0,0 +1,96 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-encryption-key-managers-.html' +summary: 'Retrieve a key manager using the public ID' +--- + += Retrieve a key manager using the public ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/encryption/key-managers/{keyManagerId}`# + + + +Returns specific key manager using the public ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|keyManagerId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "name": "string", + "address": "string", + "usernameField": "string", + "usernameValue": "string", + "status": "string" +} +==== + diff --git a/cvo/get-occm-encryption-key-managers-ca-certificates-.adoc b/cvo/get-occm-encryption-key-managers-ca-certificates-.adoc new file mode 100644 index 00000000..da6b2835 --- /dev/null +++ b/cvo/get-occm-encryption-key-managers-ca-certificates-.adoc @@ -0,0 +1,92 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-encryption-key-managers-ca-certificates-.html' +summary: 'Retrieve a key manager CA certificate' +--- + += Retrieve a key manager CA certificate + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/encryption/key-managers-ca-certificates/{keyManagerCaCertificateId}`# + + + +Retrieves a specific key manager certificate authority (CA) certificate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|keyManagerCaCertificateId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + diff --git a/cvo/get-occm-encryption-key-managers-ca-certificates.adoc b/cvo/get-occm-encryption-key-managers-ca-certificates.adoc new file mode 100644 index 00000000..dd81a8d7 --- /dev/null +++ b/cvo/get-occm-encryption-key-managers-ca-certificates.adoc @@ -0,0 +1,74 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-encryption-key-managers-ca-certificates.html' +summary: 'Retrieve all key manager CA certificates' +--- + += Retrieve all key manager CA certificates + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/encryption/key-managers-ca-certificates`# + + + +Retrieves all key manager certificate authority (CA) certificates. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + diff --git a/cvo/get-occm-encryption-key-managers.adoc b/cvo/get-occm-encryption-key-managers.adoc new file mode 100644 index 00000000..95c91444 --- /dev/null +++ b/cvo/get-occm-encryption-key-managers.adoc @@ -0,0 +1,78 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-encryption-key-managers.html' +summary: 'Retrieve all key managers' +--- + += Retrieve all key managers + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/encryption/key-managers`# + + + +Retrieves all key managers. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "name": "string", + "address": "string", + "usernameField": "string", + "usernameValue": "string", + "status": "string" +} +==== + diff --git a/cvo/get-occm-key-store-self-certificate.adoc b/cvo/get-occm-key-store-self-certificate.adoc new file mode 100644 index 00000000..09cffe4b --- /dev/null +++ b/cvo/get-occm-key-store-self-certificate.adoc @@ -0,0 +1,74 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-key-store-self-certificate.html' +summary: 'Retrieve the self-signed certificate of the NetApp Console key store' +--- + += Retrieve the self-signed certificate of the NetApp Console key store + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/key-store/self-certificate`# + + + +Retrieves the self-signed certificate of NetApp Console key store, if one exists. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + diff --git a/cvo/get-occm-key-store-signed-certificate.adoc b/cvo/get-occm-key-store-signed-certificate.adoc new file mode 100644 index 00000000..7cd05a63 --- /dev/null +++ b/cvo/get-occm-key-store-signed-certificate.adoc @@ -0,0 +1,74 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-key-store-signed-certificate.html' +summary: 'Retrieve the CA signed certificate' +--- + += Retrieve the CA signed certificate + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/key-store/signed-certificate`# + + + +Retrieves the certificate authority (CA) signed certificate of the NetApp Console key store, if one exists. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + diff --git a/cvo/get-occm-key-store-user-trusted-certificates.adoc b/cvo/get-occm-key-store-user-trusted-certificates.adoc new file mode 100644 index 00000000..b1a22894 --- /dev/null +++ b/cvo/get-occm-key-store-user-trusted-certificates.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-key-store-user-trusted-certificates.html' +summary: 'Return the existing trusted certificates from the trust store' +--- + += Return the existing trusted certificates from the trust store + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/key-store/user-trusted-certificates`# + + + +Returns the existing trusted certificates added by the user from the trust store. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Specifies the ID + + +|status +|string +|True +a|Status + + +|certificateInfo +|link:#CertificateResponse[CertificateResponse] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-occm-saas-mp-service-account.adoc b/cvo/get-occm-saas-mp-service-account.adoc new file mode 100644 index 00000000..4661d936 --- /dev/null +++ b/cvo/get-occm-saas-mp-service-account.adoc @@ -0,0 +1,175 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-saas-mp-service-account.html' +summary: 'Retrieve current SaaS marketplace accounts and subscriptions' +--- + += Retrieve current SaaS marketplace accounts and subscriptions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/saas-mp-service/account`# + + + +Retrieves the current SaaS marketplace account and subscriptions. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|awsSubscriptions +|array[link:#SubscriptionResponse[SubscriptionResponse]] +|True +a|AWS subscriptions + + +|azureSubscriptions +|array[link:#SubscriptionResponse[SubscriptionResponse]] +|True +a|Azure subscriptions + + +|gcpSubscriptions +|array[link:#SubscriptionResponse[SubscriptionResponse]] +|True +a|Gcp Subscriptions + + +|eligibleForFreeTrialAws +|boolean +|True +a|Indicates eligibility for an AWS free trial + + +|eligibleForFreeTrialGcp +|boolean +|True +a|Indicates eligibility for a Google Cloud free trial + + +|eligibleForFreeTrialAzure +|boolean +|True +a|Indicates eligibility for an Azure free trial + + +|cloudAccounts +|array[link:#CloudAccountResponse[CloudAccountResponse]] +|True +a|Cloud accounts + + +|eligibleBycapLicenseCvoPackages +|array[string] +|True +a|Eligible ByCap license Cloud Volumes ONTAP packages + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SubscriptionResponse] +[.api-collapsible-fifth-title] +SubscriptionResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Specifies the ID + + +|name +|string +|True +a|Specifies the name + + +|provider +|string +|True +a| + +|active +|boolean +|True +a|Active + + +|contract +|boolean +|True +a|contract + + +|byNodeMode +|boolean +|True +a|By node mode + + +|eligibleCvoPackages +|array[string] +|True +a|Eligible Cloud Volumes ONTAP packages + + +|=== + + +[#CloudAccountResponse] +[.api-collapsible-fifth-title] +CloudAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudAccountId +|string +|True +a| + +|provider +|string +|False +a| + +|subscriptionId +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-occm-saas-mp-service-subscription.adoc b/cvo/get-occm-saas-mp-service-subscription.adoc new file mode 100644 index 00000000..73f788d8 --- /dev/null +++ b/cvo/get-occm-saas-mp-service-subscription.adoc @@ -0,0 +1,131 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-saas-mp-service-subscription.html' +summary: 'Retrieve SaaS marketplace subscriptions' +--- + += Retrieve SaaS marketplace subscriptions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/saas-mp-service/{workingEnvironmentId}/subscription`# + + + +Retrieves the SaaS marketplace subscriptions for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SubscriptionResponse[SubscriptionResponse] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SubscriptionResponse] +[.api-collapsible-fifth-title] +SubscriptionResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Specifies the ID + + +|name +|string +|True +a|Specifies the name + + +|provider +|string +|True +a| + +|active +|boolean +|True +a|Active + + +|contract +|boolean +|True +a|contract + + +|byNodeMode +|boolean +|True +a|By node mode + + +|eligibleCvoPackages +|array[string] +|True +a|Eligible Cloud Volumes ONTAP packages + + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-occm-system-about.adoc b/cvo/get-occm-system-about.adoc new file mode 100644 index 00000000..0628d302 --- /dev/null +++ b/cvo/get-occm-system-about.adoc @@ -0,0 +1,171 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-system-about.html' +summary: 'Retrieve the NetApp Console server information' +--- + += Retrieve the NetApp Console server information + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/system/about`# + + + +Retrieves NetApp Console server information. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|version +|string +|True +a| + +|build +|string +|False +a| + +|buildTimestamp +|integer +|True +a| + +|systemId +|string +|False +a| + +|environment +|string +|False +a| + +|siteIdentifier +|link:#SiteIdentifier[SiteIdentifier] +|True +a| + +|serverTimeZone +|link:#ServerTimeZone[ServerTimeZone] +|True +a| + +|beta +|boolean +|True +a| + +|releaseNumber +|integer +|True +a| + +|simplicatorUrl +|string +|False +a| + +|migrationPerformed +|boolean +|False +a| + +|demoMode +|boolean +|False +a| + +|usingDockerInfra +|boolean +|False +a| + +|privateIp +|string +|False +a| + +|isLegacySM +|boolean +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SiteIdentifier] +[.api-collapsible-fifth-title] +SiteIdentifier + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|company +|string +|False +a| + +|host +|string +|False +a| + +|site +|string +|False +a| + +|=== + + +[#ServerTimeZone] +[.api-collapsible-fifth-title] +ServerTimeZone + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|timeZoneName +|string +|False +a| + +|formattedTimeZone +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-occm-system-available-update-versions.adoc b/cvo/get-occm-system-available-update-versions.adoc new file mode 100644 index 00000000..009fe548 --- /dev/null +++ b/cvo/get-occm-system-available-update-versions.adoc @@ -0,0 +1,52 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-system-available-update-versions.html' +summary: 'Check for a new version of the NetApp Console' +--- + += Check for a new version of the NetApp Console + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/system/available-update-versions`# + + + +Checks for a new version of the NetApp Console. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Update name + + +|date +|integer +|True +a|Last Modified + + +|releaseNumber +|integer +|True +a|Release Number + + +|=== + + diff --git a/cvo/get-occm-system-cloud-provider-regions.adoc b/cvo/get-occm-system-cloud-provider-regions.adoc new file mode 100644 index 00000000..2068dc4c --- /dev/null +++ b/cvo/get-occm-system-cloud-provider-regions.adoc @@ -0,0 +1,111 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-system-cloud-provider-regions.html' +summary: 'Retrieve supported regions for the cloud providers' +--- + += Retrieve supported regions for the cloud providers + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/system/cloud-provider-regions`# + + + +Retrieves the supported regions for cloud providers. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aws +|array[link:#Region[Region]] +|True +a| + +|azure +|array[link:#Region[Region]] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aws": [ + { + "name": "string", + "code": "string", + "location": "string", + "s3Region": "string" + } + ], + "azure": [ + { + "name": "string", + "code": "string", + "location": "string", + "s3Region": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Region] +[.api-collapsible-fifth-title] +Region + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|code +|string +|False +a| + +|location +|string +|False +a| + +|s3Region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-occm-system-external-config.adoc b/cvo/get-occm-system-external-config.adoc new file mode 100644 index 00000000..3f756d5c --- /dev/null +++ b/cvo/get-occm-system-external-config.adoc @@ -0,0 +1,906 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-system-external-config.html' +summary: 'Retrieve the NetApp Console feedback configuration' +--- + += Retrieve the NetApp Console feedback configuration + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/system/external-config`# + + + +Retrieves NetApp Console feedback configuration. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|email +|string +|True +a| + +|aws_product_page +|string +|False +a| + +|cot_aws_product_page +|string +|False +a| + +|ha_cot_aws_product_page +|string +|False +a| + +|intercom_prod_app_id +|string +|False +a| + +|intercom_test_app_id +|string +|False +a| + +|livechat_license +|string +|False +a| + +|features +|link:#OccmFeaturesFlags[OccmFeaturesFlags] +|True +a| + +|upgrade_path +|array[link:#OnCloudUpgradePath[OnCloudUpgradePath]] +|True +a| + +|occm_release_notes_url +|string +|False +a| + +|evaluation_serial_numbers +|link:#EvaluationSerialNumbers[EvaluationSerialNumbers] +|True +a| + +|legacyInstanceTypes +|link:#LegacyInstanceTypes[LegacyInstanceTypes] +|True +a| + +|aws_cross_account_tutorial_url +|string +|False +a| + +|disksConfiguration +|link:#DisksConfiguration[DisksConfiguration] +|True +a| + +|migration +|link:#OccmMigration[OccmMigration] +|True +a| + +|evaluation_ontap_licenses +|link:#EvaluationOntapLicenses[EvaluationOntapLicenses] +|True +a| + +|mediatorUpgradeConfiguration +|link:#MediatorUpgradeConfiguration[MediatorUpgradeConfiguration] +|True +a| + +|instanceConfiguration +|link:#InstanceConfiguration[InstanceConfiguration] +|True +a| + +|cvsRegions +|array[link:#CvsRegion[CvsRegion]] +|True +a| + +|regions +|link:#regions[regions] +|False +a| + +|servicesInformation +|link:#servicesInformation[servicesInformation] +|True +a| + +|ontapBackupTokenCreds +|link:#OntapBackupTokenCreds[OntapBackupTokenCreds] +|True +a| + +|zrsRegions +|array[link:#Region[Region]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#OccmFeaturesFlags] +[.api-collapsible-fifth-title] +OccmFeaturesFlags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|intercom +|boolean +|True +a| + +|aws_environment_collector +|boolean +|False +a| + +|=== + + +[#OnCloudUpgradePath] +[.api-collapsible-fifth-title] +OnCloudUpgradePath + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|version +|string +|False +a| + +|path +|array[string] +|True +a| + +|=== + + +[#EvaluationSerialNumbers] +[.api-collapsible-fifth-title] +EvaluationSerialNumbers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|single_aws +|string +|False +a| + +|single_azure +|string +|False +a| + +|ha_aws_node1 +|string +|False +a| + +|ha_aws_node2 +|string +|False +a| + +|ha_azure_node1 +|string +|False +a| + +|ha_azure_node2 +|string +|False +a| + +|gcp_single +|string +|False +a| + +|ha_gcp_node1 +|string +|False +a| + +|ha_gcp_node2 +|string +|False +a| + +|=== + + +[#ProviderLegacyInstanceTypes] +[.api-collapsible-fifth-title] +ProviderLegacyInstanceTypes + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aws +|array[string] +|False +a| + +|azure +|array[string] +|False +a| + +|=== + + +[#LegacyInstanceTypes] +[.api-collapsible-fifth-title] +LegacyInstanceTypes + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceTypes +|link:#ProviderLegacyInstanceTypes[ProviderLegacyInstanceTypes] +|True +a| + +|=== + + +[#AggregateNumToDiskSize] +[.api-collapsible-fifth-title] +AggregateNumToDiskSize + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|from +|integer +|False +a| + +|to +|integer +|False +a| + +|stepsUp +|integer +|False +a| + +|=== + + +[#AwsDisksConstraints] +[.api-collapsible-fifth-title] +AwsDisksConstraints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numReservedDisksSingleNode +|integer +|True +a| + +|numReservedDisksHa +|integer +|False +a| + +|maxDisksSingleNode +|integer +|False +a| + +|maxDisksHa +|integer +|False +a| + +|numDisksWarnSingleNode +|integer +|False +a| + +|numDisksWarnHa +|integer +|False +a| + +|aggregatesNumToDiskSize +|array[link:#AggregateNumToDiskSize[AggregateNumToDiskSize]] +|True +a| + +|maxDisksSingleNodeKvm +|integer +|False +a| + +|maxDisksHaKvm +|integer +|False +a| + +|deltaDiskWarn +|integer +|False +a| + +|=== + + +[#AzureDisksConstraints] +[.api-collapsible-fifth-title] +AzureDisksConstraints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numReservedDisksSingleNode +|integer +|False +a| + +|numReservedDisksHaMultiZoneNode +|integer +|False +a| + +|=== + + +[#GcpDisksConstraints] +[.api-collapsible-fifth-title] +GcpDisksConstraints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numReservedDisksSingleNode +|integer +|False +a| + +|maxDisksSingleNode +|integer +|False +a| + +|numDisksWarnSingleNode +|integer +|False +a| + +|deltaDiskWarn +|integer +|False +a| + +|=== + + +[#DisksConfiguration] +[.api-collapsible-fifth-title] +DisksConfiguration + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aws +|link:#AwsDisksConstraints[AwsDisksConstraints] +|True +a| + +|azure +|link:#AzureDisksConstraints[AzureDisksConstraints] +|True +a| + +|gcp +|link:#GcpDisksConstraints[GcpDisksConstraints] +|True +a| + +|=== + + +[#OccmMigration] +[.api-collapsible-fifth-title] +OccmMigration + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|migrateAll +|boolean +|False +a| + +|blackList +|array[string] +|False +a| + +|=== + + +[#EvaluationOntapLicenses] +[.api-collapsible-fifth-title] +EvaluationOntapLicenses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|worm +|string +|False +a| + +|=== + + +[#dependencies] +[.api-collapsible-fifth-title] +dependencies +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#MediatorUpgradeConfiguration] +[.api-collapsible-fifth-title] +MediatorUpgradeConfiguration + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dependencies +|link:#dependencies[dependencies] +|True +a| + +|=== + + +[#InstanceConfigurationMapping] +[.api-collapsible-fifth-title] +InstanceConfigurationMapping + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regular +|string +|False +a| + +|dedicated +|string +|False +a| + +|=== + + +[#mediator] +[.api-collapsible-fifth-title] +mediator +Hash mapping strings to link:#InstanceConfigurationMapping[InstanceConfigurationMapping] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#probes] +[.api-collapsible-fifth-title] +probes +Hash mapping strings to link:#InstanceConfigurationMapping[InstanceConfigurationMapping] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#InstanceConfiguration] +[.api-collapsible-fifth-title] +InstanceConfiguration + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediator +|link:#mediator[mediator] +|True +a| + +|probes +|link:#probes[probes] +|False +a| + +|=== + + +[#CvsRegion] +[.api-collapsible-fifth-title] +CvsRegion + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|code +|string +|False +a| + +|location +|string +|False +a| + +|=== + + +[#regions] +[.api-collapsible-fifth-title] +regions +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#MapStringString] +[.api-collapsible-fifth-title] +MapStringString + +Instance tags + +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#LocalServiceInfo] +[.api-collapsible-fifth-title] +LocalServiceInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSupported +|boolean +|False +a| + +|localFolder +|string +|False +a| + +|localPort +|integer +|False +a| + +|=== + + +[#ServiceInfo] +[.api-collapsible-fifth-title] +ServiceInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|enabled +|boolean +|False +a| + +|requireClientInfra +|boolean +|False +a| + +|cloudProvider +|array[string] +|False +a| + +|metadata +|link:#MapStringString[MapStringString] +|False +a|Instance tags + + +|localSupport +|link:#LocalServiceInfo[LocalServiceInfo] +|False +a| + +|darksiteSupport +|link:#LocalServiceInfo[LocalServiceInfo] +|False +a| + +|=== + + +[#servicesInformation] +[.api-collapsible-fifth-title] +servicesInformation +Hash mapping strings to link:#ServiceInfo[ServiceInfo] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#OntapBackupTokenCreds] +[.api-collapsible-fifth-title] +OntapBackupTokenCreds + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|secret +|string +|False +a| + +|=== + + +[#Region] +[.api-collapsible-fifth-title] +Region + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|code +|string +|False +a| + +|location +|string +|False +a| + +|s3Region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-occm-system-feature-flags.adoc b/cvo/get-occm-system-feature-flags.adoc new file mode 100644 index 00000000..c9a82003 --- /dev/null +++ b/cvo/get-occm-system-feature-flags.adoc @@ -0,0 +1,39 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-system-feature-flags.html' +summary: 'Retrieve feature flags' +--- + += Retrieve feature flags + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/system/feature-flags`# + + + +Retrieves feature flags. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azure +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-occm-system-occm-instance-placement.adoc b/cvo/get-occm-system-occm-instance-placement.adoc new file mode 100644 index 00000000..f0b060bf --- /dev/null +++ b/cvo/get-occm-system-occm-instance-placement.adoc @@ -0,0 +1,160 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-system-occm-instance-placement.html' +summary: 'Retrieve the region, VPC, and subnet' +--- + += Retrieve the region, VPC, and subnet + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/system/occm-instance-placement`# + + + +Retrieves the region, VPC, and subnet in which the NetApp Console instance is running. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|clearCache +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|False +a|Region + + +|vpcId +|string +|False +a|VPC + + +|subnetId +|string +|False +a|Subnet + + +|keyPair +|string +|False +a|KeyPair + + +|installLocation +|string +|False +a|Install Location + + +|role +|string +|False +a|Role + + +|providerRoleType +|string +|False +a|Provider Role Type + + +|publicIp +|string +|False +a|Public IP + + +|account +|string +|False +a|Account + + +|govCloud +|boolean +|False +a|Gov cloud + + +|china +|boolean +|False +a|China + + +|isLegacyInstance +|boolean +|False +a|isLegacyInstance + + +|instanceType +|string +|False +a|instanceType + + +|isLegacyOs +|boolean +|False +a|isLegacyOs + + +|darkSite +|boolean +|False +a|is dark site + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": "string", + "vpcId": "string", + "subnetId": "string", + "keyPair": "string", + "installLocation": "string", + "role": "string", + "providerRoleType": "string", + "publicIp": "string", + "account": "string", + "instanceType": "string" +} +==== + diff --git a/cvo/get-occm-system-support-services.adoc b/cvo/get-occm-system-support-services.adoc new file mode 100644 index 00000000..c7af467f --- /dev/null +++ b/cvo/get-occm-system-support-services.adoc @@ -0,0 +1,534 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-system-support-services.html' +summary: 'Retrieve the NetApp Console support services information' +--- + += Retrieve the NetApp Console support services information + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/system/support-services`# + + + +Retrieves NetApp Console support services information. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|asupEnabled +|boolean +|True +a| + +|cognitoEnabled +|boolean +|False +a| + +|kinesisEnabled +|boolean +|False +a| + +|intercomEnabled +|boolean +|False +a| + +|liveChatEnabled +|boolean +|False +a| + +|volumeViewEnabled +|boolean +|False +a| + +|portalService +|link:#PortalService[PortalService] +|True +a| + +|intercomAppId +|string +|False +a| + +|tenancyServiceInformation +|link:#TenancyServiceInformation[TenancyServiceInformation] +|False +a| + +|saasMpServiceInformation +|link:#SaasMpServiceInformation[SaasMpServiceInformation] +|False +a| + +|cvsInformation +|string +|False +a| + +|complianceEnabled +|boolean +|False +a| + +|ipaServiceInformation +|link:#IpaServiceInformation[IpaServiceInformation] +|False +a| + +|licenseServiceInformation +|link:#LicenseServiceInformation[LicenseServiceInformation] +|False +a| + +|servicesInformation +|link:#servicesInformation[servicesInformation] +|True +a| + +|setupInfo +|link:#SetupInfo[SetupInfo] +|True +a| + +|useCompliancePrivateIpContainerMode +|boolean +|False +a| + +|notificationServiceInformation +|link:#NotificationServiceInformation[NotificationServiceInformation] +|False +a| + +|alertsAndNotificationServiceInformation +|link:#AlertsAndNotificationServiceInformation[AlertsAndNotificationServiceInformation] +|False +a| + +|credentialsServiceInformation +|link:#ServiceInformationUrl[ServiceInformationUrl] +|False +a| + +|cvsServiceInformation +|link:#CvsServiceInformation[CvsServiceInformation] +|False +a| + +|platformServiceInformation +|link:#ServiceInformationUrl[ServiceInformationUrl] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Auth0Information] +[.api-collapsible-fifth-title] +Auth0Information + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|domain +|string +|False +a| + +|audience +|string +|False +a| + +|clientId +|string +|False +a| + +|=== + + +[#PortalInformation] +[.api-collapsible-fifth-title] +PortalInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|edit_user_url +|string +|False +a| + +|portalBackEnd +|string +|False +a| + +|portalFrontEnd +|string +|False +a| + +|=== + + +[#PortalService] +[.api-collapsible-fifth-title] +PortalService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|usePortalAuthentication +|boolean +|False +a| + +|auth0Information +|link:#Auth0Information[Auth0Information] +|False +a| + +|portalInformation +|link:#PortalInformation[PortalInformation] +|False +a| + +|saasFrontEnd +|string +|False +a| + +|=== + + +[#TenancyServiceInformation] +[.api-collapsible-fifth-title] +TenancyServiceInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|False +a| + +|url +|string +|False +a| + +|urlV4 +|string +|False +a| + +|accountWidgetUrl +|string +|False +a| + +|agentsMgmtUrl +|string +|False +a| + +|forwarderUrlOverride +|string +|False +a| + +|=== + + +[#SaasMpServiceInformation] +[.api-collapsible-fifth-title] +SaasMpServiceInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|productUrlAws +|string +|False +a| + +|productUrlGcp +|string +|False +a| + +|url +|string +|False +a| + +|productUrlAzure +|string +|False +a| + +|productUrlAwsContract +|string +|False +a| + +|=== + + +[#IpaServiceInformation] +[.api-collapsible-fifth-title] +IpaServiceInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|url +|string +|False +a| + +|=== + + +[#LicenseServiceInformation] +[.api-collapsible-fifth-title] +LicenseServiceInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|url +|string +|False +a| + +|=== + + +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject + + +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject +Hash mapping strings to link:#MapStringObject[MapStringObject] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|True +a| + +|empty +|boolean +|False +a| + +|=== + + +[#servicesInformation] +[.api-collapsible-fifth-title] +servicesInformation +Hash mapping strings to link:#MapStringObject[MapStringObject] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#SetupInfo] +[.api-collapsible-fifth-title] +SetupInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSetup +|boolean +|False +a| + +|isPendingConnectivitySet +|boolean +|False +a| + +|needCertificate +|boolean +|False +a| + +|runningInDocker +|boolean +|False +a| + +|=== + + +[#NotificationServiceInformation] +[.api-collapsible-fifth-title] +NotificationServiceInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|wsUrl +|string +|False +a| + +|url +|string +|False +a| + +|=== + + +[#AlertsAndNotificationServiceInformation] +[.api-collapsible-fifth-title] +AlertsAndNotificationServiceInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|url +|string +|False +a| + +|=== + + +[#ServiceInformationUrl] +[.api-collapsible-fifth-title] +ServiceInformationUrl + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|url +|string +|False +a| + +|=== + + +[#CvsServiceInformation] +[.api-collapsible-fifth-title] +CvsServiceInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|url +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-occm-tenancy-service-workspaces.adoc b/cvo/get-occm-tenancy-service-workspaces.adoc new file mode 100644 index 00000000..16e950be --- /dev/null +++ b/cvo/get-occm-tenancy-service-workspaces.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-occm-tenancy-service-workspaces.html' +summary: 'Retrieve visible workspaces' +--- + += Retrieve visible workspaces + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/occm/tenancy-service/workspaces`# + + + +Retrieves workspaces that are visible to the current user. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workspacePublicId +|string +|True +a| + +|workspaceName +|string +|False +a| + +|associatedToAgent +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-onprem-aggregates.adoc b/cvo/get-onprem-aggregates.adoc new file mode 100644 index 00000000..6c2a1e0a --- /dev/null +++ b/cvo/get-onprem-aggregates.adoc @@ -0,0 +1,212 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-onprem-aggregates.html' +summary: 'Retrieve aggregates' +--- + += Retrieve aggregates + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/onprem/aggregates`# + + + +Retrieves aggregates. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|checkTieringRestrictions +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|availableCapacity +|link:#Capacity[Capacity] +|False +a| + +|state +|string +|False +a| + +|isInactiveDataReportingEnabled +|boolean +|True +a| + +|isObjectStoreAttachEligible +|boolean +|False +a| + +|objectStoreName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|snaplockType +|string +|True +a|Snaplock type + + +|tieringRestriction +|link:#TieringRestriction[TieringRestriction] +|False +a| + +|availabilityState +|string +|False +a| + +|commonDiskProperties +|link:#CommonDiskProperties[CommonDiskProperties] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#TieringRestriction] +[.api-collapsible-fifth-title] +TieringRestriction + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isTieringRestricted +|boolean +|False +a| + +|restrictionReason +|string +|False +a| + +|=== + + +[#rpm] +[.api-collapsible-fifth-title] +rpm + + +[#CommonDiskProperties] +[.api-collapsible-fifth-title] +CommonDiskProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|diskType +|string +|False +a| + +|sizeKB +|integer +|False +a| + +|rpm +|link:#rpm[rpm] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-onprem-metadata-cluster-info.adoc b/cvo/get-onprem-metadata-cluster-info.adoc new file mode 100644 index 00000000..0354ec55 --- /dev/null +++ b/cvo/get-onprem-metadata-cluster-info.adoc @@ -0,0 +1,99 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-onprem-metadata-cluster-info.html' +summary: 'Verify the address and credentials of a cluster' +--- + += Verify the address and credentials of a cluster + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/onprem/metadata/cluster-info`# + + + +Verifies the address and credentials of the specified cluster by retrieving the cluster information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|clusterAddress +|string +|header +|False +a| + +|clusterUsername +|string +|header +|False +a| + +|clusterPassword +|string +|header +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serialNumber +|string +|True +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|nodeModels +|array[string] +|True +a| + +|isAdmin +|boolean +|True +a| + +|clusterIp +|string +|False +a| + +|=== + + diff --git a/cvo/get-onprem-volumes--snapshots.adoc b/cvo/get-onprem-volumes--snapshots.adoc new file mode 100644 index 00000000..6e2e0727 --- /dev/null +++ b/cvo/get-onprem-volumes--snapshots.adoc @@ -0,0 +1,79 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-onprem-volumes--snapshots.html' +summary: 'Retrieve a list of snapshot descriptions' +--- + += Retrieve a list of snapshot descriptions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots`# + + + +Returns a list of snapshot descriptions for the volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|accessTime +|integer +|True +a| + +|label +|string +|False +a| + +|=== + + diff --git a/cvo/get-onprem-volumes-volumes-for-backup.adoc b/cvo/get-onprem-volumes-volumes-for-backup.adoc new file mode 100644 index 00000000..caadd7ab --- /dev/null +++ b/cvo/get-onprem-volumes-volumes-for-backup.adoc @@ -0,0 +1,288 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-onprem-volumes-volumes-for-backup.html' +summary: 'Retrieve volumes for backup activation' +--- + += Retrieve volumes for backup activation + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/onprem/volumes/volumes-for-backup`# + + + +Retrieves all volumes for backup activation. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|offset +|integer +|query +|False +a| + +|limit +|integer +|query +|False +a| + +|search +|string +|query +|False +a| + +|filterBy +|link:#ListFilterByParam[ListFilterByParam] +|query +|False +a| + +|sortBy +|link:#ListSortByParam[ListSortByParam] +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumes +|array[link:#VolumeForBackupResponse[VolumeForBackupResponse]] +|True +a| + +|totalNumberOfVolumes +|integer +|True +a| + +|filteredNumberOfVolumes +|link:#filteredNumberOfVolumes[filteredNumberOfVolumes] +|False +a| + +|hasNextPage +|link:#hasNextPage[hasNextPage] +|False +a| + +|allowedValuesForVolumesListFilter +|link:#AllowedValuesForVolumesListFilter[AllowedValuesForVolumesListFilter] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ListFilterByParam] +[.api-collapsible-fifth-title] +ListFilterByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#ListSortByParam] +[.api-collapsible-fifth-title] +ListSortByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeForBackupResponse] +[.api-collapsible-fifth-title] +VolumeForBackupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|uuid +|string +|False +a| + +|svmName +|string +|False +a| + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|False +a| + +|state +|string +|False +a| + +|providerVolumeType +|string +|False +a| + +|volumeType +|string +|False +a| + +|isBackupOn +|boolean +|True +a| + +|disableReasonBackup +|array[string] +|True +a| + +|=== + + +[#filteredNumberOfVolumes] +[.api-collapsible-fifth-title] +filteredNumberOfVolumes + + +[#hasNextPage] +[.api-collapsible-fifth-title] +hasNextPage + + +[#AllowedValuesForVolumesListFilter] +[.api-collapsible-fifth-title] +AllowedValuesForVolumesListFilter + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeTypes +|array[string] +|False +a| + +|diskTypes +|array[string] +|False +a| + +|svmNames +|array[string] +|False +a| + +|volumeStatus +|array[string] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-onprem-volumes.adoc b/cvo/get-onprem-volumes.adoc new file mode 100644 index 00000000..ed27c1c1 --- /dev/null +++ b/cvo/get-onprem-volumes.adoc @@ -0,0 +1,556 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-onprem-volumes.html' +summary: 'Retrieve volumes' +--- + += Retrieve volumes + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/onprem/volumes`# + + + +Retrieves all volumes. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|withMinimumCoolingDays +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Volume name + + +|uuid +|string +|True +a|Volume UUID + + +|svmName +|string +|True +a|Volume SVM name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|junctionPath +|string +|True +a|The junction path at which this volume is mounted + + +|volumeTotalInodes +|integer +|False +a|Total volume inodes size + + +|volumeUsedInodes +|integer +|False +a|Used volume inodes size + + +|mountPoint +|string +|False +a|Mount Point + + +|compressionSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|deduplicationSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioning +|boolean +|True +a|Specifies whether thin provisioning is enabled + + +|compression +|boolean +|True +a|Specifies whether compression is enabled + + +|deduplication +|boolean +|True +a|Specifies whether deduplication is enabled + + +|snapshotPolicy +|string +|True +a|The name of the snapshot policy + + +|securityStyle +|string +|True +a|The type of the security style + + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|True +a| + +|shareNames +|array[string] +|True +a|The share names for CIFS + + +|shareInfo +|array[link:#CifsShareInfo[CifsShareInfo]] +|True +a|The share names, permissions, and users for CIFS + + +|parentVolumeName +|string +|True +a|Name of the parent flexible volume for the clone + + +|rootVolume +|boolean +|True +a|Flag to indicate if the volume is a SVM root + + +|state +|string +|True +a|Volume state + + +|volumeType +|string +|True +a|Volume type + + +|aggregateName +|string +|True +a|Aggregate name + + +|parentSnapshot +|string +|False +a|The snapshot name the volume is based on + + +|autoSizeMode +|string +|True +a|The operating mode of autosize + + +|maxGrowSize +|link:#Capacity[Capacity] +|True +a| + +|providerVolumeType +|string +|False +a|Cloud provider volume type + + +|cloneNames +|array[string] +|True +a|Names of cloned copies of the volume + + +|moving +|boolean +|True +a|Specifies if the volume move process is in progress + + +|primaryNoFailoverMountPoint +|string +|False +a|Primary mount point without failover + + +|secondaryNoFailoverMountPoint +|string +|False +a|Secondary mount point without failover + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cifsShareAccessPoint +|string +|False +a|CIFS share access point + + +|primaryCifsShareAccessPoint +|string +|False +a|Primary CIFS share access point + + +|secondaryCifsShareAccessPoint +|string +|False +a|Secondary CIFS share access point + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|tierInactiveUserData +|link:#Capacity[Capacity] +|False +a| + +|tierInactiveUserDataPercent +|integer +|False +a|Tier inactive user data percentage + + +|comment +|string +|False +a|Volume comment + + +|qosPolicyGroupName +|string +|False +a|Quality of service policy group name + + +|snaplockType +|string +|False +a|SnapLock type + + +|constituentsAggregates +|array[string] +|True +a|Aggregates which are used for FlexGroup constituents + + +|snapshotsUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cbsBackupsInfo +|link:#VolumeCbsInfo[VolumeCbsInfo] +|False +a| + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|targetName +|string +|True +a|iSCSI target IQN + + +|iscsiEnabled +|boolean +|True +a|Indicates if the volume is used by the iSCSI protocol + + +|isFlexGroupVolume +|boolean +|True +a|Indicates if the volume is a FlexGroup volume + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#VolumeCbsInfo] +[.api-collapsible-fifth-title] +VolumeCbsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalBackups +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-onprem-working-environments-.adoc b/cvo/get-onprem-working-environments-.adoc new file mode 100644 index 00000000..f1bbb057 --- /dev/null +++ b/cvo/get-onprem-working-environments-.adoc @@ -0,0 +1,1972 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-onprem-working-environments-.html' +summary: 'Retrieve an on-premises ONTAP system' +--- + += Retrieve an on-premises ONTAP system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/onprem/working-environments/{workingEnvironmentId}`# + + + +Retrieves an on-premises ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|tenantId +|string +|False +a| + +|description +|string +|False +a| + +|name +|string +|False +a| + +|discoverUserEmail +|string +|False +a| + +|location +|string +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|interClusterLifs +|array[link:#InterClusterLif[InterClusterLif]] +|True +a| + +|cronJobSchedules +|array[link:#CronJobSchedule[CronJobSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|clusterProperties +|link:#OnPremClusterProperties[OnPremClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OnPremClusterProperties[OnPremClusterProperties] +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|cloudSyncProperties +|link:#CloudSyncProperties[CloudSyncProperties] +|False +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|capacityFeatures +|link:#OnPremCapacityFeatures[OnPremCapacityFeatures] +|False +a| + +|aff +|boolean +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "tenantId": "string", + "description": "string", + "name": "string", + "discoverUserEmail": "string", + "location": "string", + "status": { + "status": "string", + "message": "string", + "extendedFailureReason": "string" + }, + "interClusterLifs": [ + { + "name": "string", + "address": "string", + "port": "string", + "node": "string", + "status": "string" + } + ], + "cronJobSchedules": [ + { + "name": "string", + "description": "string", + "months": [ + "string" + ], + "days": [ + "string" + ], + "weekDays": [ + "string" + ], + "hours": [ + "string" + ], + "minutes": [ + "string" + ] + } + ], + "svms": [ + {} + ], + "snapshotPolicies": [ + { + "name": "string", + "schedules": [ + {} + ], + "description": "string" + } + ], + "replicationProperties": { + "peers": [ + "string" + ], + "replicationTargets": [ + "string" + ] + }, + "clusterProperties": { + "clusterAddress": "string", + "ontapVersion": "string", + "clusterName": "string", + "serialNumber": "string", + "systemId": "string", + "licenses": [ + "string" + ], + "systemManagerUrl": "string", + "clusterUuid": "string", + "nodeModels": [ + "string" + ], + "lifs": [ + {} + ] + }, + "ontapClusterProperties": { + "clusterAddress": "string", + "ontapVersion": "string", + "clusterName": "string", + "serialNumber": "string", + "systemId": "string", + "licenses": [ + "string" + ], + "systemManagerUrl": "string", + "clusterUuid": "string", + "nodeModels": [ + "string" + ], + "lifs": [ + {} + ] + }, + "workingEnvironmentType": "string", + "cloudSyncProperties": { + "status": { + "status": "string", + "failureMessage": "string" + }, + "dataBrokerProperties": { + "id": "string", + "name": "string", + "dataBrokerPlacement": { + "vpcId": "string", + "subnetId": "string", + "instanceType": "string", + "instanceId": "string", + "keyPair": "string" + } + }, + "s3Location": "string", + "relationships": [ + { + "volumeName": "string", + "svmName": "string", + "relationshipStatus": "string", + "s3Location": "string", + "id": "string", + "failureMessage": "string" + } + ] + }, + "actionsRequired": [ + {} + ], + "capacityFeatures": { + "objectStoreConfigExtended": { + "objectStoreConfig": { + "objectStoreName": "string", + "s3Name": "string", + "server": "string", + "providerType": "string" + }, + "tierLevel": "string" + } + }, + "cbsProperties": { + "cbsBackupStatus": "string", + "cbsRules": [ + { + "snapmirrorLabel": "string" + } + ], + "objectStoreName": "string", + "providerSpecific": { + "azureRgName": "string", + "gcpProjectId": "string", + "gcpRegion": "string" + }, + "cbsPolicyName": "string", + "ipSpace": "string", + "region": "string", + "providerAccountName": "string", + "exclusionReason": "string" + }, + "complianceProperties": { + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" + }, + "monitoringProperties": { + "monitoringStatus": "string", + "monitoringInfo": { + "averageLatency": { + "unit": "string" + }, + "storageAverageThroughput": { + "unit": "string" + }, + "node1AverageThroughput": { + "unit": "string" + }, + "node2AverageThroughput": { + "unit": "string" + } + }, + "tenantUrl": "string" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#InterClusterLif] +[.api-collapsible-fifth-title] +InterClusterLif + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|port +|string +|False +a| + +|node +|string +|False +a| + +|status +|string +|False +a| + +|isPeered +|boolean +|False +a| + +|=== + + +[#CronJobSchedule] +[.api-collapsible-fifth-title] +CronJobSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|description +|string +|False +a| + +|months +|array[string] +|True +a| + +|days +|array[string] +|False +a| + +|weekDays +|array[string] +|False +a| + +|hours +|array[string] +|False +a| + +|minutes +|array[string] +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#OnPremClusterProperties] +[.api-collapsible-fifth-title] +OnPremClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clusterAddress +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|clusterName +|string +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|isSnapmirrorLicenseExists +|boolean +|False +a| + +|licenses +|array[string] +|False +a| + +|systemManagerUrl +|string +|False +a| + +|location +|link:#Value[Value] +|False +a| + +|clusterUuid +|string +|False +a| + +|nodeModels +|array[string] +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|isAff +|boolean +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|sanOptimized +|boolean +|False +a| + +|disaggregated +|boolean +|False +a| + +|=== + + +[#CloudSyncStatus] +[.api-collapsible-fifth-title] +CloudSyncStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#DataBrokerPlacement] +[.api-collapsible-fifth-title] +DataBrokerPlacement + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|False +a| + +|subnetId +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|keyPair +|string +|False +a| + +|=== + + +[#DataBrokerProperties] +[.api-collapsible-fifth-title] +DataBrokerProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|dataBrokerPlacement +|link:#DataBrokerPlacement[DataBrokerPlacement] +|False +a| + +|=== + + +[#CloudSyncRelationship] +[.api-collapsible-fifth-title] +CloudSyncRelationship + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|relationshipStatus +|string +|False +a| + +|s3Location +|string +|False +a| + +|id +|string +|False +a| + +|progress +|integer +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#CloudSyncProperties] +[.api-collapsible-fifth-title] +CloudSyncProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSynced +|boolean +|False +a| + +|status +|link:#CloudSyncStatus[CloudSyncStatus] +|False +a| + +|dataBrokerProperties +|link:#DataBrokerProperties[DataBrokerProperties] +|False +a| + +|s3Location +|string +|False +a| + +|relationships +|array[link:#CloudSyncRelationship[CloudSyncRelationship]] +|False +a| + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ObjectStoreConfigInfo] +[.api-collapsible-fifth-title] +ObjectStoreConfigInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectStoreName +|string +|False +a| + +|s3Name +|string +|False +a| + +|usedSpace +|link:#Capacity[Capacity] +|False +a| + +|server +|string +|False +a| + +|providerType +|string +|False +a| + +|=== + + +[#ExtendedObjectStoreConfigInfo] +[.api-collapsible-fifth-title] +ExtendedObjectStoreConfigInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectStoreConfig +|link:#ObjectStoreConfigInfo[ObjectStoreConfigInfo] +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OnPremCapacityFeatures] +[.api-collapsible-fifth-title] +OnPremCapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectStoreConfigExtended +|link:#ExtendedObjectStoreConfigInfo[ExtendedObjectStoreConfigInfo] +|False +a| + +|performanceTierUsedCapacity +|link:#Capacity[Capacity] +|False +a| + +|inactiveUserData +|link:#Capacity[Capacity] +|False +a| + +|rawCapacity +|link:#Capacity[Capacity] +|False +a| + +|fiveYearSavings +|number +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-onprem-working-environments-cifs.adoc b/cvo/get-onprem-working-environments-cifs.adoc new file mode 100644 index 00000000..2f08b342 --- /dev/null +++ b/cvo/get-onprem-working-environments-cifs.adoc @@ -0,0 +1,110 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-onprem-working-environments-cifs.html' +summary: 'Retrieve a CIFS configuration for a system' +--- + += Retrieve a CIFS configuration for a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/onprem/working-environments/{workingEnvironmentId}/cifs`# + + + +Retrieves CIFS configuration for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|vserver +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|True +a|DNS domain name + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|authenticationType +|string +|True +a|Authentication type + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "activeDirectoryDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "authenticationType": "string" +} +==== + diff --git a/cvo/get-onprem-working-environments-ip-spaces.adoc b/cvo/get-onprem-working-environments-ip-spaces.adoc new file mode 100644 index 00000000..09220257 --- /dev/null +++ b/cvo/get-onprem-working-environments-ip-spaces.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-onprem-working-environments-ip-spaces.html' +summary: 'Retrieve an IPspace list for an existing system' +--- + += Retrieve an IPspace list for an existing system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/onprem/working-environments/{workingEnvironmentId}/ip-spaces`# + + + +Retrieves an IPspace list for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|vserver +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ipSpace +|string +|True +a| + +|vservers +|array[string] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "ipSpace": "string", + "vservers": [ + "string" + ] +} +==== + diff --git a/cvo/get-onprem-working-environments.adoc b/cvo/get-onprem-working-environments.adoc new file mode 100644 index 00000000..dfcad0c3 --- /dev/null +++ b/cvo/get-onprem-working-environments.adoc @@ -0,0 +1,1972 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-onprem-working-environments.html' +summary: 'Retrieve on-premises systems' +--- + += Retrieve on-premises systems + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/onprem/working-environments`# + + + +Retrieves on-premises systems visible to the current user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|tenantId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|tenantId +|string +|False +a| + +|description +|string +|False +a| + +|name +|string +|False +a| + +|discoverUserEmail +|string +|False +a| + +|location +|string +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|interClusterLifs +|array[link:#InterClusterLif[InterClusterLif]] +|True +a| + +|cronJobSchedules +|array[link:#CronJobSchedule[CronJobSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|clusterProperties +|link:#OnPremClusterProperties[OnPremClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OnPremClusterProperties[OnPremClusterProperties] +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|cloudSyncProperties +|link:#CloudSyncProperties[CloudSyncProperties] +|False +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|capacityFeatures +|link:#OnPremCapacityFeatures[OnPremCapacityFeatures] +|False +a| + +|aff +|boolean +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "tenantId": "string", + "description": "string", + "name": "string", + "discoverUserEmail": "string", + "location": "string", + "status": { + "status": "string", + "message": "string", + "extendedFailureReason": "string" + }, + "interClusterLifs": [ + { + "name": "string", + "address": "string", + "port": "string", + "node": "string", + "status": "string" + } + ], + "cronJobSchedules": [ + { + "name": "string", + "description": "string", + "months": [ + "string" + ], + "days": [ + "string" + ], + "weekDays": [ + "string" + ], + "hours": [ + "string" + ], + "minutes": [ + "string" + ] + } + ], + "svms": [ + {} + ], + "snapshotPolicies": [ + { + "name": "string", + "schedules": [ + {} + ], + "description": "string" + } + ], + "replicationProperties": { + "peers": [ + "string" + ], + "replicationTargets": [ + "string" + ] + }, + "clusterProperties": { + "clusterAddress": "string", + "ontapVersion": "string", + "clusterName": "string", + "serialNumber": "string", + "systemId": "string", + "licenses": [ + "string" + ], + "systemManagerUrl": "string", + "clusterUuid": "string", + "nodeModels": [ + "string" + ], + "lifs": [ + {} + ] + }, + "ontapClusterProperties": { + "clusterAddress": "string", + "ontapVersion": "string", + "clusterName": "string", + "serialNumber": "string", + "systemId": "string", + "licenses": [ + "string" + ], + "systemManagerUrl": "string", + "clusterUuid": "string", + "nodeModels": [ + "string" + ], + "lifs": [ + {} + ] + }, + "workingEnvironmentType": "string", + "cloudSyncProperties": { + "status": { + "status": "string", + "failureMessage": "string" + }, + "dataBrokerProperties": { + "id": "string", + "name": "string", + "dataBrokerPlacement": { + "vpcId": "string", + "subnetId": "string", + "instanceType": "string", + "instanceId": "string", + "keyPair": "string" + } + }, + "s3Location": "string", + "relationships": [ + { + "volumeName": "string", + "svmName": "string", + "relationshipStatus": "string", + "s3Location": "string", + "id": "string", + "failureMessage": "string" + } + ] + }, + "actionsRequired": [ + {} + ], + "capacityFeatures": { + "objectStoreConfigExtended": { + "objectStoreConfig": { + "objectStoreName": "string", + "s3Name": "string", + "server": "string", + "providerType": "string" + }, + "tierLevel": "string" + } + }, + "cbsProperties": { + "cbsBackupStatus": "string", + "cbsRules": [ + { + "snapmirrorLabel": "string" + } + ], + "objectStoreName": "string", + "providerSpecific": { + "azureRgName": "string", + "gcpProjectId": "string", + "gcpRegion": "string" + }, + "cbsPolicyName": "string", + "ipSpace": "string", + "region": "string", + "providerAccountName": "string", + "exclusionReason": "string" + }, + "complianceProperties": { + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" + }, + "monitoringProperties": { + "monitoringStatus": "string", + "monitoringInfo": { + "averageLatency": { + "unit": "string" + }, + "storageAverageThroughput": { + "unit": "string" + }, + "node1AverageThroughput": { + "unit": "string" + }, + "node2AverageThroughput": { + "unit": "string" + } + }, + "tenantUrl": "string" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#InterClusterLif] +[.api-collapsible-fifth-title] +InterClusterLif + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|port +|string +|False +a| + +|node +|string +|False +a| + +|status +|string +|False +a| + +|isPeered +|boolean +|False +a| + +|=== + + +[#CronJobSchedule] +[.api-collapsible-fifth-title] +CronJobSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|description +|string +|False +a| + +|months +|array[string] +|True +a| + +|days +|array[string] +|False +a| + +|weekDays +|array[string] +|False +a| + +|hours +|array[string] +|False +a| + +|minutes +|array[string] +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#OnPremClusterProperties] +[.api-collapsible-fifth-title] +OnPremClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clusterAddress +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|clusterName +|string +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|isSnapmirrorLicenseExists +|boolean +|False +a| + +|licenses +|array[string] +|False +a| + +|systemManagerUrl +|string +|False +a| + +|location +|link:#Value[Value] +|False +a| + +|clusterUuid +|string +|False +a| + +|nodeModels +|array[string] +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|isAff +|boolean +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|sanOptimized +|boolean +|False +a| + +|disaggregated +|boolean +|False +a| + +|=== + + +[#CloudSyncStatus] +[.api-collapsible-fifth-title] +CloudSyncStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#DataBrokerPlacement] +[.api-collapsible-fifth-title] +DataBrokerPlacement + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|False +a| + +|subnetId +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|keyPair +|string +|False +a| + +|=== + + +[#DataBrokerProperties] +[.api-collapsible-fifth-title] +DataBrokerProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|dataBrokerPlacement +|link:#DataBrokerPlacement[DataBrokerPlacement] +|False +a| + +|=== + + +[#CloudSyncRelationship] +[.api-collapsible-fifth-title] +CloudSyncRelationship + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|relationshipStatus +|string +|False +a| + +|s3Location +|string +|False +a| + +|id +|string +|False +a| + +|progress +|integer +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#CloudSyncProperties] +[.api-collapsible-fifth-title] +CloudSyncProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSynced +|boolean +|False +a| + +|status +|link:#CloudSyncStatus[CloudSyncStatus] +|False +a| + +|dataBrokerProperties +|link:#DataBrokerProperties[DataBrokerProperties] +|False +a| + +|s3Location +|string +|False +a| + +|relationships +|array[link:#CloudSyncRelationship[CloudSyncRelationship]] +|False +a| + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ObjectStoreConfigInfo] +[.api-collapsible-fifth-title] +ObjectStoreConfigInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectStoreName +|string +|False +a| + +|s3Name +|string +|False +a| + +|usedSpace +|link:#Capacity[Capacity] +|False +a| + +|server +|string +|False +a| + +|providerType +|string +|False +a| + +|=== + + +[#ExtendedObjectStoreConfigInfo] +[.api-collapsible-fifth-title] +ExtendedObjectStoreConfigInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectStoreConfig +|link:#ObjectStoreConfigInfo[ObjectStoreConfigInfo] +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OnPremCapacityFeatures] +[.api-collapsible-fifth-title] +OnPremCapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectStoreConfigExtended +|link:#ExtendedObjectStoreConfigInfo[ExtendedObjectStoreConfigInfo] +|False +a| + +|performanceTierUsedCapacity +|link:#Capacity[Capacity] +|False +a| + +|inactiveUserData +|link:#Capacity[Capacity] +|False +a| + +|rawCapacity +|link:#Capacity[Capacity] +|False +a| + +|fiveYearSavings +|number +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-replication-all-relationships.adoc b/cvo/get-replication-all-relationships.adoc new file mode 100644 index 00000000..e85db65e --- /dev/null +++ b/cvo/get-replication-all-relationships.adoc @@ -0,0 +1,127 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-replication-all-relationships.html' +summary: 'Return pairs of relationships' +--- + += Return pairs of relationships + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/replication/all-relationships`# + + + +Returns pairs of relationships. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workspaceId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|relationships +|array[link:#SourceTarget[SourceTarget]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "relationships": [ + { + "source": { + "id": "string" + }, + "target": { + "id": "string" + } + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Id] +[.api-collapsible-fifth-title] +Id + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|=== + + +[#SourceTarget] +[.api-collapsible-fifth-title] +SourceTarget + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|source +|link:#Id[Id] +|True +a| + +|target +|link:#Id[Id] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-replication-intercluster-lifs.adoc b/cvo/get-replication-intercluster-lifs.adoc new file mode 100644 index 00000000..3b802d46 --- /dev/null +++ b/cvo/get-replication-intercluster-lifs.adoc @@ -0,0 +1,149 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-replication-intercluster-lifs.html' +summary: 'Retrieve the intercluster LIFs' +--- + += Retrieve the intercluster LIFs + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/replication/intercluster-lifs`# + + + +Retrieves the intercluster LIFs used in a cluster peering relationship. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|peerWorkingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|interClusterLifs +|array[link:#ReplicationInterClusterLif[ReplicationInterClusterLif]] +|True +a|System Intercluster LIFs + + +|peerInterClusterLifs +|array[link:#ReplicationInterClusterLif[ReplicationInterClusterLif]] +|True +a|Peer system Intercluster Lifs + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "interClusterLifs": [ + {} + ], + "peerInterClusterLifs": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ReplicationInterClusterLif] +[.api-collapsible-fifth-title] +ReplicationInterClusterLif + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Specifies the name + + +|address +|string +|True +a|Address + + +|netmaskLength +|integer +|True +a|Netmask Length + + +|port +|string +|True +a|Port + + +|node +|string +|True +a|Node + + +|status +|string +|True +a|Status + + +|isPeered +|boolean +|True +a|Is Peered + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-replication-metadata-snapmirror-policies-.adoc b/cvo/get-replication-metadata-snapmirror-policies-.adoc new file mode 100644 index 00000000..89dbb2eb --- /dev/null +++ b/cvo/get-replication-metadata-snapmirror-policies-.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-replication-metadata-snapmirror-policies-.html' +summary: 'Retrieve SnapMirror policies' +--- + += Retrieve SnapMirror policies + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/replication/metadata/snapmirror-policies/{sourceWorkingEnvironmentId}/{targetWorkingEnvironmentId}`# + + + +Retrieves SnapMirror policies based on the source and destination Cloud Volumes ONTAP systems. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|sourceWorkingEnvironmentId +|string +|path +|True +a| + +|targetWorkingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|comment +|string +|False +a| + +|policyType +|string +|False +a| + +|rules +|array[link:#SnapMirrorRuleResponse[SnapMirrorRuleResponse]] +|True +a| + +|isDefault +|boolean +|False +a| + +|isSupported +|boolean +|False +a| + +|reason +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "comment": "string", + "policyType": "string", + "rules": [ + {} + ], + "reason": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SnapMirrorRuleResponse] +[.api-collapsible-fifth-title] +SnapMirrorRuleResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapMirrorLabel +|string +|False +a| + +|retention +|integer +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-replication-metadata-snapmirror-svm-policies--.adoc b/cvo/get-replication-metadata-snapmirror-svm-policies--.adoc new file mode 100644 index 00000000..22b2b6e5 --- /dev/null +++ b/cvo/get-replication-metadata-snapmirror-svm-policies--.adoc @@ -0,0 +1,147 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-replication-metadata-snapmirror-svm-policies--.html' +summary: 'Retrieve SnapMirror policies' +--- + += Retrieve SnapMirror policies + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/replication/metadata/snapmirror-svm-policies/{sourceWorkingEnvironmentId}/{svmName}/{targetWorkingEnvironmentId}`# + + + +Retrieves SnapMirror policies based on the source and destination Cloud Volumes ONTAP systems. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|sourceWorkingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|targetWorkingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|comment +|string +|False +a| + +|policyType +|string +|False +a| + +|rules +|array[link:#SnapMirrorRuleResponse[SnapMirrorRuleResponse]] +|True +a| + +|isDefault +|boolean +|False +a| + +|isSupported +|boolean +|False +a| + +|reason +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "comment": "string", + "policyType": "string", + "rules": [ + {} + ], + "reason": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SnapMirrorRuleResponse] +[.api-collapsible-fifth-title] +SnapMirrorRuleResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapMirrorLabel +|string +|False +a| + +|retention +|integer +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-replication-metadata-snapshot-labels--.adoc b/cvo/get-replication-metadata-snapshot-labels--.adoc new file mode 100644 index 00000000..4b7887f5 --- /dev/null +++ b/cvo/get-replication-metadata-snapshot-labels--.adoc @@ -0,0 +1,59 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-replication-metadata-snapshot-labels--.html' +summary: 'Return a list of snapshot labels' +--- + += Return a list of snapshot labels + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/replication/metadata/snapshot-labels/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Returns a list of snapshot labels from the volume that match labels in the provided list. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|labels +|array[string] +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/get-replication-schedules-.adoc b/cvo/get-replication-schedules-.adoc new file mode 100644 index 00000000..3578470b --- /dev/null +++ b/cvo/get-replication-schedules-.adoc @@ -0,0 +1,149 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-replication-schedules-.html' +summary: 'Retrieve the replication schedules of a system' +--- + += Retrieve the replication schedules of a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/replication/schedules/{workingEnvironmentId}`# + + + +Retrieves the replication schedules of a specific system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Specifies the name + + +|description +|string +|False +a|Description + + +|cronJobSchedule +|link:#CronJobScheduleResponse[CronJobScheduleResponse] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "description": "string", + "cronJobSchedule": { + "months": [ + "integer" + ], + "days": [ + "integer" + ], + "weekDays": [ + "integer" + ], + "hours": [ + "integer" + ], + "minutes": [ + "integer" + ] + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CronJobScheduleResponse] +[.api-collapsible-fifth-title] +CronJobScheduleResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|months +|array[integer] +|True +a|List of months + + +|days +|array[integer] +|True +a|List of days of the month + + +|weekDays +|array[integer] +|True +a|List of week days + + +|hours +|array[integer] +|True +a|List of hours + + +|minutes +|array[integer] +|True +a|List of minutes + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-replication-status-.adoc b/cvo/get-replication-status-.adoc new file mode 100644 index 00000000..e847d812 --- /dev/null +++ b/cvo/get-replication-status-.adoc @@ -0,0 +1,382 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-replication-status-.html' +summary: 'Retrieve SnapMirror replication relationship status' +--- + += Retrieve SnapMirror replication relationship status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/replication/status/{workingEnvironmentId}`# + + + +Retrieves the SnapMirror replication relationship status of a specific system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|source +|link:#ReplicationStatusSide[ReplicationStatusSide] +|True +a| + +|destination +|link:#ReplicationStatusSide[ReplicationStatusSide] +|True +a| + +|mirrorState +|string +|True +a|SnapMirror status + + +|relationshipType +|string +|True +a|SnapMirror relationship type + + +|relationshipStatus +|string +|True +a|SnapMirror relationship status + + +|relationshipProgress +|link:#Capacity[Capacity] +|True +a| + +|policy +|string +|True +a|Policy name + + +|policyType +|string +|True +a|Policy type + + +|schedule +|string +|True +a|Schedule name + + +|maxTransferRate +|link:#Capacity[Capacity] +|True +a| + +|networkCompressionRatio +|string +|True +a|Network compression ratio + + +|healthy +|boolean +|True +a|SnapMirror health + + +|unhealthyReason +|string +|True +a|The reason SnapMirror is unhealthy + + +|lagTime +|link:#Duration[Duration] +|True +a| + +|newestSnapshotName +|string +|True +a|Newest snapshot name + + +|newestSnapshotCreated +|string +|True +a|Newest snapshot creation time + + +|lastTransferInfo +|link:#ReplicationStatusLastTransferInfo[ReplicationStatusLastTransferInfo] +|True +a| + +|currentTransferInfo +|link:#ReplicationStatusCurrentTransferInfo[ReplicationStatusCurrentTransferInfo] +|True +a| + +|totalTransferTime +|link:#Duration[Duration] +|True +a| + +|totalTransferSize +|link:#Capacity[Capacity] +|True +a| + +|volumeUsedSize +|link:#Capacity[Capacity] +|True +a| + +|volumeCapacityTier +|link:#Capacity[Capacity] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ReplicationStatusSide] +[.api-collapsible-fifth-title] +ReplicationStatusSide + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|False +a|System ID + + +|workingEnvironmentType +|string +|False +a|System type + + +|workingEnvironmentStatus +|string +|False +a|System status + + +|clusterName +|string +|False +a|Cluster name + + +|region +|string +|False +a|AWS region name + + +|availabilityZone +|string +|False +a|AWS availability zone name + + +|svmName +|string +|False +a|SVM name + + +|svmPeerAliasName +|string +|False +a|SVM peer alias name + + +|nodeName +|string +|False +a|Node name + + +|volumeName +|string +|False +a|Volume name + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Duration] +[.api-collapsible-fifth-title] +Duration + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|False +a|Length + + +|unit +|string +|False +a|Unit + + +|=== + + +[#ReplicationStatusLastTransferInfo] +[.api-collapsible-fifth-title] +ReplicationStatusLastTransferInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|transferType +|string +|True +a|Last transfer type + + +|transferSize +|link:#Capacity[Capacity] +|True +a| + +|transferDuration +|link:#Duration[Duration] +|True +a| + +|transferEnded +|string +|True +a|Last transfer end time + + +|transferError +|string +|True +a|Last transfer error + + +|=== + + +[#ReplicationStatusCurrentTransferInfo] +[.api-collapsible-fifth-title] +ReplicationStatusCurrentTransferInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|transferType +|string +|True +a|Current transfer type + + +|transferPriority +|string +|True +a|Current transfer priority + + +|transferError +|string +|True +a|Current transfer error + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-replication-status.adoc b/cvo/get-replication-status.adoc new file mode 100644 index 00000000..c7583ed9 --- /dev/null +++ b/cvo/get-replication-status.adoc @@ -0,0 +1,382 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-replication-status.html' +summary: 'Retrieve the status of all SnapMirror relationships' +--- + += Retrieve the status of all SnapMirror relationships + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/replication/status`# + + + +Retrieves the status of all SnapMirror relationships. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|tenantId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|source +|link:#ReplicationStatusSide[ReplicationStatusSide] +|True +a| + +|destination +|link:#ReplicationStatusSide[ReplicationStatusSide] +|True +a| + +|mirrorState +|string +|True +a|SnapMirror status + + +|relationshipType +|string +|True +a|SnapMirror relationship type + + +|relationshipStatus +|string +|True +a|SnapMirror relationship status + + +|relationshipProgress +|link:#Capacity[Capacity] +|True +a| + +|policy +|string +|True +a|Policy name + + +|policyType +|string +|True +a|Policy type + + +|schedule +|string +|True +a|Schedule name + + +|maxTransferRate +|link:#Capacity[Capacity] +|True +a| + +|networkCompressionRatio +|string +|True +a|Network compression ratio + + +|healthy +|boolean +|True +a|SnapMirror health + + +|unhealthyReason +|string +|True +a|The reason SnapMirror is unhealthy + + +|lagTime +|link:#Duration[Duration] +|True +a| + +|newestSnapshotName +|string +|True +a|Newest snapshot name + + +|newestSnapshotCreated +|string +|True +a|Newest snapshot creation time + + +|lastTransferInfo +|link:#ReplicationStatusLastTransferInfo[ReplicationStatusLastTransferInfo] +|True +a| + +|currentTransferInfo +|link:#ReplicationStatusCurrentTransferInfo[ReplicationStatusCurrentTransferInfo] +|True +a| + +|totalTransferTime +|link:#Duration[Duration] +|True +a| + +|totalTransferSize +|link:#Capacity[Capacity] +|True +a| + +|volumeUsedSize +|link:#Capacity[Capacity] +|True +a| + +|volumeCapacityTier +|link:#Capacity[Capacity] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ReplicationStatusSide] +[.api-collapsible-fifth-title] +ReplicationStatusSide + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|False +a|System ID + + +|workingEnvironmentType +|string +|False +a|System type + + +|workingEnvironmentStatus +|string +|False +a|System status + + +|clusterName +|string +|False +a|Cluster name + + +|region +|string +|False +a|AWS region name + + +|availabilityZone +|string +|False +a|AWS availability zone name + + +|svmName +|string +|False +a|SVM name + + +|svmPeerAliasName +|string +|False +a|SVM peer alias name + + +|nodeName +|string +|False +a|Node name + + +|volumeName +|string +|False +a|Volume name + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Duration] +[.api-collapsible-fifth-title] +Duration + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|False +a|Length + + +|unit +|string +|False +a|Unit + + +|=== + + +[#ReplicationStatusLastTransferInfo] +[.api-collapsible-fifth-title] +ReplicationStatusLastTransferInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|transferType +|string +|True +a|Last transfer type + + +|transferSize +|link:#Capacity[Capacity] +|True +a| + +|transferDuration +|link:#Duration[Duration] +|True +a| + +|transferEnded +|string +|True +a|Last transfer end time + + +|transferError +|string +|True +a|Last transfer error + + +|=== + + +[#ReplicationStatusCurrentTransferInfo] +[.api-collapsible-fifth-title] +ReplicationStatusCurrentTransferInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|transferType +|string +|True +a|Current transfer type + + +|transferPriority +|string +|True +a|Current transfer priority + + +|transferError +|string +|True +a|Current transfer error + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-tenants-.adoc b/cvo/get-tenants-.adoc new file mode 100644 index 00000000..bc27c4c0 --- /dev/null +++ b/cvo/get-tenants-.adoc @@ -0,0 +1,192 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-tenants-.html' +summary: 'Retrieve a tenant' +--- + += Retrieve a tenant + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenants/{tenantId}`# + + + +Retrieves a tenant. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|tenantId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|publicId +|string +|False +a| + +|workingEnvironmentsInformation +|link:#WorkingEnvironmentsInformation[WorkingEnvironmentsInformation] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "publicId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#WorkingEnvironmentsInformation] +[.api-collapsible-fifth-title] +WorkingEnvironmentsInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionsCount +|integer +|False +a|Number of regions for which systems exist over this tenant + + +|totalReservedSize +|link:#Capacity[Capacity] +|False +a| + +|workingEnvironmentsCount +|integer +|False +a|Number of systems created over this tenant + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-tenants.adoc b/cvo/get-tenants.adoc new file mode 100644 index 00000000..def8cd1d --- /dev/null +++ b/cvo/get-tenants.adoc @@ -0,0 +1,186 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-tenants.html' +summary: 'Retrieve tenants' +--- + += Retrieve tenants + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenants`# + + + +Retrieves tenants that are visible to the current user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|publicId +|string +|False +a| + +|workingEnvironmentsInformation +|link:#WorkingEnvironmentsInformation[WorkingEnvironmentsInformation] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "publicId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#WorkingEnvironmentsInformation] +[.api-collapsible-fifth-title] +WorkingEnvironmentsInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionsCount +|integer +|False +a|Number of regions for which systems exist over this tenant + + +|totalReservedSize +|link:#Capacity[Capacity] +|False +a| + +|workingEnvironmentsCount +|integer +|False +a|Number of systems created over this tenant + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-users-.adoc b/cvo/get-users-.adoc new file mode 100644 index 00000000..576d57b6 --- /dev/null +++ b/cvo/get-users-.adoc @@ -0,0 +1,235 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-users-.html' +summary: 'Retrieve a user' +--- + += Retrieve a user + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/users/{userId}`# + + + +Retrieves a specific user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|userId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|User public ID + + +|assignedWorkingEnvironments +|array[string] +|True +a|List of public IDs for all of the systems visible to the user + + +|firstName +|string +|True +a|The first name of the user + + +|lastName +|string +|True +a|The last name of the user + + +|email +|string +|True +a|The email address of the user + + +|roleId +|string +|True +a|Role ID of the user + + +|tenantId +|string +|True +a|Tenant ID of the user + + +|createdWorkingEnvironments +|array[link:#UserWorkingEnvironmentResponse[UserWorkingEnvironmentResponse]] +|True +a|List of all systems created by the user + + +|azureCredentials +|link:#AzureCredentials[AzureCredentials] +|False +a| + +|cloudSyncLicenseInformation +|link:#CloudSyncLicenseInformation[CloudSyncLicenseInformation] +|False +a| + +|isLdap +|boolean +|True +a|Indicates whether the user is an LDAP user + + +|ldapUserName +|string +|True +a|The LDAP user name + + +|notificationsOptIn +|boolean +|True +a|Notification Opt-In + + +|permissions +|array[string] +|True +a|Permissions + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#UserWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +UserWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|System public ID + + +|name +|string +|True +a|System name + + +|workingEnvironmentType +|string +|True +a|System type + + +|=== + + +[#AzureCredentials] +[.api-collapsible-fifth-title] +AzureCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|False +a| + +|tenantId +|string +|False +a| + +|applicationId +|string +|False +a| + +|applicationKey +|string +|False +a| + +|=== + + +[#CloudSyncLicenseInformation] +[.api-collapsible-fifth-title] +CloudSyncLicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudSyncLicenseTypes +|array[string] +|False +a|Cloud sync license types + + +|licenseExpirationDate +|integer +|False +a|Cloud sync license expiration date + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-users.adoc b/cvo/get-users.adoc new file mode 100644 index 00000000..92f25a7c --- /dev/null +++ b/cvo/get-users.adoc @@ -0,0 +1,217 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-users.html' +summary: 'Retrieve all users' +--- + += Retrieve all users + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/users`# + + + +Retrieves all users visible to the current user. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|User public ID + + +|assignedWorkingEnvironments +|array[string] +|True +a|List of public IDs for all of the systems visible to the user + + +|firstName +|string +|True +a|The first name of the user + + +|lastName +|string +|True +a|The last name of the user + + +|email +|string +|True +a|The email address of the user + + +|roleId +|string +|True +a|Role ID of the user + + +|tenantId +|string +|True +a|Tenant ID of the user + + +|createdWorkingEnvironments +|array[link:#UserWorkingEnvironmentResponse[UserWorkingEnvironmentResponse]] +|True +a|List of all systems created by the user + + +|azureCredentials +|link:#AzureCredentials[AzureCredentials] +|False +a| + +|cloudSyncLicenseInformation +|link:#CloudSyncLicenseInformation[CloudSyncLicenseInformation] +|False +a| + +|isLdap +|boolean +|True +a|Indicates whether the user is an LDAP user + + +|ldapUserName +|string +|True +a|The LDAP user name + + +|notificationsOptIn +|boolean +|True +a|Notification Opt-In + + +|permissions +|array[string] +|True +a|Permissions + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#UserWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +UserWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|System public ID + + +|name +|string +|True +a|System name + + +|workingEnvironmentType +|string +|True +a|System type + + +|=== + + +[#AzureCredentials] +[.api-collapsible-fifth-title] +AzureCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|False +a| + +|tenantId +|string +|False +a| + +|applicationId +|string +|False +a| + +|applicationKey +|string +|False +a| + +|=== + + +[#CloudSyncLicenseInformation] +[.api-collapsible-fifth-title] +CloudSyncLicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudSyncLicenseTypes +|array[string] +|False +a|Cloud sync license types + + +|licenseExpirationDate +|integer +|False +a|Cloud sync license expiration date + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-aggregates.adoc b/cvo/get-vsa-aggregates.adoc new file mode 100644 index 00000000..395118a0 --- /dev/null +++ b/cvo/get-vsa-aggregates.adoc @@ -0,0 +1,404 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-aggregates.html' +summary: 'Retrieve aggregates' +--- + += Retrieve aggregates + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/aggregates`# + + + +Retrieves aggregates. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Aggregate name + + +|availableCapacity +|link:#Capacity[Capacity] +|True +a| + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|usedCapacity +|link:#Capacity[Capacity] +|True +a| + +|volumes +|array[link:#Volume[Volume]] +|True +a|Volumes + + +|providerVolumes +|array[link:#ProviderVolumeResponse[ProviderVolumeResponse]] +|True +a|Provider volumes + + +|disks +|array[link:#Disk[Disk]] +|True +a|Disks + + +|state +|string +|False +a|State + + +|encryptionType +|string +|True +a|Encryption Type + + +|encryptionKeyId +|string +|False +a|Encryption Key + + +|isRoot +|boolean +|True +a|Is Root + + +|homeNode +|string +|True +a|Home node + + +|ownerNode +|string +|False +a|Owner node + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsed +|link:#Capacity[Capacity] +|False +a| + +|sidlEnabled +|boolean +|True +a|SIDL enabled + + +|snaplockType +|string +|True +a|Snaplock type + + +|evCompatibilityType +|string +|True +a|Elastic Volume Compatibility Type + + +|iops +|link:#iops[iops] +|False +a|Aggregate IOPS + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Volume] +[.api-collapsible-fifth-title] +Volume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|totalSize +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioned +|boolean +|True +a|Indicates if the volume is thin-provisioned + + +|isClone +|boolean +|True +a|Indicates if the volume is a clone volume + + +|rootVolume +|boolean +|True +a|Indicates if the volume is the root volume of the SVM + + +|=== + + +[#ProviderVolumeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Specifies the ID + + +|name +|string +|True +a|Specifies the name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|state +|string +|True +a|State + + +|device +|string +|True +a|Device + + +|instanceId +|string +|True +a|InstanceId + + +|diskType +|string +|True +a|Type + + +|encrypted +|boolean +|True +a|Encrypted + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|instance2Id +|string +|False +a|Instance2Id + + +|=== + + +[#VmDiskProperties] +[.api-collapsible-fifth-title] +VmDiskProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectName +|string +|False +a| + +|storageAccountName +|string +|False +a| + +|containerName +|string +|False +a| + +|=== + + +[#Disk] +[.api-collapsible-fifth-title] +Disk + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Name + + +|containerType +|string +|True +a|Container type + + +|ownerNode +|string +|True +a|Owner node + + +|device +|string +|False +a|Device + + +|vmDiskProperties +|link:#VmDiskProperties[VmDiskProperties] +|False +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + +Aggregate IOPS + + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-discover.adoc b/cvo/get-vsa-discover.adoc new file mode 100644 index 00000000..47ab6079 --- /dev/null +++ b/cvo/get-vsa-discover.adoc @@ -0,0 +1,129 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-discover.html' +summary: 'Retrieve a list of discovered systems' +--- + += Retrieve a list of discovered systems + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/discover`# + + + +Retrieves a list of discovered systems visible to the current user in the specified AWS region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|publicId +|string +|False +a| + +|region +|string +|False +a| + +|vpcName +|string +|False +a| + +|vpcId +|string +|False +a| + +|availabilityZone +|string +|False +a| + +|subnetId +|string +|False +a| + +|stackName +|string +|False +a| + +|stackId +|string +|False +a| + +|clusterAddress +|string +|False +a| + +|recoverable +|boolean +|True +a| + +|isByol +|boolean +|False +a| + +|registered +|boolean +|False +a| + +|=== + + diff --git a/cvo/get-vsa-metadata-aws-encryption-keys.adoc b/cvo/get-vsa-metadata-aws-encryption-keys.adoc new file mode 100644 index 00000000..97eac27b --- /dev/null +++ b/cvo/get-vsa-metadata-aws-encryption-keys.adoc @@ -0,0 +1,120 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-aws-encryption-keys.html' +summary: 'Retrieve AWS encryption keys by region' +--- + += Retrieve AWS encryption keys by region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/aws-encryption-keys`# + + + +Retrieves AWS encryption keys for a specific region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "alias": "string", + "keyId": "string", + "status": "string", + "origin": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-metadata-buckets.adoc b/cvo/get-vsa-metadata-buckets.adoc new file mode 100644 index 00000000..32802a73 --- /dev/null +++ b/cvo/get-vsa-metadata-buckets.adoc @@ -0,0 +1,100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-buckets.html' +summary: 'Retrieve all S3 buckets' +--- + += Retrieve all S3 buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/buckets`# + + + +Retrieves all S3 buckets. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|tagsRequired +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|bucketName +|string +|True +a| + +|region +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|True +a| + +|empty +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-metadata-default-snapshot-policies.adoc b/cvo/get-vsa-metadata-default-snapshot-policies.adoc new file mode 100644 index 00000000..ecb35d61 --- /dev/null +++ b/cvo/get-vsa-metadata-default-snapshot-policies.adoc @@ -0,0 +1,100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-default-snapshot-policies.html' +summary: 'Retrieve default snapshot policies available on a cluster' +--- + += Retrieve default snapshot policies available on a cluster + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/default-snapshot-policies`# + + + +Retrieves the default snapshot policies available on a cluster. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "schedules": [ + {} + ], + "description": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-metadata-ebs-volume-types.adoc b/cvo/get-vsa-metadata-ebs-volume-types.adoc new file mode 100644 index 00000000..bbae8598 --- /dev/null +++ b/cvo/get-vsa-metadata-ebs-volume-types.adoc @@ -0,0 +1,94 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-ebs-volume-types.html' +summary: 'Retrieve supported EBS volume types' +--- + += Retrieve supported EBS volume types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/ebs-volume-types`# + + + +Retrieves supported EBS volume types. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|True +a| + +|size +|link:#Capacity[Capacity] +|True +a| + +|supportedVolumeTypes +|array[string] +|True +a| + +|supportedOccmLicenses +|array[string] +|False +a| + +|isDefault +|boolean +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-metadata-get-buckets-details.adoc b/cvo/get-vsa-metadata-get-buckets-details.adoc new file mode 100644 index 00000000..7f624d41 --- /dev/null +++ b/cvo/get-vsa-metadata-get-buckets-details.adoc @@ -0,0 +1,131 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-get-buckets-details.html' +summary: 'Retrieve all S3 buckets' +--- + += Retrieve all S3 buckets + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/get-buckets-details`# + + + +Retrieves all S3 buckets with additional information. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s3Buckets +|array[link:#S3BucketInfoDetails[S3BucketInfoDetails]] +|True +a| + +|totalBuckets +|integer +|True +a| + +|totalRegions +|integer +|False +a| + +|totalTieringTargets +|integer +|False +a| + +|totalBackupTargets +|integer +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|True +a| + +|empty +|boolean +|False +a| + +|=== + + +[#S3BucketInfoDetails] +[.api-collapsible-fifth-title] +S3BucketInfoDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|bucketName +|string +|True +a| + +|region +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|isTieringTarget +|boolean +|False +a| + +|isBackupTarget +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-metadata-instance-profiles.adoc b/cvo/get-vsa-metadata-instance-profiles.adoc new file mode 100644 index 00000000..6d8c243a --- /dev/null +++ b/cvo/get-vsa-metadata-instance-profiles.adoc @@ -0,0 +1,78 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-instance-profiles.html' +summary: 'Retrieve AWS instance profiles' +--- + += Retrieve AWS instance profiles + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/instance-profiles`# + + + +Retrieves AWS instance profiles. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceProfileId +|string +|True +a| + +|name +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceProfileId": "string", + "name": "string" +} +==== + diff --git a/cvo/get-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc b/cvo/get-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc new file mode 100644 index 00000000..97497837 --- /dev/null +++ b/cvo/get-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html' +summary: 'Retrieve unsupported instance types for acceleration and capacity tiering' +--- + += Retrieve unsupported instance types for acceleration and capacity tiering + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering`# + + + +Retrieves the instance types that do not support acceleration and capacity tiering. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceTypes +|array[link:#InstanceTypeResponse[InstanceTypeResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceTypes": [ + { + "instanceType": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#InstanceTypeResponse] +[.api-collapsible-fifth-title] +InstanceTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-metadata-key-pairs-by-region.adoc b/cvo/get-vsa-metadata-key-pairs-by-region.adoc new file mode 100644 index 00000000..9a890a67 --- /dev/null +++ b/cvo/get-vsa-metadata-key-pairs-by-region.adoc @@ -0,0 +1,96 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-key-pairs-by-region.html' +summary: 'Retrieve AWS user key pairs for all regions' +--- + += Retrieve AWS user key pairs for all regions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/key-pairs-by-region`# + + + +Retrieves AWS user Key Pairs for all regions. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionToKeyPairs +|link:#regionToKeyPairs[regionToKeyPairs] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#regionToKeyPairs] +[.api-collapsible-fifth-title] +regionToKeyPairs +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-metadata-key-pairs.adoc b/cvo/get-vsa-metadata-key-pairs.adoc new file mode 100644 index 00000000..4eda0064 --- /dev/null +++ b/cvo/get-vsa-metadata-key-pairs.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-key-pairs.html' +summary: 'Retrieve AWS user key pairs by region' +--- + += Retrieve AWS user key pairs by region + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/key-pairs`# + + + +Retrieves AWS user Key Pairs for a specific region. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/get-vsa-metadata-manifests.adoc b/cvo/get-vsa-metadata-manifests.adoc new file mode 100644 index 00000000..e6c7925d --- /dev/null +++ b/cvo/get-vsa-metadata-manifests.adoc @@ -0,0 +1,468 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-manifests.html' +summary: 'Retrieve all NetApp Console manifests' +--- + += Retrieve all NetApp Console manifests + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/manifests`# + + + +Retrieves all NetApp Console manifests. Refer to the API Developers Guide in order to understand how to extract valid region codes, license types, instance types and Cloud Volumes ONTAP version parameters for the creation of a Cloud Volumes ONTAP system. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|globalManifest +|link:#GlobalManifest[GlobalManifest] +|True +a| + +|ontapManifests +|array[link:#CloudOntapManifest[CloudOntapManifest]] +|True +a|ONTAP manifests + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#Region] +[.api-collapsible-fifth-title] +Region + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|code +|string +|False +a| + +|location +|string +|False +a| + +|s3Region +|string +|False +a| + +|=== + + +[#MapStringListString] +[.api-collapsible-fifth-title] +MapStringListString +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#cot_versions] +[.api-collapsible-fifth-title] +cot_versions +Hash mapping strings to link:#MapStringListString[MapStringListString] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#cot_versions_to_upgrade_to] +[.api-collapsible-fifth-title] +cot_versions_to_upgrade_to +Hash mapping strings to link:#MapStringListString[MapStringListString] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#FeatureProperties] +[.api-collapsible-fifth-title] +FeatureProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|start +|string +|False +a| + +|end +|string +|False +a| + +|excludedRegions +|array[string] +|False +a| + +|excludedLicenseTypes +|array[string] +|False +a| + +|=== + + +[#MapStringFeatureProperties] +[.api-collapsible-fifth-title] +MapStringFeatureProperties +Hash mapping strings to link:#FeatureProperties[FeatureProperties] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#supportedFeatures] +[.api-collapsible-fifth-title] +supportedFeatures +Hash mapping strings to link:#MapStringFeatureProperties[MapStringFeatureProperties] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#GlobalManifest] +[.api-collapsible-fifth-title] +GlobalManifest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|license_types +|array[link:#OntapLicenseType[OntapLicenseType]] +|True +a| + +|regions +|array[link:#Region[Region]] +|True +a| + +|azureRegions +|array[link:#Region[Region]] +|False +a| + +|gcpRegions +|array[link:#Region[Region]] +|False +a| + +|cot_versions +|link:#cot_versions[cot_versions] +|True +a| + +|cot_versions_to_upgrade_to +|link:#cot_versions_to_upgrade_to[cot_versions_to_upgrade_to] +|False +a| + +|supportedFeatures +|link:#supportedFeatures[supportedFeatures] +|True +a| + +|=== + + +[#RegionalAmi] +[.api-collapsible-fifth-title] +RegionalAmi + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|False +a| + +|ami_id +|string +|False +a| + +|saas_mp +|boolean +|False +a| + +|=== + + +[#LicenseToAmis] +[.api-collapsible-fifth-title] +LicenseToAmis + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|license_type +|string +|False +a| + +|instance_types +|array[string] +|False +a| + +|amis +|array[link:#RegionalAmi[RegionalAmi]] +|True +a| + +|=== + + +[#CloudOntapManifest] +[.api-collapsible-fifth-title] +CloudOntapManifest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontap_version +|string +|False +a| + +|ontap_image_versions_allowed_to_upgrade_from +|array[string] +|True +a| + +|encryption_enabled_instance_types +|array[string] +|False +a| + +|license_to_ami_mapping +|array[link:#LicenseToAmis[LicenseToAmis]] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-metadata-network-requirements.adoc b/cvo/get-vsa-metadata-network-requirements.adoc new file mode 100644 index 00000000..0fa30174 --- /dev/null +++ b/cvo/get-vsa-metadata-network-requirements.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-network-requirements.html' +summary: 'Retrieve the minimum number of required IP addresses' +--- + += Retrieve the minimum number of required IP addresses + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/network-requirements`# + + + +Retrieves the minimum number of required IP addresses for a single Cloud Volumes ONTAP system, HA node, and HA mediator. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nonHaNodeMinimumRequiredIps +|integer +|True +a| + +|haNodeMinimumRequiredIps +|integer +|False +a| + +|haMediatorMinimumRequiredIps +|integer +|False +a| + +|=== + + diff --git a/cvo/get-vsa-metadata-packages.adoc b/cvo/get-vsa-metadata-packages.adoc new file mode 100644 index 00000000..2153cee1 --- /dev/null +++ b/cvo/get-vsa-metadata-packages.adoc @@ -0,0 +1,187 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-packages.html' +summary: 'Retrieve package configurations' +--- + += Retrieve package configurations + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/packages`# + + + +Retrieves the packages configuration. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|deploymentModel +|string +|query +|False +a| + +|capacityPackage +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|displayName +|string +|False +a| + +|description +|string +|False +a| + +|licenseType +|string +|False +a| + +|instanceTypeMapping +|array[link:#InstanceTypeRegionMapping[InstanceTypeRegionMapping]] +|True +a| + +|diskType +|string +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|capacityTier +|string +|False +a| + +|instanceTenancy +|string +|False +a| + +|writingSpeedState +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|throughput +|link:#throughput[throughput] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#InstanceTypeRegionMapping] +[.api-collapsible-fifth-title] +InstanceTypeRegionMapping + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|False +a| + +|instanceType +|string +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#throughput] +[.api-collapsible-fifth-title] +throughput + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-metadata-permutations.adoc b/cvo/get-vsa-metadata-permutations.adoc new file mode 100644 index 00000000..db0bd810 --- /dev/null +++ b/cvo/get-vsa-metadata-permutations.adoc @@ -0,0 +1,197 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-permutations.html' +summary: 'Retrieve all Cloud Volumes ONTAP configurations' +--- + += Retrieve all Cloud Volumes ONTAP configurations + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/permutations`# + + + +Retrieves all Cloud Volumes ONTAP configurations. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a| + +|license +|link:#OntapLicenseType[OntapLicenseType] +|True +a| + +|instanceType +|string +|False +a| + +|region +|link:#Region[Region] +|True +a| + +|defaultInstance +|boolean +|False +a| + +|features +|array[string] +|True +a| + +|upgradeableFrom +|array[string] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#Region] +[.api-collapsible-fifth-title] +Region + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|code +|string +|False +a| + +|location +|string +|False +a| + +|s3Region +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-metadata-regions.adoc b/cvo/get-vsa-metadata-regions.adoc new file mode 100644 index 00000000..902e5cb3 --- /dev/null +++ b/cvo/get-vsa-metadata-regions.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-regions.html' +summary: 'Retrieve AWS regions' +--- + += Retrieve AWS regions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/regions`# + + + +Retrieves AWS regions over which a Cloud Volumes ONTAP system can be created. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|code +|string +|False +a| + +|location +|string +|False +a| + +|s3Region +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "code": "string", + "location": "string", + "s3Region": "string" +} +==== + diff --git a/cvo/get-vsa-metadata-s3-summary.adoc b/cvo/get-vsa-metadata-s3-summary.adoc new file mode 100644 index 00000000..60d01984 --- /dev/null +++ b/cvo/get-vsa-metadata-s3-summary.adoc @@ -0,0 +1,49 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-s3-summary.html' +summary: 'Retrieve S3 buckets summary' +--- + += Retrieve S3 buckets summary + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/s3-summary`# + + + +Retrieves the S3 buckets summary. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSupportable +|boolean +|True +a| + +|numOfBuckets +|integer +|True +a| + +|numOfRegions +|integer +|False +a| + +|=== + + diff --git a/cvo/get-vsa-metadata-supported-capacity-tiers.adoc b/cvo/get-vsa-metadata-supported-capacity-tiers.adoc new file mode 100644 index 00000000..01692fca --- /dev/null +++ b/cvo/get-vsa-metadata-supported-capacity-tiers.adoc @@ -0,0 +1,156 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-supported-capacity-tiers.html' +summary: 'Retrieve supported capacity tiers for EBS volume types' +--- + += Retrieve supported capacity tiers for EBS volume types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/supported-capacity-tiers`# + + + +Retrieves supported capacity tiers for EBS volume types. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|ontapVersion +|string +|query +|False +a| + +|dataEncryptionType +|string +|query +|False +a| + +|licenseType +|string +|query +|False +a| + +|instanceType +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-metadata-supported-features.adoc b/cvo/get-vsa-metadata-supported-features.adoc new file mode 100644 index 00000000..6bdec487 --- /dev/null +++ b/cvo/get-vsa-metadata-supported-features.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-supported-features.html' +summary: 'Retrieve supported features' +--- + += Retrieve supported features + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/supported-features`# + + + +Retrieves the supported features. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|ontapVersion +|string +|query +|False +a| + +|dataEncryptionType +|string +|query +|False +a| + +|licenseType +|string +|query +|False +a| + +|instanceType +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|wormSupportedVersion +|boolean +|True +a| + +|cbsSupportedVersion +|boolean +|False +a| + +|httpsStorageAccountSupportedVersion +|boolean +|False +a| + +|tieringWithServiceAccount +|boolean +|False +a| + +|s3CmkEncryptionSupportedVersion +|boolean +|False +a| + +|gp3SupportedVersion +|boolean +|False +a| + +|elasticVolumeSupportedAndEnabled +|boolean +|False +a| + +|wormWithComposeSupported +|boolean +|False +a| + +|isAzureFlashcacheSupported +|boolean +|False +a| + +|wormWithBackupSupported +|boolean +|False +a| + +|azureHaManagedDisksSupported +|boolean +|False +a| + +|awsLocalZones +|boolean +|False +a| + +|isAzureZonalSupported +|boolean +|False +a| + +|=== + + diff --git a/cvo/get-vsa-metadata-tag-keys.adoc b/cvo/get-vsa-metadata-tag-keys.adoc new file mode 100644 index 00000000..f91c1327 --- /dev/null +++ b/cvo/get-vsa-metadata-tag-keys.adoc @@ -0,0 +1,80 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-tag-keys.html' +summary: 'Retrieve all tag names' +--- + += Retrieve all tag names + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/tag-keys`# + + + +Retrieves all of the tag names. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a| + +|values +|array[string] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "key": "string", + "values": [ + "string" + ] +} +==== + diff --git a/cvo/get-vsa-metadata-vpcs.adoc b/cvo/get-vsa-metadata-vpcs.adoc new file mode 100644 index 00000000..87674162 --- /dev/null +++ b/cvo/get-vsa-metadata-vpcs.adoc @@ -0,0 +1,237 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-metadata-vpcs.html' +summary: 'Retrieve VPCs' +--- + += Retrieve VPCs + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/metadata/vpcs`# + + + +Retrieves VPCs. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|roleArn +|string +|query +|False +a| + +|cloudProviderAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|True +a|The VPC identifier + + +|state +|string +|True +a|The state of the VPC + + +|cidrBlock +|string +|True +a|VPC Classless Inter-Domain Routing (CIDR) block + + +|tags +|array[link:#VpcTagResponse[VpcTagResponse]] +|True +a|VPC tags + + +|default +|boolean +|True +a|Indicates whether the VPC is the default + + +|subnets +|array[link:#SubnetResponse[SubnetResponse]] +|True +a|Subnets associated with the VPC + + +|securityGroups +|array[link:#SecurityGroupResponse[SecurityGroupResponse]] +|True +a|Security groups associated with the VPC + + +|tenancy +|string +|True +a|Tenancy configuration for the VPC + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#VpcTagResponse] +[.api-collapsible-fifth-title] +VpcTagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|VPC tag key + + +|value +|string +|True +a|VPC tag value + + +|=== + + +[#SubnetResponse] +[.api-collapsible-fifth-title] +SubnetResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subnetId +|string +|True +a|Subnet ID + + +|cidr +|string +|True +a|CIDR + + +|subnetName +|string +|False +a|Subnet name + + +|availabilityZone +|string +|True +a|Availability zone + + +|availableIps +|integer +|True +a|The number of available IP addresses on the subnet + + +|minimumRequiredIps +|integer +|True +a|The minimum required IP addresses for the Cloud Volumes ONTAP create operation + +* format: int32 + + +|outpostArn +|string +|False +a|The ARN of the outpost + + +|=== + + +[#SecurityGroupResponse] +[.api-collapsible-fifth-title] +SecurityGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|securityGroupId +|string +|True +a|Security group ID + + +|description +|string +|True +a|Description + + +|name +|string +|True +a|Specifies the name + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-volumes--snapshots.adoc b/cvo/get-vsa-volumes--snapshots.adoc new file mode 100644 index 00000000..0da6f6ca --- /dev/null +++ b/cvo/get-vsa-volumes--snapshots.adoc @@ -0,0 +1,79 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-volumes--snapshots.html' +summary: 'Retrieve a list of snapshot descriptions for the volume' +--- + += Retrieve a list of snapshot descriptions for the volume + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots`# + + + +Returns a list of snapshot descriptions for the volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|accessTime +|integer +|True +a| + +|label +|string +|False +a| + +|=== + + diff --git a/cvo/get-vsa-volumes-igroups-.adoc b/cvo/get-vsa-volumes-igroups-.adoc new file mode 100644 index 00000000..e62a49d7 --- /dev/null +++ b/cvo/get-vsa-volumes-igroups-.adoc @@ -0,0 +1,219 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-volumes-igroups-.html' +summary: 'Retrieve all igroups' +--- + += Retrieve all igroups + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/volumes/igroups/{workingEnvironmentId}/{svmName}`# + + + +Retrieves all igroups. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|igroupName +|string +|True +a| + +|osType +|string +|False +a| + +|portsetName +|string +|False +a| + +|igroupType +|string +|True +a| + +|initiators +|array[string] +|True +a| + +|lunMaps +|array[link:#LunMapsLun[LunMapsLun]] +|True +a| + +|initiatorsWithConnStatus +|array[link:#InitiatorsConnectivityStateNameObject[InitiatorsConnectivityStateNameObject]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "igroupName": "string", + "osType": "string", + "portsetName": "string", + "igroupType": "string", + "initiators": [ + "string" + ], + "lunMaps": [ + { + "lun": { + "name": "string", + "uuid": "string" + } + } + ], + "initiatorsWithConnStatus": [ + { + "connectivity_tracking": { + "connection_state": "string" + }, + "name": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#NameUuidObject] +[.api-collapsible-fifth-title] +NameUuidObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|uuid +|string +|False +a| + +|=== + + +[#LunMapsLun] +[.api-collapsible-fifth-title] +LunMapsLun + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lun +|link:#NameUuidObject[NameUuidObject] +|True +a| + +|=== + + +[#ConnectionState] +[.api-collapsible-fifth-title] +ConnectionState + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connection_state +|string +|False +a| + +|=== + + +[#InitiatorsConnectivityStateNameObject] +[.api-collapsible-fifth-title] +InitiatorsConnectivityStateNameObject + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|connectivity_tracking +|link:#ConnectionState[ConnectionState] +|True +a| + +|name +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-volumes-initiator.adoc b/cvo/get-vsa-volumes-initiator.adoc new file mode 100644 index 00000000..8827b349 --- /dev/null +++ b/cvo/get-vsa-volumes-initiator.adoc @@ -0,0 +1,56 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-volumes-initiator.html' +summary: 'Retrieve all iSCSI initiators' +--- + += Retrieve all iSCSI initiators + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/volumes/initiator`# + + + +Retrieves all iSCSI initiators. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + diff --git a/cvo/get-vsa-volumes-volumes-for-backup.adoc b/cvo/get-vsa-volumes-volumes-for-backup.adoc new file mode 100644 index 00000000..5ddf152c --- /dev/null +++ b/cvo/get-vsa-volumes-volumes-for-backup.adoc @@ -0,0 +1,288 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-volumes-volumes-for-backup.html' +summary: 'Retrieve the volumes for backup activation' +--- + += Retrieve the volumes for backup activation + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/volumes/volumes-for-backup`# + + + +Retrieves all volumes for backup activation. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|offset +|integer +|query +|False +a| + +|limit +|integer +|query +|False +a| + +|search +|string +|query +|False +a| + +|filterBy +|link:#ListFilterByParam[ListFilterByParam] +|query +|False +a| + +|sortBy +|link:#ListSortByParam[ListSortByParam] +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumes +|array[link:#VolumeForBackupResponse[VolumeForBackupResponse]] +|True +a| + +|totalNumberOfVolumes +|integer +|True +a| + +|filteredNumberOfVolumes +|link:#filteredNumberOfVolumes[filteredNumberOfVolumes] +|False +a| + +|hasNextPage +|link:#hasNextPage[hasNextPage] +|False +a| + +|allowedValuesForVolumesListFilter +|link:#AllowedValuesForVolumesListFilter[AllowedValuesForVolumesListFilter] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ListFilterByParam] +[.api-collapsible-fifth-title] +ListFilterByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#ListSortByParam] +[.api-collapsible-fifth-title] +ListSortByParam + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|s +|string +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeForBackupResponse] +[.api-collapsible-fifth-title] +VolumeForBackupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|uuid +|string +|False +a| + +|svmName +|string +|False +a| + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|False +a| + +|state +|string +|False +a| + +|providerVolumeType +|string +|False +a| + +|volumeType +|string +|False +a| + +|isBackupOn +|boolean +|True +a| + +|disableReasonBackup +|array[string] +|True +a| + +|=== + + +[#filteredNumberOfVolumes] +[.api-collapsible-fifth-title] +filteredNumberOfVolumes + + +[#hasNextPage] +[.api-collapsible-fifth-title] +hasNextPage + + +[#AllowedValuesForVolumesListFilter] +[.api-collapsible-fifth-title] +AllowedValuesForVolumesListFilter + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeTypes +|array[string] +|False +a| + +|diskTypes +|array[string] +|False +a| + +|svmNames +|array[string] +|False +a| + +|volumeStatus +|array[string] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-volumes.adoc b/cvo/get-vsa-volumes.adoc new file mode 100644 index 00000000..b2ac6024 --- /dev/null +++ b/cvo/get-vsa-volumes.adoc @@ -0,0 +1,550 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-volumes.html' +summary: 'Retrieve volumes' +--- + += Retrieve volumes + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/volumes`# + + + +Retrieves all volumes. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Volume name + + +|uuid +|string +|True +a|Volume UUID + + +|svmName +|string +|True +a|Volume SVM name + + +|size +|link:#Capacity[Capacity] +|True +a| + +|usedSize +|link:#Capacity[Capacity] +|True +a| + +|junctionPath +|string +|True +a|The junction path at which this volume is mounted + + +|volumeTotalInodes +|integer +|False +a|Total volume inodes size + + +|volumeUsedInodes +|integer +|False +a|Used volume inodes size + + +|mountPoint +|string +|False +a|Mount Point + + +|compressionSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|deduplicationSpaceSaved +|link:#Capacity[Capacity] +|True +a| + +|thinProvisioning +|boolean +|True +a|Specifies whether thin provisioning is enabled + + +|compression +|boolean +|True +a|Specifies whether compression is enabled + + +|deduplication +|boolean +|True +a|Specifies whether deduplication is enabled + + +|snapshotPolicy +|string +|True +a|The name of the snapshot policy + + +|securityStyle +|string +|True +a|The type of the security style + + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|True +a| + +|shareNames +|array[string] +|True +a|The share names for CIFS + + +|shareInfo +|array[link:#CifsShareInfo[CifsShareInfo]] +|True +a|The share names, permissions, and users for CIFS + + +|parentVolumeName +|string +|True +a|Name of the parent flexible volume for the clone + + +|rootVolume +|boolean +|True +a|Flag to indicate if the volume is a SVM root + + +|state +|string +|True +a|Volume state + + +|volumeType +|string +|True +a|Volume type + + +|aggregateName +|string +|True +a|Aggregate name + + +|parentSnapshot +|string +|False +a|The snapshot name the volume is based on + + +|autoSizeMode +|string +|True +a|The operating mode of autosize + + +|maxGrowSize +|link:#Capacity[Capacity] +|True +a| + +|providerVolumeType +|string +|False +a|Cloud provider volume type + + +|cloneNames +|array[string] +|True +a|Names of cloned copies of the volume + + +|moving +|boolean +|True +a|Specifies if the volume move process is in progress + + +|primaryNoFailoverMountPoint +|string +|False +a|Primary mount point without failover + + +|secondaryNoFailoverMountPoint +|string +|False +a|Secondary mount point without failover + + +|capacityTier +|string +|False +a|Capacity tier + + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cifsShareAccessPoint +|string +|False +a|CIFS share access point + + +|primaryCifsShareAccessPoint +|string +|False +a|Primary CIFS share access point + + +|secondaryCifsShareAccessPoint +|string +|False +a|Secondary CIFS share access point + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|tierInactiveUserData +|link:#Capacity[Capacity] +|False +a| + +|tierInactiveUserDataPercent +|integer +|False +a|Tier inactive user data percentage + + +|comment +|string +|False +a|Volume comment + + +|qosPolicyGroupName +|string +|False +a|Quality of service policy group name + + +|snaplockType +|string +|False +a|SnapLock type + + +|constituentsAggregates +|array[string] +|True +a|Aggregates which are used for FlexGroup constituents + + +|snapshotsUsedSize +|link:#Capacity[Capacity] +|False +a| + +|cbsBackupsInfo +|link:#VolumeCbsInfo[VolumeCbsInfo] +|False +a| + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|targetName +|string +|True +a|iSCSI target IQN + + +|iscsiEnabled +|boolean +|True +a|Indicates if the volume is used by the iSCSI protocol + + +|isFlexGroupVolume +|boolean +|True +a|Indicates if the volume is a FlexGroup volume + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#VolumeCbsInfo] +[.api-collapsible-fifth-title] +VolumeCbsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalBackups +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-working-environments-.adoc b/cvo/get-vsa-working-environments-.adoc new file mode 100644 index 00000000..41ea30ba --- /dev/null +++ b/cvo/get-vsa-working-environments-.adoc @@ -0,0 +1,3254 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-.html' +summary: 'Retrieve a Cloud Volumes ONTAP system' +--- + += Retrieve a Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}`# + + + +Retrieves a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|awsProperties +|link:#AwsProperties[AwsProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|interClusterLifs +|array[link:#InterClusterLif[InterClusterLif]] +|True +a| + +|cronJobSchedules +|array[link:#CronJobSchedule[CronJobSchedule]] +|True +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|cloudProviderName +|string +|False +a| + +|isHA +|boolean +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|haProperties +|link:#AwsHaProperties[AwsHaProperties] +|False +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|cloudSyncProperties +|link:#CloudSyncProperties[CloudSyncProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags + +Instance tags + +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#InstanceResponse] +[.api-collapsible-fifth-title] +InstanceResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Instance ID + + +|name +|string +|True +a|Instance name + + +|instanceType +|string +|True +a|Instance type + + +|state +|string +|True +a|Instance state + + +|publicIpAddress +|string +|True +a|Public IP address that is assigned to the instance + + +|privateIpAddress +|string +|True +a|Private IP address that is assigned to the instance + + +|publicDnsName +|string +|True +a|Public DNS + + +|privateDnsName +|string +|True +a|Private DNS name + + +|imageId +|string +|True +a|Image ID + + +|subnetId +|string +|True +a|Subnet ID + + +|availabilityZone +|string +|True +a|Availability zone + + +|isVsaInstance +|boolean +|True +a|Indicates if the instance is a Cloud Volumes ONTAP instance + + +|isOCCMInstance +|boolean +|True +a|Indicates if the instance is a NetApp Console instance + + +|tags +|link:#tags[tags] +|True +a|Instance tags + + +|productCode +|string +|True +a|Product code + + +|tenancy +|string +|True +a|Instance Tenancy + + +|placementGroup +|string +|True +a|Placement group + + +|keyPairName +|string +|True +a|Key pair + + +|instanceProfileId +|string +|False +a|Instance profile ID + + +|=== + + +[#VpcTagResponse] +[.api-collapsible-fifth-title] +VpcTagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|VPC tag key + + +|value +|string +|True +a|VPC tag value + + +|=== + + +[#VpcBasicResponse] +[.api-collapsible-fifth-title] +VpcBasicResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|True +a|The VPC identifier + + +|state +|string +|True +a|The state of the VPC + + +|cidrBlock +|string +|True +a|VPC Classless Inter-Domain Routing (CIDR) block + + +|tags +|array[link:#VpcTagResponse[VpcTagResponse]] +|True +a|VPC tags + + +|default +|boolean +|True +a|Indicates whether the VPC is the default + + +|=== + + +[#bootDiskSize] +[.api-collapsible-fifth-title] +bootDiskSize + + +[#coreDiskExists] +[.api-collapsible-fifth-title] +coreDiskExists + + +[#AwsProperties] +[.api-collapsible-fifth-title] +AwsProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|availabilityZones +|array[string] +|False +a| + +|instances +|array[link:#InstanceResponse[InstanceResponse]] +|False +a| + +|vpc +|link:#VpcBasicResponse[VpcBasicResponse] +|False +a| + +|accountId +|string +|False +a| + +|roleArn +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|bootDiskSize +|link:#bootDiskSize[bootDiskSize] +|False +a| + +|outpostArn +|string +|False +a| + +|coreDiskExists +|link:#coreDiskExists[coreDiskExists] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#InterClusterLif] +[.api-collapsible-fifth-title] +InterClusterLif + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|port +|string +|False +a| + +|node +|string +|False +a| + +|status +|string +|False +a| + +|isPeered +|boolean +|False +a| + +|=== + + +[#CronJobSchedule] +[.api-collapsible-fifth-title] +CronJobSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|description +|string +|False +a| + +|months +|array[string] +|True +a| + +|days +|array[string] +|False +a| + +|weekDays +|array[string] +|False +a| + +|hours +|array[string] +|False +a| + +|minutes +|array[string] +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MediatorVersionInfo] +[.api-collapsible-fifth-title] +MediatorVersionInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|version +|string +|False +a| + +|description +|string +|False +a| + +|state +|string +|True +a| + +|bootVolumeId +|string +|False +a| + +|=== + + +[#MediatorStatus] +[.api-collapsible-fifth-title] +MediatorStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|statusCode +|integer +|False +a| + +|statusMessage +|string +|False +a| + +|=== + + +[#MediatorUpdateVersionMetadata] +[.api-collapsible-fifth-title] +MediatorUpdateVersionMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersion +|string +|False +a| + +|timeStamp +|integer +|False +a| + +|metadataFileName +|string +|False +a| + +|major +|boolean +|False +a| + +|manifestFileName +|string +|False +a| + +|=== + + +[#AwsHaProperties] +[.api-collapsible-fifth-title] +AwsHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersionInfo +|link:#MediatorVersionInfo[MediatorVersionInfo] +|False +a| + +|mediatorStatus +|link:#MediatorStatus[MediatorStatus] +|False +a| + +|routeTables +|array[string] +|False +a| + +|mediatorVersionsToUpdate +|array[link:#MediatorUpdateVersionMetadata[MediatorUpdateVersionMetadata]] +|False +a| + +|failoverMode +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#CloudSyncStatus] +[.api-collapsible-fifth-title] +CloudSyncStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#DataBrokerPlacement] +[.api-collapsible-fifth-title] +DataBrokerPlacement + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|False +a| + +|subnetId +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|keyPair +|string +|False +a| + +|=== + + +[#DataBrokerProperties] +[.api-collapsible-fifth-title] +DataBrokerProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|dataBrokerPlacement +|link:#DataBrokerPlacement[DataBrokerPlacement] +|False +a| + +|=== + + +[#CloudSyncRelationship] +[.api-collapsible-fifth-title] +CloudSyncRelationship + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|relationshipStatus +|string +|False +a| + +|s3Location +|string +|False +a| + +|id +|string +|False +a| + +|progress +|integer +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#CloudSyncProperties] +[.api-collapsible-fifth-title] +CloudSyncProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSynced +|boolean +|False +a| + +|status +|link:#CloudSyncStatus[CloudSyncStatus] +|False +a| + +|dataBrokerProperties +|link:#DataBrokerProperties[DataBrokerProperties] +|False +a| + +|s3Location +|string +|False +a| + +|relationships +|array[link:#CloudSyncRelationship[CloudSyncRelationship]] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-working-environments-cifs.adoc b/cvo/get-vsa-working-environments-cifs.adoc new file mode 100644 index 00000000..b32d8a10 --- /dev/null +++ b/cvo/get-vsa-working-environments-cifs.adoc @@ -0,0 +1,110 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-cifs.html' +summary: 'Retrieve a CIFS configuration for a system' +--- + += Retrieve a CIFS configuration for a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/cifs`# + + + +Retrieves the CIFS configuration for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svm +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|True +a|DNS domain name + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|authenticationType +|string +|True +a|Authentication type + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "activeDirectoryDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "authenticationType": "string" +} +==== + diff --git a/cvo/get-vsa-working-environments-cost-and-usage.adoc b/cvo/get-vsa-working-environments-cost-and-usage.adoc new file mode 100644 index 00000000..0f274bd9 --- /dev/null +++ b/cvo/get-vsa-working-environments-cost-and-usage.adoc @@ -0,0 +1,241 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-cost-and-usage.html' +summary: 'Retrieve systems cost and usage' +--- + += Retrieve systems cost and usage + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/cost-and-usage`# + + + +Retrieves the system cost and usage. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|start +|string +|query +|False +a| + +|end +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hasPermissions +|boolean +|True +a|Permissions to view the cost and usage details + + +|costByTime +|array[link:#CostByTime[CostByTime]] +|True +a|System cost and usage details + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Money] +[.api-collapsible-fifth-title] +Money + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|True +a|Amount + + +|currency +|string +|True +a|Currency + + +|=== + + +[#Usage] +[.api-collapsible-fifth-title] +Usage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|False +a|Amount + + +|units +|string +|True +a|Units + + +|=== + + +[#CostByUsage] +[.api-collapsible-fifth-title] +CostByUsage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Breakdown element name + + +|cost +|link:#Money[Money] +|True +a| + +|usage +|link:#Usage[Usage] +|True +a| + +|=== + + +[#CostByService] +[.api-collapsible-fifth-title] +CostByService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the cost domain (compute, disk/blob storage, object storage, data transfer) + + +|total +|link:#Money[Money] +|True +a| + +|costByUsage +|array[link:#CostByUsage[CostByUsage]] +|True +a|Cost domain breakdown + + +|=== + + +[#CostByTime] +[.api-collapsible-fifth-title] +CostByTime + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|start +|string +|True +a|Cost period start date + + +|end +|string +|True +a|Cost period end date + + +|estimated +|boolean +|True +a|Indicates whether the cost is estimated + + +|total +|link:#Money[Money] +|True +a| + +|costByService +|array[link:#CostByService[CostByService]] +|True +a|Monthly cost and usage details + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-working-environments-create-request-parameters.adoc b/cvo/get-vsa-working-environments-create-request-parameters.adoc new file mode 100644 index 00000000..36160cf6 --- /dev/null +++ b/cvo/get-vsa-working-environments-create-request-parameters.adoc @@ -0,0 +1,95 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-create-request-parameters.html' +summary: 'Retrieve the action parameters' +--- + += Retrieve the action parameters + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/create-request-parameters`# + + + +Retrieves the action parameters used in the create request for a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|parameters +|link:#MapStringObject[MapStringObject] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject + + +[#MapStringObject] +[.api-collapsible-fifth-title] +MapStringObject +Hash mapping strings to link:#MapStringObject[MapStringObject] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|True +a| + +|empty +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-working-environments-extra-capacity-licenses.adoc b/cvo/get-vsa-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..652e7ed7 --- /dev/null +++ b/cvo/get-vsa-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-extra-capacity-licenses.html' +summary: 'Retrieve extra capacity licenses' +--- + += Retrieve extra capacity licenses + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Retrieves extra capacity licenses for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serialNumber +|string +|True +a| + +|resourceId +|string +|False +a| + +|licenseType +|string +|False +a| + +|expirationDate +|integer +|True +a| + +|license +|string +|False +a| + +|capacity +|number +|True +a| + +|metadata +|string +|False +a| + +|associatedResourceId +|string +|False +a| + +|licensePackage +|string +|False +a| + +|accountId +|string +|False +a| + +|=== + + diff --git a/cvo/get-vsa-working-environments-license-instance-type.adoc b/cvo/get-vsa-working-environments-license-instance-type.adoc new file mode 100644 index 00000000..f1c36f24 --- /dev/null +++ b/cvo/get-vsa-working-environments-license-instance-type.adoc @@ -0,0 +1,146 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-license-instance-type.html' +summary: 'Retrieve all license types' +--- + += Retrieve all license types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/license-instance-type`# + + + +Retrieves all license types and their associated instance types for a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenseType +|string +|True +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|instanceTypes +|array[link:#InstanceTypeInfo[InstanceTypeInfo]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#InstanceTypeInfo] +[.api-collapsible-fifth-title] +InstanceTypeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|False +a| + +|supportsEncryption +|boolean +|True +a| + +|supportedFeatures +|array[string] +|True +a| + +|isDefault +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-working-environments-occm-provided-upgrade-versions.adoc b/cvo/get-vsa-working-environments-occm-provided-upgrade-versions.adoc new file mode 100644 index 00000000..737e04ac --- /dev/null +++ b/cvo/get-vsa-working-environments-occm-provided-upgrade-versions.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-occm-provided-upgrade-versions.html' +summary: 'Retrieve a list of upgrade versions' +--- + += Retrieve a list of upgrade versions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions`# + + + +Retrieves a list of versions to which this Cloud Volumes ONTAP system can be upgraded. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-vsa-working-environments-ontap-available-images.adoc b/cvo/get-vsa-working-environments-ontap-available-images.adoc new file mode 100644 index 00000000..006a3ba4 --- /dev/null +++ b/cvo/get-vsa-working-environments-ontap-available-images.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-ontap-available-images.html' +summary: 'Retrieve images already installed on the system' +--- + += Retrieve images already installed on the system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/ontap-available-images`# + + + +Retrieves images already installed on the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|version +|string +|False +a| + +|isCurrent +|boolean +|True +a| + +|=== + + diff --git a/cvo/get-vsa-working-environments-ontap-saving.adoc b/cvo/get-vsa-working-environments-ontap-saving.adoc new file mode 100644 index 00000000..f556d28f --- /dev/null +++ b/cvo/get-vsa-working-environments-ontap-saving.adoc @@ -0,0 +1,129 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-ontap-saving.html' +summary: 'Retrieve systems ONTAP savings' +--- + += Retrieve systems ONTAP savings + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/ontap-saving`# + + + +Retrieves system ONTAP savings. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|savings +|array[link:#SavingsInfo[SavingsInfo]] +|True +a|List of savings + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "savings": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Money] +[.api-collapsible-fifth-title] +Money + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|amount +|number +|True +a|Amount + + +|currency +|string +|True +a|Currency + + +|=== + + +[#SavingsInfo] +[.api-collapsible-fifth-title] +SavingsInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of saving element + + +|monthlySaving +|link:#Money[Money] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-working-environments-schedules.adoc b/cvo/get-vsa-working-environments-schedules.adoc new file mode 100644 index 00000000..ee8e5f4d --- /dev/null +++ b/cvo/get-vsa-working-environments-schedules.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-schedules.html' +summary: 'List the start/stop schedules' +--- + += List the start/stop schedules + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/schedules`# + + + +Lists the start/stop schedules for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "schedule": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-working-environments-support-registration.adoc b/cvo/get-vsa-working-environments-support-registration.adoc new file mode 100644 index 00000000..7ba3e35f --- /dev/null +++ b/cvo/get-vsa-working-environments-support-registration.adoc @@ -0,0 +1,101 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-support-registration.html' +summary: 'Retrieve the support registration status' +--- + += Retrieve the support registration status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/support-registration`# + + + +Retrieves the support registration status of a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|licenseStartDate +|link:#licenseStartDate[licenseStartDate] +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "nssAccountId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#licenseStartDate] +[.api-collapsible-fifth-title] +licenseStartDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-working-environments-update-eligibility.adoc b/cvo/get-vsa-working-environments-update-eligibility.adoc new file mode 100644 index 00000000..e8d989bc --- /dev/null +++ b/cvo/get-vsa-working-environments-update-eligibility.adoc @@ -0,0 +1,66 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-update-eligibility.html' +summary: 'Retrieve the eligibility support status' +--- + += Retrieve the eligibility support status + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/update-eligibility`# + + + +Retrieves the eligibility support status of a Cloud Volumes ONTAP system. Valid values are NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|eligibilityResponse +|string +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "eligibilityResponse": "string" +} +==== + diff --git a/cvo/get-vsa-working-environments-user-tags.adoc b/cvo/get-vsa-working-environments-user-tags.adoc new file mode 100644 index 00000000..02904a36 --- /dev/null +++ b/cvo/get-vsa-working-environments-user-tags.adoc @@ -0,0 +1,104 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-user-tags.html' +summary: 'Retrieve editable tags for cloud resources' +--- + += Retrieve editable tags for cloud resources + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/user-tags`# + + + +Retrieves the editable tags for the cloud resources in a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tags +|array[link:#CloudResourceTag[CloudResourceTag]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tags": [ + { + "tagKey": "string", + "tagValue": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudResourceTag] +[.api-collapsible-fifth-title] +CloudResourceTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|True +a| + +|tagValue +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-working-environments-validate-byol-to-capacity.adoc b/cvo/get-vsa-working-environments-validate-byol-to-capacity.adoc new file mode 100644 index 00000000..fd98e389 --- /dev/null +++ b/cvo/get-vsa-working-environments-validate-byol-to-capacity.adoc @@ -0,0 +1,214 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments-validate-byol-to-capacity.html' +summary: 'Validate prerequisites for converting a system' +--- + += Validate prerequisites for converting a system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity`# + + + +Validates the prerequisites for converting an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|validAccount +|boolean +|True +a| + +|validNss +|boolean +|False +a| + +|mpSub +|array[link:#CloudAccountResponse[CloudAccountResponse]] +|True +a| + +|capacityLicenses +|array[link:#CapacityLicenseInfo[CapacityLicenseInfo]] +|True +a| + +|totalPrimaryVolumes +|link:#Capacity[Capacity] +|True +a| + +|totalDpVolumes +|link:#Capacity[Capacity] +|False +a| + +|vmPlan +|string +|False +a| + +|awsOldDeployment +|boolean +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudAccountResponse] +[.api-collapsible-fifth-title] +CloudAccountResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudAccountId +|string +|True +a| + +|provider +|string +|False +a| + +|subscriptionId +|string +|False +a| + +|=== + + +[#TotalCapacity] +[.api-collapsible-fifth-title] +TotalCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacity +|integer +|True +a| + +|units +|string +|False +a| + +|=== + + +[#CapacityLicenseInfo] +[.api-collapsible-fifth-title] +CapacityLicenseInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|flavorType +|string +|False +a| + +|contractType +|string +|False +a| + +|totalLicensedCapacity +|link:#TotalCapacity[TotalCapacity] +|True +a| + +|totalConsumedCapacity +|link:#TotalCapacity[TotalCapacity] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-vsa-working-environments.adoc b/cvo/get-vsa-working-environments.adoc new file mode 100644 index 00000000..b0e04b89 --- /dev/null +++ b/cvo/get-vsa-working-environments.adoc @@ -0,0 +1,3254 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-vsa-working-environments.html' +summary: 'Retrieve Cloud Volumes ONTAP systems' +--- + += Retrieve Cloud Volumes ONTAP systems + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/vsa/working-environments`# + + + +Retrieves Cloud Volumes ONTAP systems visible to the current user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|tenantId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|awsProperties +|link:#AwsProperties[AwsProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|interClusterLifs +|array[link:#InterClusterLif[InterClusterLif]] +|True +a| + +|cronJobSchedules +|array[link:#CronJobSchedule[CronJobSchedule]] +|True +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|cloudProviderName +|string +|False +a| + +|isHA +|boolean +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|haProperties +|link:#AwsHaProperties[AwsHaProperties] +|False +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|cloudSyncProperties +|link:#CloudSyncProperties[CloudSyncProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags + +Instance tags + +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#InstanceResponse] +[.api-collapsible-fifth-title] +InstanceResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Instance ID + + +|name +|string +|True +a|Instance name + + +|instanceType +|string +|True +a|Instance type + + +|state +|string +|True +a|Instance state + + +|publicIpAddress +|string +|True +a|Public IP address that is assigned to the instance + + +|privateIpAddress +|string +|True +a|Private IP address that is assigned to the instance + + +|publicDnsName +|string +|True +a|Public DNS + + +|privateDnsName +|string +|True +a|Private DNS name + + +|imageId +|string +|True +a|Image ID + + +|subnetId +|string +|True +a|Subnet ID + + +|availabilityZone +|string +|True +a|Availability zone + + +|isVsaInstance +|boolean +|True +a|Indicates if the instance is a Cloud Volumes ONTAP instance + + +|isOCCMInstance +|boolean +|True +a|Indicates if the instance is a NetApp Console instance + + +|tags +|link:#tags[tags] +|True +a|Instance tags + + +|productCode +|string +|True +a|Product code + + +|tenancy +|string +|True +a|Instance Tenancy + + +|placementGroup +|string +|True +a|Placement group + + +|keyPairName +|string +|True +a|Key pair + + +|instanceProfileId +|string +|False +a|Instance profile ID + + +|=== + + +[#VpcTagResponse] +[.api-collapsible-fifth-title] +VpcTagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|VPC tag key + + +|value +|string +|True +a|VPC tag value + + +|=== + + +[#VpcBasicResponse] +[.api-collapsible-fifth-title] +VpcBasicResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|True +a|The VPC identifier + + +|state +|string +|True +a|The state of the VPC + + +|cidrBlock +|string +|True +a|VPC Classless Inter-Domain Routing (CIDR) block + + +|tags +|array[link:#VpcTagResponse[VpcTagResponse]] +|True +a|VPC tags + + +|default +|boolean +|True +a|Indicates whether the VPC is the default + + +|=== + + +[#bootDiskSize] +[.api-collapsible-fifth-title] +bootDiskSize + + +[#coreDiskExists] +[.api-collapsible-fifth-title] +coreDiskExists + + +[#AwsProperties] +[.api-collapsible-fifth-title] +AwsProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|availabilityZones +|array[string] +|False +a| + +|instances +|array[link:#InstanceResponse[InstanceResponse]] +|False +a| + +|vpc +|link:#VpcBasicResponse[VpcBasicResponse] +|False +a| + +|accountId +|string +|False +a| + +|roleArn +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|bootDiskSize +|link:#bootDiskSize[bootDiskSize] +|False +a| + +|outpostArn +|string +|False +a| + +|coreDiskExists +|link:#coreDiskExists[coreDiskExists] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#InterClusterLif] +[.api-collapsible-fifth-title] +InterClusterLif + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|port +|string +|False +a| + +|node +|string +|False +a| + +|status +|string +|False +a| + +|isPeered +|boolean +|False +a| + +|=== + + +[#CronJobSchedule] +[.api-collapsible-fifth-title] +CronJobSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|description +|string +|False +a| + +|months +|array[string] +|True +a| + +|days +|array[string] +|False +a| + +|weekDays +|array[string] +|False +a| + +|hours +|array[string] +|False +a| + +|minutes +|array[string] +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MediatorVersionInfo] +[.api-collapsible-fifth-title] +MediatorVersionInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|version +|string +|False +a| + +|description +|string +|False +a| + +|state +|string +|True +a| + +|bootVolumeId +|string +|False +a| + +|=== + + +[#MediatorStatus] +[.api-collapsible-fifth-title] +MediatorStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|statusCode +|integer +|False +a| + +|statusMessage +|string +|False +a| + +|=== + + +[#MediatorUpdateVersionMetadata] +[.api-collapsible-fifth-title] +MediatorUpdateVersionMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersion +|string +|False +a| + +|timeStamp +|integer +|False +a| + +|metadataFileName +|string +|False +a| + +|major +|boolean +|False +a| + +|manifestFileName +|string +|False +a| + +|=== + + +[#AwsHaProperties] +[.api-collapsible-fifth-title] +AwsHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersionInfo +|link:#MediatorVersionInfo[MediatorVersionInfo] +|False +a| + +|mediatorStatus +|link:#MediatorStatus[MediatorStatus] +|False +a| + +|routeTables +|array[string] +|False +a| + +|mediatorVersionsToUpdate +|array[link:#MediatorUpdateVersionMetadata[MediatorUpdateVersionMetadata]] +|False +a| + +|failoverMode +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#CloudSyncStatus] +[.api-collapsible-fifth-title] +CloudSyncStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#DataBrokerPlacement] +[.api-collapsible-fifth-title] +DataBrokerPlacement + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|False +a| + +|subnetId +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|keyPair +|string +|False +a| + +|=== + + +[#DataBrokerProperties] +[.api-collapsible-fifth-title] +DataBrokerProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|dataBrokerPlacement +|link:#DataBrokerPlacement[DataBrokerPlacement] +|False +a| + +|=== + + +[#CloudSyncRelationship] +[.api-collapsible-fifth-title] +CloudSyncRelationship + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|relationshipStatus +|string +|False +a| + +|s3Location +|string +|False +a| + +|id +|string +|False +a| + +|progress +|integer +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#CloudSyncProperties] +[.api-collapsible-fifth-title] +CloudSyncProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSynced +|boolean +|False +a| + +|status +|link:#CloudSyncStatus[CloudSyncStatus] +|False +a| + +|dataBrokerProperties +|link:#DataBrokerProperties[DataBrokerProperties] +|False +a| + +|s3Location +|string +|False +a| + +|relationships +|array[link:#CloudSyncRelationship[CloudSyncRelationship]] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-working-environments-.adoc b/cvo/get-working-environments-.adoc new file mode 100644 index 00000000..d7eba1a9 --- /dev/null +++ b/cvo/get-working-environments-.adoc @@ -0,0 +1,682 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-working-environments-.html' +summary: 'Retrieve a Cloud Volumes ONTAP system' +--- + += Retrieve a Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/working-environments/{workingEnvironmentId}`# + + + +Retrieves a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|isHA +|boolean +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|userTags +|link:#userTags[userTags] +|True +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#userTags] +[.api-collapsible-fifth-title] +userTags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-working-environments-actionrequired-.adoc b/cvo/get-working-environments-actionrequired-.adoc new file mode 100644 index 00000000..84a058c8 --- /dev/null +++ b/cvo/get-working-environments-actionrequired-.adoc @@ -0,0 +1,577 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-working-environments-actionrequired-.html' +summary: 'Retrieve all non-premises system actions for a tenant ID' +--- + += Retrieve all non-premises system actions for a tenant ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/working-environments/actionRequired/{tenantId}`# + + + +Returns all non-premises system actions required for a specific tenant ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|tenantId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|weActions +|array[link:#WeActionRequiredResponse[WeActionRequiredResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "weActions": [ + { + "publicId": "string", + "actions": [ + {} + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#WeActionRequiredResponse] +[.api-collapsible-fifth-title] +WeActionRequiredResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|actions +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-working-environments-by-capacity-byol-details-v2.adoc b/cvo/get-working-environments-by-capacity-byol-details-v2.adoc new file mode 100644 index 00000000..938f4981 --- /dev/null +++ b/cvo/get-working-environments-by-capacity-byol-details-v2.adoc @@ -0,0 +1,179 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-working-environments-by-capacity-byol-details-v2.html' +summary: 'Retrieve Cloud Volumes ONTAP capacity-based BYOL license metering details' +--- + += Retrieve Cloud Volumes ONTAP capacity-based BYOL license metering details + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/working-environments/by-capacity-byol-details-v2`# + + + +Returns capacity-based bring your own license (BYOL) license metering details. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenses +|array[link:#LicenseFlavorInfo[LicenseFlavorInfo]] +|True +a| + +|flavourAggregatedInfo +|array[link:#FlavourAggregatedInfo[FlavourAggregatedInfo]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licenses": [ + {} + ], + "flavourAggregatedInfo": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#LicenseFlavorInfo] +[.api-collapsible-fifth-title] +LicenseFlavorInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|True +a| + +|serialNumber +|string +|False +a| + +|expirationDate +|integer +|True +a| + +|capacity +|integer +|False +a| + +|flavorType +|string +|False +a| + +|metadata +|string +|False +a| + +|=== + + +[#TotalCapacity] +[.api-collapsible-fifth-title] +TotalCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacity +|integer +|True +a| + +|units +|string +|False +a| + +|=== + + +[#FlavourAggregatedInfo] +[.api-collapsible-fifth-title] +FlavourAggregatedInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|flavorType +|string +|False +a| + +|totalLicensedCapacity +|link:#TotalCapacity[TotalCapacity] +|True +a| + +|totalAllocatedLicensedCapacity +|link:#TotalCapacity[TotalCapacity] +|False +a| + +|totalConsumedCapacity +|link:#TotalCapacity[TotalCapacity] +|False +a| + +|totalPaygoCapacity +|link:#TotalCapacity[TotalCapacity] +|False +a| + +|contractType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/get-working-environments-exists-.adoc b/cvo/get-working-environments-exists-.adoc new file mode 100644 index 00000000..efb3d5b8 --- /dev/null +++ b/cvo/get-working-environments-exists-.adoc @@ -0,0 +1,43 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-working-environments-exists-.html' +summary: 'Check if a system with the specified name exists' +--- + += Check if a system with the specified name exists + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/working-environments/exists/{workingEnvironmentName}`# + + + +Checks if a system with the specified name already exists. Returns true if a system with that name already exists, false otherwise. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + + diff --git a/cvo/get-working-environments.adoc b/cvo/get-working-environments.adoc new file mode 100644 index 00000000..d54f055b --- /dev/null +++ b/cvo/get-working-environments.adoc @@ -0,0 +1,4969 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/get-working-environments.html' +summary: 'Retrieve all systems' +--- + += Retrieve all systems + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/working-environments`# + + + +Retrieves all systems. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|tenantId +|string +|query +|False +a| + +|fields +|link:#Expands[Expands] +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vsaWorkingEnvironments +|array[link:#VsaWorkingEnvironmentResponse[VsaWorkingEnvironmentResponse]] +|True +a| + +|onPremWorkingEnvironments +|array[link:#OnPremWorkingEnvironmentResponse[OnPremWorkingEnvironmentResponse]] +|True +a| + +|azureVsaWorkingEnvironments +|array[link:#AzureVsaWorkingEnvironmentResponse[AzureVsaWorkingEnvironmentResponse]] +|True +a| + +|gcpVsaWorkingEnvironments +|array[link:#GcpVsaWorkingEnvironmentResponse[GcpVsaWorkingEnvironmentResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "vsaWorkingEnvironments": [ + {} + ], + "onPremWorkingEnvironments": [ + { + "publicId": "string", + "tenantId": "string", + "description": "string", + "name": "string", + "discoverUserEmail": "string", + "location": "string", + "status": { + "status": "string", + "message": "string", + "extendedFailureReason": "string" + }, + "interClusterLifs": [ + { + "name": "string", + "address": "string", + "port": "string", + "node": "string", + "status": "string" + } + ], + "cronJobSchedules": [ + { + "name": "string", + "description": "string", + "months": [ + "string" + ], + "days": [ + "string" + ], + "weekDays": [ + "string" + ], + "hours": [ + "string" + ], + "minutes": [ + "string" + ] + } + ], + "svms": [ + {} + ], + "snapshotPolicies": [ + { + "name": "string", + "schedules": [ + {} + ], + "description": "string" + } + ], + "replicationProperties": { + "peers": [ + "string" + ], + "replicationTargets": [ + "string" + ] + }, + "clusterProperties": { + "clusterAddress": "string", + "ontapVersion": "string", + "clusterName": "string", + "serialNumber": "string", + "systemId": "string", + "licenses": [ + "string" + ], + "systemManagerUrl": "string", + "clusterUuid": "string", + "nodeModels": [ + "string" + ], + "lifs": [ + {} + ] + }, + "ontapClusterProperties": { + "clusterAddress": "string", + "ontapVersion": "string", + "clusterName": "string", + "serialNumber": "string", + "systemId": "string", + "licenses": [ + "string" + ], + "systemManagerUrl": "string", + "clusterUuid": "string", + "nodeModels": [ + "string" + ], + "lifs": [ + {} + ] + }, + "workingEnvironmentType": "string", + "cloudSyncProperties": { + "status": { + "status": "string", + "failureMessage": "string" + }, + "dataBrokerProperties": { + "id": "string", + "name": "string", + "dataBrokerPlacement": { + "vpcId": "string", + "subnetId": "string", + "instanceType": "string", + "instanceId": "string", + "keyPair": "string" + } + }, + "s3Location": "string", + "relationships": [ + { + "volumeName": "string", + "svmName": "string", + "relationshipStatus": "string", + "s3Location": "string", + "id": "string", + "failureMessage": "string" + } + ] + }, + "actionsRequired": [ + {} + ], + "capacityFeatures": { + "objectStoreConfigExtended": { + "objectStoreConfig": { + "objectStoreName": "string", + "s3Name": "string", + "server": "string", + "providerType": "string" + }, + "tierLevel": "string" + } + }, + "cbsProperties": { + "cbsBackupStatus": "string", + "cbsRules": [ + { + "snapmirrorLabel": "string" + } + ], + "objectStoreName": "string", + "providerSpecific": { + "azureRgName": "string", + "gcpProjectId": "string", + "gcpRegion": "string" + }, + "cbsPolicyName": "string", + "ipSpace": "string", + "region": "string", + "providerAccountName": "string", + "exclusionReason": "string" + }, + "complianceProperties": { + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" + }, + "monitoringProperties": { + "monitoringStatus": "string", + "monitoringInfo": { + "averageLatency": { + "unit": "string" + }, + "storageAverageThroughput": { + "unit": "string" + }, + "node1AverageThroughput": { + "unit": "string" + }, + "node2AverageThroughput": { + "unit": "string" + } + }, + "tenantUrl": "string" + } + } + ], + "azureVsaWorkingEnvironments": [ + { + "publicId": "string", + "name": "string", + "tenantId": "string", + "svmName": "string", + "creatorUserEmail": "string", + "status": { + "status": "string", + "message": "string", + "extendedFailureReason": "string" + }, + "providerProperties": { + "regionName": "string", + "vnetCidr": "string", + "subscriptionId": "string", + "deploymentId": "string", + "instanceType": "string", + "subscriptionName": "string", + "cloudProviderAccountId": "string", + "dataDisks": [ + { + "name": "string", + "id": "string", + "caching": "string", + "accountType": "string", + "encryptionSet": "string" + } + ] + }, + "clusterProperties": { + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "clusterName": "string", + "ontapVersion": "string", + "accountId": "string", + "productCode": "string", + "amiId": "string", + "systemManagerUrl": "string", + "instanceId": "string", + "platformLicense": "string", + "instanceType": "string", + "publicIp": "string", + "publicDnsName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string" + }, + "ontapClusterProperties": { + "nodes": [ + { + "name": "string", + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "platformLicense": "string", + "platformSerialNumber": "string", + "cloudProviderId": "string" + } + ], + "clusterName": "string", + "clusterUuid": "string", + "ontapVersion": "string", + "systemManagerUrl": "string", + "licensePackageName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string", + "broadcastDomainInfos": [ + {} + ], + "capacityTierInfo": { + "s3BucketName": "string", + "tierLevel": "string" + }, + "userName": "string", + "vscanFileOperationDefaultProfile": "string" + }, + "cloudProviderName": "string", + "snapshotPolicies": [ + { + "name": "string", + "schedules": [ + {} + ], + "description": "string" + } + ], + "actionsRequired": [ + {} + ], + "activeActions": [ + "string" + ], + "replicationProperties": { + "peers": [ + "string" + ], + "replicationTargets": [ + "string" + ] + }, + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ], + "svms": [ + {} + ], + "workingEnvironmentType": "string", + "supportRegistrationProperties": { + "supportRegistrationStatus": "string" + }, + "supportRegistrationInformation": [ + { + "supportRegistrationStatus": "string", + "serialNumber": "string", + "nssAccountId": "string" + } + ], + "capacityFeatures": { + "providerVolumesType": [ + { + "supportedVolumeTypes": [ + "string" + ], + "maxDisksAllow": { + "reason": "string" + } + } + ], + "defaultProviderVolumeType": { + "diskType": "string", + "capacityTier": "string" + }, + "supportedCapacityTiers": { + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] + }, + "existingIops": [ + "object" + ] + }, + "encryptionProperties": { + "keyManagers": [ + { + "publicId": "string", + "name": "string", + "address": "string", + "usernameField": "string", + "usernameValue": "string", + "status": "string" + } + ], + "encryptionCertificates": [ + {} + ], + "awsEncryptionKey": { + "alias": "string", + "keyId": "string", + "status": "string", + "origin": "string" + } + }, + "haProperties": { + "loadBalancerName": "string", + "applicationSecurityGroupName": "string", + "azureHaDeploymentType": "string" + }, + "fpolicyProperties": { + "fileExtensions": [ + "string" + ] + }, + "saasProperties": { + "subscription": { + "id": "string", + "name": "string" + }, + "capacityLicensePackage": "string" + }, + "cbsProperties": { + "cbsBackupStatus": "string", + "cbsRules": [ + { + "snapmirrorLabel": "string" + } + ], + "objectStoreName": "string", + "providerSpecific": { + "azureRgName": "string", + "gcpProjectId": "string", + "gcpRegion": "string" + }, + "cbsPolicyName": "string", + "ipSpace": "string", + "region": "string", + "providerAccountName": "string", + "exclusionReason": "string" + }, + "complianceProperties": { + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" + }, + "monitoringProperties": { + "monitoringStatus": "string", + "monitoringInfo": { + "averageLatency": { + "unit": "string" + }, + "storageAverageThroughput": { + "unit": "string" + }, + "node1AverageThroughput": { + "unit": "string" + }, + "node2AverageThroughput": { + "unit": "string" + } + }, + "tenantUrl": "string" + }, + "licensesInformation": [ + { + "type": "string", + "useType": "string", + "package": "string", + "serialNumbers": [ + "string" + ], + "expirations": [ + "object" + ] + } + ] + } + ], + "gcpVsaWorkingEnvironments": [ + {} + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Expand] +[.api-collapsible-fifth-title] +Expand + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|=== + + +[#Expands] +[.api-collapsible-fifth-title] +Expands + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|raw +|string +|True +a| + +|expands +|array[link:#Expand[Expand]] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags + +Instance tags + +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#InstanceResponse] +[.api-collapsible-fifth-title] +InstanceResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Instance ID + + +|name +|string +|True +a|Instance name + + +|instanceType +|string +|True +a|Instance type + + +|state +|string +|True +a|Instance state + + +|publicIpAddress +|string +|True +a|Public IP address that is assigned to the instance + + +|privateIpAddress +|string +|True +a|Private IP address that is assigned to the instance + + +|publicDnsName +|string +|True +a|Public DNS + + +|privateDnsName +|string +|True +a|Private DNS name + + +|imageId +|string +|True +a|Image ID + + +|subnetId +|string +|True +a|Subnet ID + + +|availabilityZone +|string +|True +a|Availability zone + + +|isVsaInstance +|boolean +|True +a|Indicates if the instance is a Cloud Volumes ONTAP instance + + +|isOCCMInstance +|boolean +|True +a|Indicates if the instance is a NetApp Console instance + + +|tags +|link:#tags[tags] +|True +a|Instance tags + + +|productCode +|string +|True +a|Product code + + +|tenancy +|string +|True +a|Instance Tenancy + + +|placementGroup +|string +|True +a|Placement group + + +|keyPairName +|string +|True +a|Key pair + + +|instanceProfileId +|string +|False +a|Instance profile ID + + +|=== + + +[#VpcTagResponse] +[.api-collapsible-fifth-title] +VpcTagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|VPC tag key + + +|value +|string +|True +a|VPC tag value + + +|=== + + +[#VpcBasicResponse] +[.api-collapsible-fifth-title] +VpcBasicResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|True +a|The VPC identifier + + +|state +|string +|True +a|The state of the VPC + + +|cidrBlock +|string +|True +a|VPC Classless Inter-Domain Routing (CIDR) block + + +|tags +|array[link:#VpcTagResponse[VpcTagResponse]] +|True +a|VPC tags + + +|default +|boolean +|True +a|Indicates whether the VPC is the default + + +|=== + + +[#bootDiskSize] +[.api-collapsible-fifth-title] +bootDiskSize + + +[#coreDiskExists] +[.api-collapsible-fifth-title] +coreDiskExists + + +[#AwsProperties] +[.api-collapsible-fifth-title] +AwsProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|availabilityZones +|array[string] +|False +a| + +|instances +|array[link:#InstanceResponse[InstanceResponse]] +|False +a| + +|vpc +|link:#VpcBasicResponse[VpcBasicResponse] +|False +a| + +|accountId +|string +|False +a| + +|roleArn +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|bootDiskSize +|link:#bootDiskSize[bootDiskSize] +|False +a| + +|outpostArn +|string +|False +a| + +|coreDiskExists +|link:#coreDiskExists[coreDiskExists] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#InterClusterLif] +[.api-collapsible-fifth-title] +InterClusterLif + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|port +|string +|False +a| + +|node +|string +|False +a| + +|status +|string +|False +a| + +|isPeered +|boolean +|False +a| + +|=== + + +[#CronJobSchedule] +[.api-collapsible-fifth-title] +CronJobSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|description +|string +|False +a| + +|months +|array[string] +|True +a| + +|days +|array[string] +|False +a| + +|weekDays +|array[string] +|False +a| + +|hours +|array[string] +|False +a| + +|minutes +|array[string] +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MediatorVersionInfo] +[.api-collapsible-fifth-title] +MediatorVersionInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|version +|string +|False +a| + +|description +|string +|False +a| + +|state +|string +|True +a| + +|bootVolumeId +|string +|False +a| + +|=== + + +[#MediatorStatus] +[.api-collapsible-fifth-title] +MediatorStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|statusCode +|integer +|False +a| + +|statusMessage +|string +|False +a| + +|=== + + +[#MediatorUpdateVersionMetadata] +[.api-collapsible-fifth-title] +MediatorUpdateVersionMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersion +|string +|False +a| + +|timeStamp +|integer +|False +a| + +|metadataFileName +|string +|False +a| + +|major +|boolean +|False +a| + +|manifestFileName +|string +|False +a| + +|=== + + +[#AwsHaProperties] +[.api-collapsible-fifth-title] +AwsHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersionInfo +|link:#MediatorVersionInfo[MediatorVersionInfo] +|False +a| + +|mediatorStatus +|link:#MediatorStatus[MediatorStatus] +|False +a| + +|routeTables +|array[string] +|False +a| + +|mediatorVersionsToUpdate +|array[link:#MediatorUpdateVersionMetadata[MediatorUpdateVersionMetadata]] +|False +a| + +|failoverMode +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#CloudSyncStatus] +[.api-collapsible-fifth-title] +CloudSyncStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#DataBrokerPlacement] +[.api-collapsible-fifth-title] +DataBrokerPlacement + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|False +a| + +|subnetId +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|keyPair +|string +|False +a| + +|=== + + +[#DataBrokerProperties] +[.api-collapsible-fifth-title] +DataBrokerProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|dataBrokerPlacement +|link:#DataBrokerPlacement[DataBrokerPlacement] +|False +a| + +|=== + + +[#CloudSyncRelationship] +[.api-collapsible-fifth-title] +CloudSyncRelationship + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|relationshipStatus +|string +|False +a| + +|s3Location +|string +|False +a| + +|id +|string +|False +a| + +|progress +|integer +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#CloudSyncProperties] +[.api-collapsible-fifth-title] +CloudSyncProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSynced +|boolean +|False +a| + +|status +|link:#CloudSyncStatus[CloudSyncStatus] +|False +a| + +|dataBrokerProperties +|link:#DataBrokerProperties[DataBrokerProperties] +|False +a| + +|s3Location +|string +|False +a| + +|relationships +|array[link:#CloudSyncRelationship[CloudSyncRelationship]] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +[#VsaWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +VsaWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|awsProperties +|link:#AwsProperties[AwsProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|interClusterLifs +|array[link:#InterClusterLif[InterClusterLif]] +|True +a| + +|cronJobSchedules +|array[link:#CronJobSchedule[CronJobSchedule]] +|True +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|cloudProviderName +|string +|False +a| + +|isHA +|boolean +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|haProperties +|link:#AwsHaProperties[AwsHaProperties] +|False +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|cloudSyncProperties +|link:#CloudSyncProperties[CloudSyncProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +[#OnPremClusterProperties] +[.api-collapsible-fifth-title] +OnPremClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clusterAddress +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|clusterName +|string +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|isSnapmirrorLicenseExists +|boolean +|False +a| + +|licenses +|array[string] +|False +a| + +|systemManagerUrl +|string +|False +a| + +|location +|link:#Value[Value] +|False +a| + +|clusterUuid +|string +|False +a| + +|nodeModels +|array[string] +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|isAff +|boolean +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|sanOptimized +|boolean +|False +a| + +|disaggregated +|boolean +|False +a| + +|=== + + +[#ObjectStoreConfigInfo] +[.api-collapsible-fifth-title] +ObjectStoreConfigInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectStoreName +|string +|False +a| + +|s3Name +|string +|False +a| + +|usedSpace +|link:#Capacity[Capacity] +|False +a| + +|server +|string +|False +a| + +|providerType +|string +|False +a| + +|=== + + +[#ExtendedObjectStoreConfigInfo] +[.api-collapsible-fifth-title] +ExtendedObjectStoreConfigInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectStoreConfig +|link:#ObjectStoreConfigInfo[ObjectStoreConfigInfo] +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OnPremCapacityFeatures] +[.api-collapsible-fifth-title] +OnPremCapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectStoreConfigExtended +|link:#ExtendedObjectStoreConfigInfo[ExtendedObjectStoreConfigInfo] +|False +a| + +|performanceTierUsedCapacity +|link:#Capacity[Capacity] +|False +a| + +|inactiveUserData +|link:#Capacity[Capacity] +|False +a| + +|rawCapacity +|link:#Capacity[Capacity] +|False +a| + +|fiveYearSavings +|number +|False +a| + +|=== + + +[#OnPremWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +OnPremWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|tenantId +|string +|False +a| + +|description +|string +|False +a| + +|name +|string +|False +a| + +|discoverUserEmail +|string +|False +a| + +|location +|string +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|interClusterLifs +|array[link:#InterClusterLif[InterClusterLif]] +|True +a| + +|cronJobSchedules +|array[link:#CronJobSchedule[CronJobSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|clusterProperties +|link:#OnPremClusterProperties[OnPremClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OnPremClusterProperties[OnPremClusterProperties] +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|cloudSyncProperties +|link:#CloudSyncProperties[CloudSyncProperties] +|False +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|capacityFeatures +|link:#OnPremCapacityFeatures[OnPremCapacityFeatures] +|False +a| + +|aff +|boolean +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#AzureResourceGroupResponse] +[.api-collapsible-fifth-title] +AzureResourceGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|location +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|=== + + +[#availabilityZone] +[.api-collapsible-fifth-title] +availabilityZone + + +[#AzureDataDiskResponse] +[.api-collapsible-fifth-title] +AzureDataDiskResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|diskSizeGB +|integer +|False +a| + +|lun +|integer +|False +a| + +|id +|string +|False +a| + +|caching +|string +|False +a| + +|accountType +|string +|False +a| + +|managed +|boolean +|False +a| + +|encryptionSet +|string +|False +a| + +|=== + + +[#AzureProperties] +[.api-collapsible-fifth-title] +AzureProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|resourceGroup +|link:#AzureResourceGroupResponse[AzureResourceGroupResponse] +|False +a| + +|vnetCidr +|string +|False +a| + +|tags +|link:#tags[tags] +|False +a| + +|subscriptionId +|string +|False +a| + +|deploymentId +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceType +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|singleNetworkInterface +|boolean +|False +a| + +|subscriptionName +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|dataDisks +|array[link:#AzureDataDiskResponse[AzureDataDiskResponse]] +|False +a| + +|=== + + +[#AzureAvailabilitySet] +[.api-collapsible-fifth-title] +AzureAvailabilitySet + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|faultDomain +|integer +|False +a| + +|updateDomain +|integer +|False +a| + +|=== + + +[#AzureHaNodeInfo] +[.api-collapsible-fifth-title] +AzureHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceId +|string +|False +a| + +|primaryIp +|string +|False +a| + +|state +|string +|False +a| + +|serialNumber +|string +|False +a| + +|availabilitySet +|link:#AzureAvailabilitySet[AzureAvailabilitySet] +|True +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|=== + + +[#AzureHaProperties] +[.api-collapsible-fifth-title] +AzureHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|loadBalancerName +|string +|False +a| + +|haEnabledOnLbRules +|boolean +|False +a| + +|node1Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|node2Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|multiZone +|boolean +|False +a| + +|applicationSecurityGroupName +|string +|False +a| + +|azureHaDeploymentType +|string +|False +a| + +|=== + + +[#AzureVsaWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AzureVsaWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#AzureProperties[AzureProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|False +a| + +|haProperties +|link:#AzureHaProperties[AzureHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +[#labels] +[.api-collapsible-fifth-title] +labels +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#GcpProperties] +[.api-collapsible-fifth-title] +GcpProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|regionName +|string +|False +a| + +|zoneName +|array[string] +|False +a| + +|instanceType +|string +|False +a| + +|subnetCidr +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|projectName +|string +|False +a| + +|deploymentName +|string +|False +a| + +|=== + + +[#GcpHaMediatorInfo] +[.api-collapsible-fifth-title] +GcpHaMediatorInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInstanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|version +|string +|False +a| + +|=== + + +[#GcpHaNodeInfo] +[.api-collapsible-fifth-title] +GcpHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|=== + + +[#GcpHaProperties] +[.api-collapsible-fifth-title] +GcpHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInfo +|link:#GcpHaMediatorInfo[GcpHaMediatorInfo] +|False +a| + +|node1Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|node2Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|projectName +|string +|False +a| + +|=== + + +[#GcpVsaWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +GcpVsaWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#GcpProperties[GcpProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|True +a| + +|haProperties +|link:#GcpHaProperties[GcpHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-accounts-aws-validate-creds.adoc b/cvo/post-accounts-aws-validate-creds.adoc new file mode 100644 index 00000000..ebc20fe3 --- /dev/null +++ b/cvo/post-accounts-aws-validate-creds.adoc @@ -0,0 +1,131 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-accounts-aws-validate-creds.html' +summary: 'Retrieve an AWS account ID for credentials' +--- + += Retrieve an AWS account ID for credentials + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/accounts/aws/validate-creds`# + + + +Retrieves an AWS cloud account ID for the specified credentials. + + + +CAUTION: This operation is deprecated. + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountName +|string +|False +a| + +|providerKeys +|link:#AwsKeysRequest[AwsKeysRequest] +|True +a| + +|subscriptionId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountName": "string", + "providerKeys": { + "awsAccessKeys": { + "accessKey": "string", + "secretKey": "string" + }, + "assumeRoleArn": "string" + }, + "subscriptionId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AwsAccessKeys] +[.api-collapsible-fifth-title] +AwsAccessKeys + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accessKey +|string +|True +a| + +|secretKey +|string +|False +a| + +|=== + + +[#AwsKeysRequest] +[.api-collapsible-fifth-title] +AwsKeysRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|awsAccessKeys +|link:#AwsAccessKeys[AwsAccessKeys] +|False +a| + +|assumeRoleArn +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-accounts-aws.adoc b/cvo/post-accounts-aws.adoc new file mode 100644 index 00000000..eeb84da6 --- /dev/null +++ b/cvo/post-accounts-aws.adoc @@ -0,0 +1,269 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-accounts-aws.html' +summary: 'Create an AWS account' +--- + += Create an AWS account + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/accounts/aws`# + + + +Creates an AWS account. + + + +CAUTION: This operation is deprecated. + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountName +|string +|False +a| + +|providerKeys +|link:#AwsKeysRequest[AwsKeysRequest] +|True +a| + +|subscriptionId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountName": "string", + "providerKeys": { + "awsAccessKeys": { + "accessKey": "string", + "secretKey": "string" + }, + "assumeRoleArn": "string" + }, + "subscriptionId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|accountId +|string +|False +a| + +|accessKey +|string +|False +a| + +|assumeRole +|link:#AssumeRole[AssumeRole] +|False +a| + +|occmRole +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|subscriptionId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "accountName": "string", + "accountType": "string", + "accountId": "string", + "accessKey": "string", + "assumeRole": { + "roleName": "string", + "accountId": "string" + }, + "occmRole": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ], + "subscriptionId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AwsAccessKeys] +[.api-collapsible-fifth-title] +AwsAccessKeys + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accessKey +|string +|True +a| + +|secretKey +|string +|False +a| + +|=== + + +[#AwsKeysRequest] +[.api-collapsible-fifth-title] +AwsKeysRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|awsAccessKeys +|link:#AwsAccessKeys[AwsAccessKeys] +|False +a| + +|assumeRoleArn +|string +|False +a| + +|=== + + +[#AssumeRole] +[.api-collapsible-fifth-title] +AssumeRole + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|roleName +|string +|False +a| + +|accountId +|string +|False +a| + +|isGov +|boolean +|False +a| + +|=== + + +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-accounts-azure-validate-creds.adoc b/cvo/post-accounts-azure-validate-creds.adoc new file mode 100644 index 00000000..d285ed5f --- /dev/null +++ b/cvo/post-accounts-azure-validate-creds.adoc @@ -0,0 +1,160 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-accounts-azure-validate-creds.html' +summary: 'Validate an Azure account request' +--- + += Validate an Azure account request + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/accounts/azure/validate-creds`# + + + +Validates an Azure account request. + + + +CAUTION: This operation is deprecated. + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountName +|string +|False +a| + +|providerKeys +|link:#AzureKeys[AzureKeys] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountName": "string", + "providerKeys": { + "tenantId": "string", + "applicationId": "string", + "applicationKey": "string", + "subscription": "string" + } +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|True +a| + +|name +|string +|False +a| + +|default +|boolean +|True +a| + +|saasSubscriptionId +|string +|False +a| + +|highAvailabilityEnabled +|link:#highAvailabilityEnabled[highAvailabilityEnabled] +|False +a| + +|vMOrchestratorZonalMultiFDEnabled +|link:#vMOrchestratorZonalMultiFDEnabled[vMOrchestratorZonalMultiFDEnabled] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AzureKeys] +[.api-collapsible-fifth-title] +AzureKeys + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tenantId +|string +|True +a| + +|applicationId +|string +|False +a| + +|applicationKey +|string +|False +a| + +|subscription +|string +|False +a|Subscription + + +|=== + + +[#highAvailabilityEnabled] +[.api-collapsible-fifth-title] +highAvailabilityEnabled + + +[#vMOrchestratorZonalMultiFDEnabled] +[.api-collapsible-fifth-title] +vMOrchestratorZonalMultiFDEnabled + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-accounts-azure.adoc b/cvo/post-accounts-azure.adoc new file mode 100644 index 00000000..690d85ea --- /dev/null +++ b/cvo/post-accounts-azure.adoc @@ -0,0 +1,205 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-accounts-azure.html' +summary: 'Create an Azure account' +--- + += Create an Azure account + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/accounts/azure`# + + + +Creates an Azure account. + + + +CAUTION: This operation is deprecated. + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountName +|string +|False +a| + +|providerKeys +|link:#AzureKeys[AzureKeys] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountName": "string", + "providerKeys": { + "tenantId": "string", + "applicationId": "string", + "applicationKey": "string", + "subscription": "string" + } +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|tenantId +|string +|False +a| + +|applicationId +|string +|False +a| + +|occmRole +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "accountName": "string", + "accountType": "string", + "tenantId": "string", + "applicationId": "string", + "occmRole": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AzureKeys] +[.api-collapsible-fifth-title] +AzureKeys + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tenantId +|string +|True +a| + +|applicationId +|string +|False +a| + +|applicationKey +|string +|False +a| + +|subscription +|string +|False +a|Subscription + + +|=== + + +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-accounts-gcp-validate-creds.adoc b/cvo/post-accounts-gcp-validate-creds.adoc new file mode 100644 index 00000000..41fbb403 --- /dev/null +++ b/cvo/post-accounts-gcp-validate-creds.adoc @@ -0,0 +1,96 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-accounts-gcp-validate-creds.html' +summary: 'Validate the Google Cloud account request' +--- + += Validate the Google Cloud account request + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/accounts/gcp/validate-creds`# + + + +Validates a Google Cloud provider account request. + + + +CAUTION: This operation is deprecated. + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountName +|string +|False +a| + +|providerKeys +|link:#GcpKeysForCloudStorageWithValidation[GcpKeysForCloudStorageWithValidation] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountName": "string", + "providerKeys": { + "accessKey": "string", + "secretKey": "string" + } +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#GcpKeysForCloudStorageWithValidation] +[.api-collapsible-fifth-title] +GcpKeysForCloudStorageWithValidation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accessKey +|string +|False +a| + +|secretKey +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-accounts-gcp.adoc b/cvo/post-accounts-gcp.adoc new file mode 100644 index 00000000..7f7560ab --- /dev/null +++ b/cvo/post-accounts-gcp.adoc @@ -0,0 +1,186 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-accounts-gcp.html' +summary: 'Create a Google Cloud storage account' +--- + += Create a Google Cloud storage account + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/accounts/gcp`# + + + +Creates a Google Cloud storage account. + + + +CAUTION: This operation is deprecated. + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountName +|string +|False +a| + +|providerKeys +|link:#GcpKeysForCloudStorageWithValidation[GcpKeysForCloudStorageWithValidation] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountName": "string", + "providerKeys": { + "accessKey": "string", + "secretKey": "string" + } +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|accessKey +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|occmRole +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "accountName": "string", + "accountType": "string", + "accessKey": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ], + "occmRole": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#GcpKeysForCloudStorageWithValidation] +[.api-collapsible-fifth-title] +GcpKeysForCloudStorageWithValidation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accessKey +|string +|False +a| + +|secretKey +|string +|False +a| + +|=== + + +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-accounts-nss.adoc b/cvo/post-accounts-nss.adoc new file mode 100644 index 00000000..bc606eae --- /dev/null +++ b/cvo/post-accounts-nss.adoc @@ -0,0 +1,185 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-accounts-nss.html' +summary: 'Create an NSS account' +--- + += Create an NSS account + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/accounts/nss`# + + + +Creates a NetApp Support Site account. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountName +|string +|False +a| + +|providerKeys +|link:#NssAccountCredentials[NssAccountCredentials] +|True +a| + +|vsaList +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountName": "string", + "providerKeys": { + "nssUserName": "string", + "nssPassword": "string" + }, + "vsaList": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|nssUserName +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "accountName": "string", + "accountType": "string", + "nssUserName": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#NssAccountCredentials] +[.api-collapsible-fifth-title] +NssAccountCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nssUserName +|string +|True +a| + +|nssPassword +|string +|False +a| + +|=== + + +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-auth-login.adoc b/cvo/post-auth-login.adoc new file mode 100644 index 00000000..f5c151c2 --- /dev/null +++ b/cvo/post-auth-login.adoc @@ -0,0 +1,59 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-auth-login.html' +summary: 'Sign in to the NetApp Console' +--- + += Sign in to the NetApp Console + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/auth/login`# + + + +Signs in to the NetApp Console. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|email +|string +|True +a|Email address of the user attempting to log in + + +|password +|string +|True +a|Password of the user attempting to log in + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "email": "string", + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-auth-logout.adoc b/cvo/post-auth-logout.adoc new file mode 100644 index 00000000..52f1501d --- /dev/null +++ b/cvo/post-auth-logout.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-auth-logout.html' +summary: 'Sign out of the NetApp Console' +--- + += Sign out of the NetApp Console + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/auth/logout`# + + + +Signs out of the NetApp Console. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-aggregates--add-capacity.adoc b/cvo/post-aws-ha-aggregates--add-capacity.adoc new file mode 100644 index 00000000..5680397a --- /dev/null +++ b/cvo/post-aws-ha-aggregates--add-capacity.adoc @@ -0,0 +1,101 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-aggregates--add-capacity.html' +summary: 'Add capacity to an elastic volume aggregate' +--- + += Add capacity to an elastic volume aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}/add-capacity`# + + + +Adds capacity to an existing elastic volume aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityToAdd +|link:#Capacity[Capacity] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-aws-ha-aggregates--disks.adoc b/cvo/post-aws-ha-aggregates--disks.adoc new file mode 100644 index 00000000..42fbec19 --- /dev/null +++ b/cvo/post-aws-ha-aggregates--disks.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-aggregates--disks.html' +summary: 'Add disks to an existing aggregate' +--- + += Add disks to an existing aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks`# + + + +Adds disks to an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|True +a|Number of disks + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-aggregates.adoc b/cvo/post-aws-ha-aggregates.adoc new file mode 100644 index 00000000..5dc49660 --- /dev/null +++ b/cvo/post-aws-ha-aggregates.adoc @@ -0,0 +1,137 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-aggregates.html' +summary: 'Create a new aggregate' +--- + += Create a new aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/aggregates`# + + + +Creates a new aggregate. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|workingEnvironmentId +|string +|True +a| + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|initialEvAggregateSize +|link:#Capacity[Capacity] +|False +a| + +|homeNode +|string +|False +a| + +|providerVolumeType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "workingEnvironmentId": "string", + "homeNode": "string", + "providerVolumeType": "string", + "capacityTier": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-aws-ha-discovery-recover.adoc b/cvo/post-aws-ha-discovery-recover.adoc new file mode 100644 index 00000000..d7b38386 --- /dev/null +++ b/cvo/post-aws-ha-discovery-recover.adoc @@ -0,0 +1,3281 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-discovery-recover.html' +summary: 'Save a previously discovered system' +--- + += Save a previously discovered system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/discovery/recover`# + + + +Saves a previously discovered Cloud Volumes ONTAP system to the NetApp Console database. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|True +a| + +|stackId +|string +|False +a| + +|clusterCredentials +|link:#ClusterCredentialsRequest[ClusterCredentialsRequest] +|True +a| + +|tenantId +|string +|False +a| + +|providerAccount +|string +|False +a|Role ARN to assume + + +|cloudProviderAccount +|string +|False +a|Cloud provider account + + +|nssAccountId +|string +|False +a|NetApp Support Site (NSS) account + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": "string", + "stackId": "string", + "clusterCredentials": { + "userName": "string", + "password": "string" + }, + "tenantId": "string", + "providerAccount": "string", + "cloudProviderAccount": "string", + "nssAccountId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|awsProperties +|link:#AwsProperties[AwsProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|interClusterLifs +|array[link:#InterClusterLif[InterClusterLif]] +|True +a| + +|cronJobSchedules +|array[link:#CronJobSchedule[CronJobSchedule]] +|True +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|cloudProviderName +|string +|False +a| + +|isHA +|boolean +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|haProperties +|link:#AwsHaProperties[AwsHaProperties] +|False +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|cloudSyncProperties +|link:#CloudSyncProperties[CloudSyncProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ClusterCredentialsRequest] +[.api-collapsible-fifth-title] +ClusterCredentialsRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|userName +|string +|True +a| + +|password +|string +|False +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags + +Instance tags + +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#InstanceResponse] +[.api-collapsible-fifth-title] +InstanceResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Instance ID + + +|name +|string +|True +a|Instance name + + +|instanceType +|string +|True +a|Instance type + + +|state +|string +|True +a|Instance state + + +|publicIpAddress +|string +|True +a|Public IP address that is assigned to the instance + + +|privateIpAddress +|string +|True +a|Private IP address that is assigned to the instance + + +|publicDnsName +|string +|True +a|Public DNS + + +|privateDnsName +|string +|True +a|Private DNS name + + +|imageId +|string +|True +a|Image ID + + +|subnetId +|string +|True +a|Subnet ID + + +|availabilityZone +|string +|True +a|Availability zone + + +|isVsaInstance +|boolean +|True +a|Indicates if the instance is a Cloud Volumes ONTAP instance + + +|isOCCMInstance +|boolean +|True +a|Indicates if the instance is a NetApp Console instance + + +|tags +|link:#tags[tags] +|True +a|Instance tags + + +|productCode +|string +|True +a|Product code + + +|tenancy +|string +|True +a|Instance Tenancy + + +|placementGroup +|string +|True +a|Placement group + + +|keyPairName +|string +|True +a|Key pair + + +|instanceProfileId +|string +|False +a|Instance profile ID + + +|=== + + +[#VpcTagResponse] +[.api-collapsible-fifth-title] +VpcTagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|VPC tag key + + +|value +|string +|True +a|VPC tag value + + +|=== + + +[#VpcBasicResponse] +[.api-collapsible-fifth-title] +VpcBasicResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|True +a|The VPC identifier + + +|state +|string +|True +a|The state of the VPC + + +|cidrBlock +|string +|True +a|VPC Classless Inter-Domain Routing (CIDR) block + + +|tags +|array[link:#VpcTagResponse[VpcTagResponse]] +|True +a|VPC tags + + +|default +|boolean +|True +a|Indicates whether the VPC is the default + + +|=== + + +[#bootDiskSize] +[.api-collapsible-fifth-title] +bootDiskSize + + +[#coreDiskExists] +[.api-collapsible-fifth-title] +coreDiskExists + + +[#AwsProperties] +[.api-collapsible-fifth-title] +AwsProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|availabilityZones +|array[string] +|False +a| + +|instances +|array[link:#InstanceResponse[InstanceResponse]] +|False +a| + +|vpc +|link:#VpcBasicResponse[VpcBasicResponse] +|False +a| + +|accountId +|string +|False +a| + +|roleArn +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|bootDiskSize +|link:#bootDiskSize[bootDiskSize] +|False +a| + +|outpostArn +|string +|False +a| + +|coreDiskExists +|link:#coreDiskExists[coreDiskExists] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#InterClusterLif] +[.api-collapsible-fifth-title] +InterClusterLif + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|port +|string +|False +a| + +|node +|string +|False +a| + +|status +|string +|False +a| + +|isPeered +|boolean +|False +a| + +|=== + + +[#CronJobSchedule] +[.api-collapsible-fifth-title] +CronJobSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|description +|string +|False +a| + +|months +|array[string] +|True +a| + +|days +|array[string] +|False +a| + +|weekDays +|array[string] +|False +a| + +|hours +|array[string] +|False +a| + +|minutes +|array[string] +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MediatorVersionInfo] +[.api-collapsible-fifth-title] +MediatorVersionInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|version +|string +|False +a| + +|description +|string +|False +a| + +|state +|string +|True +a| + +|bootVolumeId +|string +|False +a| + +|=== + + +[#MediatorStatus] +[.api-collapsible-fifth-title] +MediatorStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|statusCode +|integer +|False +a| + +|statusMessage +|string +|False +a| + +|=== + + +[#MediatorUpdateVersionMetadata] +[.api-collapsible-fifth-title] +MediatorUpdateVersionMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersion +|string +|False +a| + +|timeStamp +|integer +|False +a| + +|metadataFileName +|string +|False +a| + +|major +|boolean +|False +a| + +|manifestFileName +|string +|False +a| + +|=== + + +[#AwsHaProperties] +[.api-collapsible-fifth-title] +AwsHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersionInfo +|link:#MediatorVersionInfo[MediatorVersionInfo] +|False +a| + +|mediatorStatus +|link:#MediatorStatus[MediatorStatus] +|False +a| + +|routeTables +|array[string] +|False +a| + +|mediatorVersionsToUpdate +|array[link:#MediatorUpdateVersionMetadata[MediatorUpdateVersionMetadata]] +|False +a| + +|failoverMode +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#CloudSyncStatus] +[.api-collapsible-fifth-title] +CloudSyncStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#DataBrokerPlacement] +[.api-collapsible-fifth-title] +DataBrokerPlacement + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|False +a| + +|subnetId +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|keyPair +|string +|False +a| + +|=== + + +[#DataBrokerProperties] +[.api-collapsible-fifth-title] +DataBrokerProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|dataBrokerPlacement +|link:#DataBrokerPlacement[DataBrokerPlacement] +|False +a| + +|=== + + +[#CloudSyncRelationship] +[.api-collapsible-fifth-title] +CloudSyncRelationship + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|relationshipStatus +|string +|False +a| + +|s3Location +|string +|False +a| + +|id +|string +|False +a| + +|progress +|integer +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#CloudSyncProperties] +[.api-collapsible-fifth-title] +CloudSyncProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSynced +|boolean +|False +a| + +|status +|link:#CloudSyncStatus[CloudSyncStatus] +|False +a| + +|dataBrokerProperties +|link:#DataBrokerProperties[DataBrokerProperties] +|False +a| + +|s3Location +|string +|False +a| + +|relationships +|array[link:#CloudSyncRelationship[CloudSyncRelationship]] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-aws-ha-encryption-key-managers-.adoc b/cvo/post-aws-ha-encryption-key-managers-.adoc new file mode 100644 index 00000000..868f643c --- /dev/null +++ b/cvo/post-aws-ha-encryption-key-managers-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-encryption-key-managers-.html' +summary: 'Add a key manager to a system' +--- + += Add a key manager to a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}`# + + + +Adds a key manager to the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|keyManagerIp +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-encryption-update-client-certificate.adoc b/cvo/post-aws-ha-encryption-update-client-certificate.adoc new file mode 100644 index 00000000..90d50ace --- /dev/null +++ b/cvo/post-aws-ha-encryption-update-client-certificate.adoc @@ -0,0 +1,92 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-encryption-update-client-certificate.html' +summary: 'Update client certificate on a system' +--- + += Update client certificate on a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/encryption/{workingEnvironmentId}/update-client-certificate`# + + + +Updates the client certificate on the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + diff --git a/cvo/post-aws-ha-encryption-update-key-manager-ca-certificate.adoc b/cvo/post-aws-ha-encryption-update-key-manager-ca-certificate.adoc new file mode 100644 index 00000000..49af9705 --- /dev/null +++ b/cvo/post-aws-ha-encryption-update-key-manager-ca-certificate.adoc @@ -0,0 +1,120 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-encryption-update-key-manager-ca-certificate.html' +summary: 'Update the key manager CA certificate on a system' +--- + += Update the key manager CA certificate on a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/encryption/{workingEnvironmentId}/update-key-manager-ca-certificate`# + + + +Updates the key manager certificate authority (CA) certificate on the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|keyManagerCaCertificateId +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "keyManagerCaCertificateId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + diff --git a/cvo/post-aws-ha-metadata-create-bucket.adoc b/cvo/post-aws-ha-metadata-create-bucket.adoc new file mode 100644 index 00000000..be5ee4ac --- /dev/null +++ b/cvo/post-aws-ha-metadata-create-bucket.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-metadata-create-bucket.html' +summary: 'Create a new S3 bucket' +--- + += Create a new S3 bucket + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/metadata/create-bucket`# + + + +Creates a new S3 bucket. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|bucketName +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-metadata-get-buckets-application-info.adoc b/cvo/post-aws-ha-metadata-get-buckets-application-info.adoc new file mode 100644 index 00000000..e9815d95 --- /dev/null +++ b/cvo/post-aws-ha-metadata-get-buckets-application-info.adoc @@ -0,0 +1,90 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-metadata-get-buckets-application-info.html' +summary: 'Retrieve the S3 buckets policy status and tiering level' +--- + += Retrieve the S3 buckets policy status and tiering level + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/metadata/get-buckets-application-info`# + + + +Retrieves the S3 buckets policy status and tiering level. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|buckets +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "buckets": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|bucketName +|string +|True +a| + +|tieringLevel +|string +|False +a| + +|accessData +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "bucketName": "string", + "tieringLevel": "string", + "accessData": "string" +} +==== + diff --git a/cvo/post-aws-ha-metadata-validate-floating-ips.adoc b/cvo/post-aws-ha-metadata-validate-floating-ips.adoc new file mode 100644 index 00000000..b54bae21 --- /dev/null +++ b/cvo/post-aws-ha-metadata-validate-floating-ips.adoc @@ -0,0 +1,152 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-metadata-validate-floating-ips.html' +summary: 'Validate HA floating IP addresses' +--- + += Validate HA floating IP addresses + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/metadata/validate-floating-ips`# + + + +Validates HA floating IP addresses. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|floatingIps +|link:#FloatingIps[FloatingIps] +|True +a| + +|routeTablesIds +|array[string] +|True +a| + +|vpcId +|string +|True +a| + +|region +|string +|False +a| + +|roleArn +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "floatingIps": { + "clusterFloatingIP": "string", + "dataFloatingIP": "string", + "dataFloatingIP2": "string", + "svmFloatingIP": "string" + }, + "routeTablesIds": [ + "string" + ], + "vpcId": "string", + "region": "string", + "roleArn": "string", + "cloudProviderAccountId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|result +|boolean +|True +a| + +|reasons +|array[string] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#FloatingIps] +[.api-collapsible-fifth-title] +FloatingIps + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clusterFloatingIP +|string +|False +a| + +|dataFloatingIP +|string +|False +a| + +|dataFloatingIP2 +|string +|False +a| + +|svmFloatingIP +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-aws-ha-metadata-validate-subscribed-to-ontap-cloud.adoc b/cvo/post-aws-ha-metadata-validate-subscribed-to-ontap-cloud.adoc new file mode 100644 index 00000000..a5f71f8c --- /dev/null +++ b/cvo/post-aws-ha-metadata-validate-subscribed-to-ontap-cloud.adoc @@ -0,0 +1,181 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-metadata-validate-subscribed-to-ontap-cloud.html' +summary: 'Confirm the current user subscription' +--- + += Confirm the current user subscription + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/metadata/validate-subscribed-to-ontap-cloud`# + + + +Validates that the current user is subscribed to the Cloud Volumes ONTAP product in Amazon marketplace. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|True +a| + +|subnetId +|string +|False +a| + +|vsaMetadata +|link:#VsaMetadataRequest[VsaMetadataRequest] +|True +a| + +|roleArn +|string +|False +a| + +|cloudProviderAccount +|string +|False +a| + +|securityGroupId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": "string", + "subnetId": "string", + "vsaMetadata": { + "ontapVersion": "string", + "licenseType": "string", + "instanceType": "string", + "platformSerialNumber": "string", + "providedLicense": "string", + "capacityPackageName": "string", + "keyStoneSubscription": "string" + }, + "roleArn": "string", + "cloudProviderAccount": "string", + "securityGroupId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|failureInfo +|string +|False +a| + +|isSubscribed +|boolean +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#VsaMetadataRequest] +[.api-collapsible-fifth-title] +VsaMetadataRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a|ONTAP version + + +|licenseType +|string +|True +a|License type + + +|instanceType +|string +|True +a|Instance type + + +|platformSerialNumber +|string +|False +a|Optional platform serial number + + +|providedLicense +|string +|False +a|Optional provided license + + +|capacityPackageName +|string +|False +a|Optional capacity-based package + + +|keyStoneSubscription +|string +|False +a|Keystone subscription ID + + +|useLatestVersion +|boolean +|False +a|Use the latest version + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-aws-ha-volumes--change-tier.adoc b/cvo/post-aws-ha-volumes--change-tier.adoc new file mode 100644 index 00000000..2ade6208 --- /dev/null +++ b/cvo/post-aws-ha-volumes--change-tier.adoc @@ -0,0 +1,229 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-volumes--change-tier.html' +summary: 'Update the underlying volume tier' +--- + += Update the underlying volume tier + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier`# + + + +Updates the underlying volume tier. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Target aggregate name + + +|numOfDisks +|integer +|True +a|Number of new disks needed + + +|newAggregate +|boolean +|True +a|Indicates if it is a newly created aggregate + + +|newDiskTypeName +|string +|True +a|New disk type name + + +|newCapacityTier +|string +|False +a|New capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|newTieringPolicy +|string +|False +a|New tiering policy + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-aws-ha-volumes--clone.adoc b/cvo/post-aws-ha-volumes--clone.adoc new file mode 100644 index 00000000..36e58dc1 --- /dev/null +++ b/cvo/post-aws-ha-volumes--clone.adoc @@ -0,0 +1,89 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-volumes--clone.html' +summary: 'Clone an existing volume' +--- + += Clone an existing volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone`# + + + +Clones an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newVolumeName +|string +|True +a|New volume name + + +|parentSnapshot +|string +|False +a|Snapshot name to use for the clone + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "newVolumeName": "string", + "parentSnapshot": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-volumes--move.adoc b/cvo/post-aws-ha-volumes--move.adoc new file mode 100644 index 00000000..21842632 --- /dev/null +++ b/cvo/post-aws-ha-volumes--move.adoc @@ -0,0 +1,203 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-volumes--move.html' +summary: 'Move an existing volume' +--- + += Move an existing volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move`# + + + +Moves an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|targetAggregateName +|string +|True +a|Target aggregate name + + +|numOfDisksToAdd +|integer +|True +a|Target aggregate number of disks to add + + +|createTargetAggregate +|boolean +|True +a|Specifies if the aggregate is a new target aggregate + + +|newDiskTypeName +|string +|False +a|New disk type for the volume + + +|newCapacityTier +|string +|False +a|New capacity tier + + +|newTieringPolicy +|string +|False +a|New tiering policy + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-aws-ha-volumes--snapshot.adoc b/cvo/post-aws-ha-volumes--snapshot.adoc new file mode 100644 index 00000000..b28502e0 --- /dev/null +++ b/cvo/post-aws-ha-volumes--snapshot.adoc @@ -0,0 +1,82 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-volumes--snapshot.html' +summary: 'Create a snapshot' +--- + += Create a snapshot + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Creates a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|string +|False +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-volumes-initiator.adoc b/cvo/post-aws-ha-volumes-initiator.adoc new file mode 100644 index 00000000..05e8e9cb --- /dev/null +++ b/cvo/post-aws-ha-volumes-initiator.adoc @@ -0,0 +1,59 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-volumes-initiator.html' +summary: 'Add an iSCSI initiator' +--- + += Add an iSCSI initiator + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/volumes/initiator`# + + + +Adds an iSCSI initiator. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-volumes-quote.adoc b/cvo/post-aws-ha-volumes-quote.adoc new file mode 100644 index 00000000..8fab84f1 --- /dev/null +++ b/cvo/post-aws-ha-volumes-quote.adoc @@ -0,0 +1,285 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-volumes-quote.html' +summary: 'Retrieve quotes for a new volume' +--- + += Retrieve quotes for a new volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/volumes/quote`# + + + +Retrieves quotes for a new volume. Returns the resource quote required for the requested volume. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|True +a|Cloud Volumes ONTAP system ID + + +|svmName +|string +|True +a|SVM name + + +|aggregateName +|string +|False +a|Optionally choose in which aggregate to create the volume + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|enableThinProvisioning +|boolean +|True +a|Enable thin provisioning on the volume + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|verifyNameUniqueness +|boolean +|True +a|Verify volume name uniqueness within the SVM + + +|capacityTier +|string +|False +a|Capacity tier + + +|isReplicationFlow +|boolean +|True +a|Is replication flow + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|aggregateName +|string +|True +a|The aggregate on which the requested volume will be created + + +|newAggregate +|boolean +|True +a|Is it a newly created aggregate + + +|autoVsaCapacityManagement +|boolean +|True +a|Indicates if automatic Cloud Volumes ONTAP capacity management is enabled + + +|elasticVolumeQuoteResponse +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-aws-ha-volumes.adoc b/cvo/post-aws-ha-volumes.adoc new file mode 100644 index 00000000..7b4d1a32 --- /dev/null +++ b/cvo/post-aws-ha-volumes.adoc @@ -0,0 +1,610 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-volumes.html' +summary: 'Create a new volume' +--- + += Create a new volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/volumes`# + + + +Creates a new volume. If the aggregateName and maxNumOfDisksApprovedToAdd properties are not populated, the response fails with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|createAggregateIfNotFound +|boolean +|query +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|True +a|Cloud Volumes ONTAP system ID + + +|svmName +|string +|True +a|SVM name + + +|aggregateName +|string +|True +a|Aggregate in which the volume will be created + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|True +a|Snapshot policy name + + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|iscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableThinProvisioning +|boolean +|True +a|Enable thin provisioning on the volume + + +|enableCompression +|boolean +|True +a|Enable compression on the volume + + +|enableDeduplication +|boolean +|True +a|Enable deduplication on the volume + + +|maxNumOfDisksApprovedToAdd +|integer +|True +a|Maximum number of disks approved to allocate + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|providerVolumeType +|string +|False +a|Provider volume type + + +|syncToS3 +|boolean +|True +a|Add a cloud sync relationship + + +|capacityTier +|string +|False +a|Capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|junctionPath +|string +|False +a|Junction path + + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|volumeTags +|array[link:#VolumeTags[VolumeTags]] +|True +a|Optionally, provide key-value pairs with which to tag the ONTAP volume using the App Template service. + + +|comment +|string +|False +a|Volume Comment + + +|flexGroupVolumeInfo +|link:#FlexGroupVolumeInfo[FlexGroupVolumeInfo] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +[#VolumeTags] +[.api-collapsible-fifth-title] +VolumeTags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|False +a| + +|tagValue +|string +|False +a| + +|=== + + +[#FlexGroupVolumeInfo] +[.api-collapsible-fifth-title] +FlexGroupVolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateList +|array[string] +|False +a|Names of aggregates for the FlexGroup volume + + +|numberOfConstituents +|integer +|False +a|Number of constituents for the FlexGroup volume + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-aws-ha-working-environments-change-serial.adoc b/cvo/post-aws-ha-working-environments-change-serial.adoc new file mode 100644 index 00000000..541cfe4c --- /dev/null +++ b/cvo/post-aws-ha-working-environments-change-serial.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-change-serial.html' +summary: 'Update the serial number of a system' +--- + += Update the serial number of a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/change-serial`# + + + +Updates the serial number of a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodeOne +|string +|True +a| + +|nodeTwo +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nodeOne": "string", + "nodeTwo": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments-change-tier-level.adoc b/cvo/post-aws-ha-working-environments-change-tier-level.adoc new file mode 100644 index 00000000..0971fc6d --- /dev/null +++ b/cvo/post-aws-ha-working-environments-change-tier-level.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-change-tier-level.html' +summary: 'Update the tier level' +--- + += Update the tier level + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/change-tier-level`# + + + +Updates the tier level. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|level +|string +|True +a|Update tier level + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "level": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments-cifs.adoc b/cvo/post-aws-ha-working-environments-cifs.adoc new file mode 100644 index 00000000..c604dd62 --- /dev/null +++ b/cvo/post-aws-ha-working-environments-cifs.adoc @@ -0,0 +1,121 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-cifs.html' +summary: 'Create a new CIFS configuration for a system' +--- + += Create a new CIFS configuration for a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/cifs`# + + + +Sets up a new CIFS configuration for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|False +a|DNS domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|activeDirectoryUsername +|string +|True +a|Active Directory username + + +|activeDirectoryPassword +|string +|True +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "activeDirectoryDomain": "string", + "activeDirectoryUsername": "string", + "activeDirectoryPassword": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments-delete-cifs.adoc b/cvo/post-aws-ha-working-environments-delete-cifs.adoc new file mode 100644 index 00000000..f57f4e66 --- /dev/null +++ b/cvo/post-aws-ha-working-environments-delete-cifs.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-delete-cifs.html' +summary: 'Delete the CIFS configuration for a system' +--- + += Delete the CIFS configuration for a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/delete-cifs`# + + + +Deletes the CIFS configuration of an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|activeDirectoryUsername +|string +|False +a|Active Directory username + + +|activeDirectoryPassword +|string +|False +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "activeDirectoryUsername": "string", + "activeDirectoryPassword": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments-enable-capacity-tiering.adoc b/cvo/post-aws-ha-working-environments-enable-capacity-tiering.adoc new file mode 100644 index 00000000..085db6fd --- /dev/null +++ b/cvo/post-aws-ha-working-environments-enable-capacity-tiering.adoc @@ -0,0 +1,81 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-enable-capacity-tiering.html' +summary: 'Enable capacity tiering' +--- + += Enable capacity tiering + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering`# + + + +Enables capacity tiering. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceProfileName +|string +|False +a| + +|gcpStorageAccountId +|string +|False +a| + +|storageAccountPrefix +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceProfileName": "string", + "gcpStorageAccountId": "string", + "storageAccountPrefix": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments-extra-capacity-licenses.adoc b/cvo/post-aws-ha-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..f06c7019 --- /dev/null +++ b/cvo/post-aws-ha-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-extra-capacity-licenses.html' +summary: 'Register an extra capacity license' +--- + += Register an extra capacity license + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Registers an extra capacity license. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licences +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licences": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments-extra-capacity-serials.adoc b/cvo/post-aws-ha-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..c73f32de --- /dev/null +++ b/cvo/post-aws-ha-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-extra-capacity-serials.html' +summary: 'Register extra capacity license serial numbers' +--- + += Register extra capacity license serial numbers + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Registers an extra capacity serial number. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments-ntp.adoc b/cvo/post-aws-ha-working-environments-ntp.adoc new file mode 100644 index 00000000..663d6651 --- /dev/null +++ b/cvo/post-aws-ha-working-environments-ntp.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-ntp.html' +summary: 'Set up an NTP server' +--- + += Set up an NTP server + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/ntp`# + + + +Sets up an NTP server. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ntpServer +|string +|True +a|NTPS server + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "ntpServer": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments-parse-license-file.adoc b/cvo/post-aws-ha-working-environments-parse-license-file.adoc new file mode 100644 index 00000000..ca5b5ae6 --- /dev/null +++ b/cvo/post-aws-ha-working-environments-parse-license-file.adoc @@ -0,0 +1,232 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-parse-license-file.html' +summary: 'Parse an uploaded cloud license file' +--- + += Parse an uploaded cloud license file + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/parse-license-file`# + + + +Parses an uploaded cloud license file. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|license +|string +|True +a| + +|serialNumber +|string +|False +a| + +|contractEndDate +|link:#contractEndDate[contractEndDate] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "license": "string", + "serialNumber": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +[#contractEndDate] +[.api-collapsible-fifth-title] +contractEndDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-aws-ha-working-environments-snapshot-policy.adoc b/cvo/post-aws-ha-working-environments-snapshot-policy.adoc new file mode 100644 index 00000000..43035fcc --- /dev/null +++ b/cvo/post-aws-ha-working-environments-snapshot-policy.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-snapshot-policy.html' +summary: 'Create a snapshot policy' +--- + += Create a snapshot policy + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/snapshot-policy`# + + + +Creates a snapshot policy. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|schedules +|array[link:#SnapshotPolicyScheduleRequest[SnapshotPolicyScheduleRequest]] +|True +a|Snapshot policy schedules + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "schedules": [ + {} + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SnapshotPolicyScheduleRequest] +[.api-collapsible-fifth-title] +SnapshotPolicyScheduleRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scheduleType +|string +|True +a|Snapshot policy schedule type + + +|retention +|integer +|True +a|Snapshot policy retention + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-aws-ha-working-environments-start.adoc b/cvo/post-aws-ha-working-environments-start.adoc new file mode 100644 index 00000000..d1329974 --- /dev/null +++ b/cvo/post-aws-ha-working-environments-start.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-start.html' +summary: 'Start a specific instance' +--- + += Start a specific instance + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/start`# + + + +Starts a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments-stop.adoc b/cvo/post-aws-ha-working-environments-stop.adoc new file mode 100644 index 00000000..5ff264c1 --- /dev/null +++ b/cvo/post-aws-ha-working-environments-stop.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-stop.html' +summary: 'Stop a specific instance' +--- + += Stop a specific instance + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/stop`# + + + +Stops a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|takeSnapshots +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments-support-registration.adoc b/cvo/post-aws-ha-working-environments-support-registration.adoc new file mode 100644 index 00000000..96b44c8b --- /dev/null +++ b/cvo/post-aws-ha-working-environments-support-registration.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-support-registration.html' +summary: 'Register a system with NetApp' +--- + += Register a system with NetApp + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/support-registration`# + + + +Registers a Cloud Volumes ONTAP system with NetApp. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|nssAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|licenseStartDate +|link:#licenseStartDate[licenseStartDate] +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "nssAccountId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#licenseStartDate] +[.api-collapsible-fifth-title] +licenseStartDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-aws-ha-working-environments-sync-subscription.adoc b/cvo/post-aws-ha-working-environments-sync-subscription.adoc new file mode 100644 index 00000000..7dfce06c --- /dev/null +++ b/cvo/post-aws-ha-working-environments-sync-subscription.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-sync-subscription.html' +summary: 'Trigger subscription synchronization' +--- + += Trigger subscription synchronization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/sync-subscription`# + + + +Manually triggers subscription synchronization for all Cloud Volumes ONTAP systems. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments-update-image.adoc b/cvo/post-aws-ha-working-environments-update-image.adoc new file mode 100644 index 00000000..1943c121 --- /dev/null +++ b/cvo/post-aws-ha-working-environments-update-image.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-update-image.html' +summary: 'Perform a complete image update operation' +--- + += Perform a complete image update operation + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/update-image`# + + + +Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|updateType +|string +|True +a|System update type. System updates can be performed by providing either an external URL that ONTAP will use to download the image file or a name of an image provided by the NetApp Console. + + +|updateParameter +|string +|True +a|Parameter specific to the specified update type. External file URL or the NetApp Console provided image name. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "updateType": "string", + "updateParameter": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments-update-mediator.adoc b/cvo/post-aws-ha-working-environments-update-mediator.adoc new file mode 100644 index 00000000..fdc9ce22 --- /dev/null +++ b/cvo/post-aws-ha-working-environments-update-mediator.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-update-mediator.html' +summary: 'Update the mediator for a system' +--- + += Update the mediator for a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/update-mediator`# + + + +Updates the mediator of the specified Cloud Volumes ONTAP system with the provided version. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments-upload-license-file.adoc b/cvo/post-aws-ha-working-environments-upload-license-file.adoc new file mode 100644 index 00000000..c208c587 --- /dev/null +++ b/cvo/post-aws-ha-working-environments-upload-license-file.adoc @@ -0,0 +1,197 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-upload-license-file.html' +summary: 'Upload a cloud license file' +--- + += Upload a cloud license file + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/upload-license-file`# + + + +Uploads a cloud license file on the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +//end collapsible .Definitions block +==== diff --git a/cvo/post-aws-ha-working-environments-upload-licenses.adoc b/cvo/post-aws-ha-working-environments-upload-licenses.adoc new file mode 100644 index 00000000..898639aa --- /dev/null +++ b/cvo/post-aws-ha-working-environments-upload-licenses.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments-upload-licenses.html' +summary: 'Upload cloud license file content' +--- + += Upload cloud license file content + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/upload-licenses`# + + + +Uploads the content of a cloud license file on the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenseOne +|string +|True +a| + +|licenseTwo +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licenseOne": "string", + "licenseTwo": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-aws-ha-working-environments.adoc b/cvo/post-aws-ha-working-environments.adoc new file mode 100644 index 00000000..bf02f103 --- /dev/null +++ b/cvo/post-aws-ha-working-environments.adoc @@ -0,0 +1,4263 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-aws-ha-working-environments.html' +summary: 'Create a new AWS HA Cloud Volumes ONTAP system' +--- + += Create a new AWS HA Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws/ha/working-environments`# + + + +Creates a new AWS HA Cloud Volumes ONTAP system. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|svmPassword +|string +|False +a| + +|username +|link:#AdminUsername[AdminUsername] +|False +a| + +|vpcId +|string +|True +a| + +|description +|string +|False +a| + +|region +|string +|False +a| + +|tenantId +|string +|False +a| + +|volume +|link:#VsaVolumeOnNewVsaCreateRequest[VsaVolumeOnNewVsaCreateRequest] +|False +a| + +|ebsVolumeSize +|link:#Capacity[Capacity] +|True +a| + +|ebsVolumeType +|string +|True +a|EBS volume type + + +|vsaMetadata +|link:#VsaMetadataRequest[VsaMetadataRequest] +|True +a| + +|dataEncryptionType +|string +|True +a|Type of encryption to use for this system + + +|ontapEncryptionParameters +|link:#OntapEncryption[OntapEncryption] +|False +a| + +|awsEncryptionParameters +|link:#AwsEncryption[AwsEncryption] +|False +a| + +|haParams +|link:#HaParameters[HaParameters] +|True +a| + +|securityGroupId +|string +|False +a| + +|openSecurityGroup +|link:#openSecurityGroup[openSecurityGroup] +|False +a|Open the security group to all IP ranges + + +|awsTags +|array[link:#AwsTag[AwsTag]] +|True +a|Optionally, provide up to four key-value pairs with which to tag all AWS entities created by the NetApp Console. + + +|cifsConfigurationRequest +|link:#CIFSConfigurationRequest[CIFSConfigurationRequest] +|False +a| + +|optimizedNetworkUtilization +|boolean +|False +a|Use optimized network utilization + + +|clusterKeyPairName +|string +|False +a|Support SSH using a key-pair + + +|instanceTenancy +|string +|False +a|Instance tenancy configuration + + +|failedToCreateWorkingEnvironmentId +|string +|False +a|Public ID of a failed-to-create system + + +|capacityTier +|string +|False +a|Capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|packageName +|string +|False +a|Pre-configured package name + + +|instanceProfileName +|string +|False +a|Instance profile name + + +|roleArn +|string +|False +a|ARN of an optional role to assume + + +|svmName +|string +|False +a|SVM name + + +|wormRequest +|link:#WormRequest[WormRequest] +|False +a| + +|cloudProviderAccount +|string +|False +a|Cloud provider account + + +|nssAccount +|string +|False +a|NetApp Support Site (NSS) account + + +|saasSubscriptionId +|string +|False +a|SaaS subscription ID + + +|backupVolumesToCbs +|boolean +|False +a|Automatically back up all volumes to Amazon S3 + + +|enableCompliance +|boolean +|True +a|Enable compliance + + +|disableEv +|boolean +|False +a|Disable Elastic Volume + + +|tierLevel +|string +|False +a|Tier Level + + +|enableMonitoring +|boolean +|True +a|Enable monitoring + + +|enableServices +|array[string] +|False +a|Enable services + + +|writingSpeedState +|string +|False +a|Writing speed state + + +|subnetId +|string +|True +a| + +|ontapEncryptionDefined +|boolean +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|awsProperties +|link:#AwsProperties[AwsProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|interClusterLifs +|array[link:#InterClusterLif[InterClusterLif]] +|True +a| + +|cronJobSchedules +|array[link:#CronJobSchedule[CronJobSchedule]] +|True +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|cloudProviderName +|string +|False +a| + +|isHA +|boolean +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|haProperties +|link:#AwsHaProperties[AwsHaProperties] +|False +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|cloudSyncProperties +|link:#CloudSyncProperties[CloudSyncProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#AdminUsername] +[.api-collapsible-fifth-title] +AdminUsername + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#VsaVolumeOnNewVsaCreateRequest] +[.api-collapsible-fifth-title] +VsaVolumeOnNewVsaCreateRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|False +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|False +a| + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|iscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableThinProvisioning +|boolean +|False +a|Enable thin provisioning on the volume + + +|enableCompression +|boolean +|False +a|Enable compression on the volume + + +|enableDeduplication +|boolean +|False +a|Enable deduplication on the volume + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|junctionPath +|string +|False +a|Junction path + + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|=== + + +[#VsaMetadataRequest] +[.api-collapsible-fifth-title] +VsaMetadataRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a|ONTAP version + + +|licenseType +|string +|True +a|License type + + +|instanceType +|string +|True +a|Instance type + + +|platformSerialNumber +|string +|False +a|Optional platform serial number + + +|providedLicense +|string +|False +a|Optional provided license + + +|capacityPackageName +|string +|False +a|Optional capacity-based package + + +|keyStoneSubscription +|string +|False +a|Keystone subscription ID + + +|useLatestVersion +|boolean +|False +a|Use the latest version + + +|=== + + +[#OntapEncryption] +[.api-collapsible-fifth-title] +OntapEncryption + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|keyManagerIds +|array[string] +|False +a| + +|keyManagerCaCertificateId +|string +|False +a| + +|=== + + +[#AwsEncryption] +[.api-collapsible-fifth-title] +AwsEncryption + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|kmsKeyId +|string +|False +a| + +|kmsKeyArn +|string +|False +a| + +|=== + + +[#MediatorProxy] +[.api-collapsible-fifth-title] +MediatorProxy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|url +|string +|False +a| + +|userName +|string +|False +a| + +|password +|string +|False +a| + +|=== + + +[#HaParameters] +[.api-collapsible-fifth-title] +HaParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|node1SubnetId +|string +|False +a| + +|node2SubnetId +|string +|False +a| + +|mediatorSubnetId +|string +|False +a| + +|clusterFloatingIP +|string +|False +a| + +|dataFloatingIP +|string +|False +a| + +|dataFloatingIP2 +|string +|False +a| + +|svmFloatingIP +|string +|False +a| + +|mediatorKeyPairName +|string +|False +a| + +|routeTableIds +|array[string] +|False +a| + +|platformSerialNumberNode1 +|string +|False +a| + +|platformSerialNumberNode2 +|string +|False +a| + +|providedLicenseNode1 +|string +|False +a| + +|providedLicenseNode2 +|string +|False +a| + +|failoverMode +|string +|False +a|HA failover mode + + +|mediatorProxy +|link:#MediatorProxy[MediatorProxy] +|False +a| + +|mediatorAssignPublicIP +|boolean +|False +a| + +|mediatorInstanceProfileName +|string +|False +a| + +|mediatorSecurityGroupId +|string +|False +a| + +|assumeRoleArn +|string +|False +a| + +|=== + + +[#openSecurityGroup] +[.api-collapsible-fifth-title] +openSecurityGroup + +Open the security group to all IP ranges + + + +[#AwsTag] +[.api-collapsible-fifth-title] +AwsTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|False +a| + +|tagValue +|string +|False +a| + +|=== + + +[#CIFSConfigurationRequest] +[.api-collapsible-fifth-title] +CIFSConfigurationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|False +a|DNS domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|activeDirectoryUsername +|string +|True +a|Active Directory username + + +|activeDirectoryPassword +|string +|True +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +[#WormRetentionPeriod] +[.api-collapsible-fifth-title] +WormRetentionPeriod + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|True +a|Length + + +|unit +|string +|True +a|Unit + + +|=== + + +[#WormRequest] +[.api-collapsible-fifth-title] +WormRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|retentionPeriod +|link:#WormRetentionPeriod[WormRetentionPeriod] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags + +Instance tags + +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#InstanceResponse] +[.api-collapsible-fifth-title] +InstanceResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Instance ID + + +|name +|string +|True +a|Instance name + + +|instanceType +|string +|True +a|Instance type + + +|state +|string +|True +a|Instance state + + +|publicIpAddress +|string +|True +a|Public IP address that is assigned to the instance + + +|privateIpAddress +|string +|True +a|Private IP address that is assigned to the instance + + +|publicDnsName +|string +|True +a|Public DNS + + +|privateDnsName +|string +|True +a|Private DNS name + + +|imageId +|string +|True +a|Image ID + + +|subnetId +|string +|True +a|Subnet ID + + +|availabilityZone +|string +|True +a|Availability zone + + +|isVsaInstance +|boolean +|True +a|Indicates if the instance is a Cloud Volumes ONTAP instance + + +|isOCCMInstance +|boolean +|True +a|Indicates if the instance is a NetApp Console instance + + +|tags +|link:#tags[tags] +|True +a|Instance tags + + +|productCode +|string +|True +a|Product code + + +|tenancy +|string +|True +a|Instance Tenancy + + +|placementGroup +|string +|True +a|Placement group + + +|keyPairName +|string +|True +a|Key pair + + +|instanceProfileId +|string +|False +a|Instance profile ID + + +|=== + + +[#VpcTagResponse] +[.api-collapsible-fifth-title] +VpcTagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|VPC tag key + + +|value +|string +|True +a|VPC tag value + + +|=== + + +[#VpcBasicResponse] +[.api-collapsible-fifth-title] +VpcBasicResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|True +a|The VPC identifier + + +|state +|string +|True +a|The state of the VPC + + +|cidrBlock +|string +|True +a|VPC Classless Inter-Domain Routing (CIDR) block + + +|tags +|array[link:#VpcTagResponse[VpcTagResponse]] +|True +a|VPC tags + + +|default +|boolean +|True +a|Indicates whether the VPC is the default + + +|=== + + +[#bootDiskSize] +[.api-collapsible-fifth-title] +bootDiskSize + + +[#coreDiskExists] +[.api-collapsible-fifth-title] +coreDiskExists + + +[#AwsProperties] +[.api-collapsible-fifth-title] +AwsProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|availabilityZones +|array[string] +|False +a| + +|instances +|array[link:#InstanceResponse[InstanceResponse]] +|False +a| + +|vpc +|link:#VpcBasicResponse[VpcBasicResponse] +|False +a| + +|accountId +|string +|False +a| + +|roleArn +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|bootDiskSize +|link:#bootDiskSize[bootDiskSize] +|False +a| + +|outpostArn +|string +|False +a| + +|coreDiskExists +|link:#coreDiskExists[coreDiskExists] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#InterClusterLif] +[.api-collapsible-fifth-title] +InterClusterLif + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|port +|string +|False +a| + +|node +|string +|False +a| + +|status +|string +|False +a| + +|isPeered +|boolean +|False +a| + +|=== + + +[#CronJobSchedule] +[.api-collapsible-fifth-title] +CronJobSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|description +|string +|False +a| + +|months +|array[string] +|True +a| + +|days +|array[string] +|False +a| + +|weekDays +|array[string] +|False +a| + +|hours +|array[string] +|False +a| + +|minutes +|array[string] +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MediatorVersionInfo] +[.api-collapsible-fifth-title] +MediatorVersionInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|version +|string +|False +a| + +|description +|string +|False +a| + +|state +|string +|True +a| + +|bootVolumeId +|string +|False +a| + +|=== + + +[#MediatorStatus] +[.api-collapsible-fifth-title] +MediatorStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|statusCode +|integer +|False +a| + +|statusMessage +|string +|False +a| + +|=== + + +[#MediatorUpdateVersionMetadata] +[.api-collapsible-fifth-title] +MediatorUpdateVersionMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersion +|string +|False +a| + +|timeStamp +|integer +|False +a| + +|metadataFileName +|string +|False +a| + +|major +|boolean +|False +a| + +|manifestFileName +|string +|False +a| + +|=== + + +[#AwsHaProperties] +[.api-collapsible-fifth-title] +AwsHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersionInfo +|link:#MediatorVersionInfo[MediatorVersionInfo] +|False +a| + +|mediatorStatus +|link:#MediatorStatus[MediatorStatus] +|False +a| + +|routeTables +|array[string] +|False +a| + +|mediatorVersionsToUpdate +|array[link:#MediatorUpdateVersionMetadata[MediatorUpdateVersionMetadata]] +|False +a| + +|failoverMode +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#CloudSyncStatus] +[.api-collapsible-fifth-title] +CloudSyncStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#DataBrokerPlacement] +[.api-collapsible-fifth-title] +DataBrokerPlacement + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|False +a| + +|subnetId +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|keyPair +|string +|False +a| + +|=== + + +[#DataBrokerProperties] +[.api-collapsible-fifth-title] +DataBrokerProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|dataBrokerPlacement +|link:#DataBrokerPlacement[DataBrokerPlacement] +|False +a| + +|=== + + +[#CloudSyncRelationship] +[.api-collapsible-fifth-title] +CloudSyncRelationship + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|relationshipStatus +|string +|False +a| + +|s3Location +|string +|False +a| + +|id +|string +|False +a| + +|progress +|integer +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#CloudSyncProperties] +[.api-collapsible-fifth-title] +CloudSyncProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSynced +|boolean +|False +a| + +|status +|link:#CloudSyncStatus[CloudSyncStatus] +|False +a| + +|dataBrokerProperties +|link:#DataBrokerProperties[DataBrokerProperties] +|False +a| + +|s3Location +|string +|False +a| + +|relationships +|array[link:#CloudSyncRelationship[CloudSyncRelationship]] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-ha-aggregates--disks.adoc b/cvo/post-azure-ha-aggregates--disks.adoc new file mode 100644 index 00000000..5250b03a --- /dev/null +++ b/cvo/post-azure-ha-aggregates--disks.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-aggregates--disks.html' +summary: 'Add disks to an aggregate' +--- + += Add disks to an aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks`# + + + +Adds disks to an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|True +a|Number of disks + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-aggregates.adoc b/cvo/post-azure-ha-aggregates.adoc new file mode 100644 index 00000000..007715a5 --- /dev/null +++ b/cvo/post-azure-ha-aggregates.adoc @@ -0,0 +1,137 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-aggregates.html' +summary: 'Create a new aggregate' +--- + += Create a new aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/aggregates`# + + + +Creates a new aggregate. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|workingEnvironmentId +|string +|True +a| + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|initialEvAggregateSize +|link:#Capacity[Capacity] +|False +a| + +|homeNode +|string +|False +a| + +|providerVolumeType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "workingEnvironmentId": "string", + "homeNode": "string", + "providerVolumeType": "string", + "capacityTier": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-ha-discovery-recover.adoc b/cvo/post-azure-ha-discovery-recover.adoc new file mode 100644 index 00000000..8b6f5db9 --- /dev/null +++ b/cvo/post-azure-ha-discovery-recover.adoc @@ -0,0 +1,236 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-discovery-recover.html' +summary: 'Save a system to the NetApp Console database' +--- + += Save a system to the NetApp Console database + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/discovery/recover`# + + + +Saves a previously discovered Cloud Volumes ONTAP system to the NetApp Console database. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|True +a| + +|resourceGroupName +|string +|False +a| + +|clusterCredentials +|link:#ClusterCredentialsRequest[ClusterCredentialsRequest] +|True +a| + +|tenantId +|string +|False +a| + +|providerAccount +|string +|False +a|ID of subscription where the VSA is located + + +|cloudProviderAccount +|string +|False +a|Cloud provider account + + +|nssAccountId +|string +|False +a|NetApp Support Site (NSS) account + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": "string", + "resourceGroupName": "string", + "clusterCredentials": { + "userName": "string", + "password": "string" + }, + "tenantId": "string", + "providerAccount": "string", + "cloudProviderAccount": "string", + "nssAccountId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|publicId +|string +|False +a| + +|tenantPublicId +|string +|False +a| + +|region +|string +|False +a| + +|vpcId +|string +|False +a| + +|clusterAddress +|string +|False +a| + +|clusterCredentials +|link:#ClusterCredentials[ClusterCredentials] +|True +a| + +|resourceGroup +|string +|False +a| + +|providerAccount +|string +|False +a| + +|cloudProviderAccount +|string +|False +a| + +|nssAccountId +|string +|False +a| + +|isDirectMarketplace +|link:#isDirectMarketplace[isDirectMarketplace] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ClusterCredentialsRequest] +[.api-collapsible-fifth-title] +ClusterCredentialsRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|userName +|string +|True +a| + +|password +|string +|False +a| + +|=== + + +[#ClusterCredentials] +[.api-collapsible-fifth-title] +ClusterCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|userName +|string +|False +a| + +|password +|string +|True +a| + +|id +|integer +|True +a| + +|publicId +|string +|False +a| + +|=== + + +[#isDirectMarketplace] +[.api-collapsible-fifth-title] +isDirectMarketplace + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-ha-metadata-create-container.adoc b/cvo/post-azure-ha-metadata-create-container.adoc new file mode 100644 index 00000000..7b0e62c8 --- /dev/null +++ b/cvo/post-azure-ha-metadata-create-container.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-metadata-create-container.html' +summary: 'Create a new blob container' +--- + += Create a new blob container + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/metadata/create-container`# + + + +Creates a new blob container. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|resourceGroupName +|string +|True +a| + +|storageAccountName +|string +|False +a| + +|containerName +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "subscriptionId": "string", + "cloudProviderAccountId": "string", + "resourceGroupName": "string", + "storageAccountName": "string", + "containerName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-metadata-validate-subscribed-to-ontap-cloud.adoc b/cvo/post-azure-ha-metadata-validate-subscribed-to-ontap-cloud.adoc new file mode 100644 index 00000000..a3cce8d7 --- /dev/null +++ b/cvo/post-azure-ha-metadata-validate-subscribed-to-ontap-cloud.adoc @@ -0,0 +1,169 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-metadata-validate-subscribed-to-ontap-cloud.html' +summary: 'Validate the Azure marketplace subscription' +--- + += Validate the Azure marketplace subscription + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/metadata/validate-subscribed-to-ontap-cloud`# + + + +Validates that the current user is subscribed to the Cloud Volumes ONTAP product in the Azure marketplace. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|True +a| + +|vsaMetadata +|link:#VsaMetadataRequest[VsaMetadataRequest] +|True +a| + +|subscriptionId +|string +|False +a| + +|cloudProviderAccount +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": "string", + "vsaMetadata": { + "ontapVersion": "string", + "licenseType": "string", + "instanceType": "string", + "platformSerialNumber": "string", + "providedLicense": "string", + "capacityPackageName": "string", + "keyStoneSubscription": "string" + }, + "subscriptionId": "string", + "cloudProviderAccount": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|failureInfo +|string +|False +a| + +|isSubscribed +|boolean +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#VsaMetadataRequest] +[.api-collapsible-fifth-title] +VsaMetadataRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a|ONTAP version + + +|licenseType +|string +|True +a|License type + + +|instanceType +|string +|True +a|Instance type + + +|platformSerialNumber +|string +|False +a|Optional platform serial number + + +|providedLicense +|string +|False +a|Optional provided license + + +|capacityPackageName +|string +|False +a|Optional capacity-based package + + +|keyStoneSubscription +|string +|False +a|Keystone subscription ID + + +|useLatestVersion +|boolean +|False +a|Use the latest version + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-ha-volumes--change-tier.adoc b/cvo/post-azure-ha-volumes--change-tier.adoc new file mode 100644 index 00000000..d585ebdd --- /dev/null +++ b/cvo/post-azure-ha-volumes--change-tier.adoc @@ -0,0 +1,229 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-volumes--change-tier.html' +summary: 'Update the underlying volume tier' +--- + += Update the underlying volume tier + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier`# + + + +Updates the underlying volume tier. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Target aggregate name + + +|numOfDisks +|integer +|True +a|Number of new disks needed + + +|newAggregate +|boolean +|True +a|Indicates if it is a newly created aggregate + + +|newDiskTypeName +|string +|True +a|New disk type name + + +|newCapacityTier +|string +|False +a|New capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|newTieringPolicy +|string +|False +a|New tiering policy + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-ha-volumes--clone.adoc b/cvo/post-azure-ha-volumes--clone.adoc new file mode 100644 index 00000000..2a0dd320 --- /dev/null +++ b/cvo/post-azure-ha-volumes--clone.adoc @@ -0,0 +1,89 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-volumes--clone.html' +summary: 'Clone an existing volume' +--- + += Clone an existing volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone`# + + + +Clones an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newVolumeName +|string +|True +a|New volume name + + +|parentSnapshot +|string +|False +a|Snapshot name to use for the clone + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "newVolumeName": "string", + "parentSnapshot": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-volumes--move.adoc b/cvo/post-azure-ha-volumes--move.adoc new file mode 100644 index 00000000..e2199b1e --- /dev/null +++ b/cvo/post-azure-ha-volumes--move.adoc @@ -0,0 +1,203 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-volumes--move.html' +summary: 'Move an existing volume' +--- + += Move an existing volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move`# + + + +Moves an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|targetAggregateName +|string +|True +a|Target aggregate name + + +|numOfDisksToAdd +|integer +|True +a|Target aggregate number of disks to add + + +|createTargetAggregate +|boolean +|True +a|Specifies if the aggregate is a new target aggregate + + +|newDiskTypeName +|string +|False +a|New disk type for the volume + + +|newCapacityTier +|string +|False +a|New capacity tier + + +|newTieringPolicy +|string +|False +a|New tiering policy + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-ha-volumes--snapshot.adoc b/cvo/post-azure-ha-volumes--snapshot.adoc new file mode 100644 index 00000000..2a3fe0cb --- /dev/null +++ b/cvo/post-azure-ha-volumes--snapshot.adoc @@ -0,0 +1,82 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-volumes--snapshot.html' +summary: 'Create a snapshot' +--- + += Create a snapshot + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Creates a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|string +|False +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-volumes-initiator.adoc b/cvo/post-azure-ha-volumes-initiator.adoc new file mode 100644 index 00000000..f7b7208c --- /dev/null +++ b/cvo/post-azure-ha-volumes-initiator.adoc @@ -0,0 +1,59 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-volumes-initiator.html' +summary: 'Add an iSCSI initiator' +--- + += Add an iSCSI initiator + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/volumes/initiator`# + + + +Adds an iSCSI initiator. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-volumes-quote.adoc b/cvo/post-azure-ha-volumes-quote.adoc new file mode 100644 index 00000000..cb6d6337 --- /dev/null +++ b/cvo/post-azure-ha-volumes-quote.adoc @@ -0,0 +1,285 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-volumes-quote.html' +summary: 'Retrieve quotes for a new volume' +--- + += Retrieve quotes for a new volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/volumes/quote`# + + + +Retrieves quotes for a new volume. Returns the resource quote required for the requested volume. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|True +a|Cloud Volumes ONTAP system ID + + +|svmName +|string +|True +a|SVM name + + +|aggregateName +|string +|False +a|Optionally choose in which aggregate to create the volume + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|enableThinProvisioning +|boolean +|True +a|Enable thin provisioning on the volume + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|verifyNameUniqueness +|boolean +|True +a|Verify volume name uniqueness within the SVM + + +|capacityTier +|string +|False +a|Capacity tier + + +|isReplicationFlow +|boolean +|True +a|Is replication flow + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|aggregateName +|string +|True +a|The aggregate on which the requested volume will be created + + +|newAggregate +|boolean +|True +a|Is it a newly created aggregate + + +|autoVsaCapacityManagement +|boolean +|True +a|Indicates if automatic Cloud Volumes ONTAP capacity management is enabled + + +|elasticVolumeQuoteResponse +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-ha-volumes.adoc b/cvo/post-azure-ha-volumes.adoc new file mode 100644 index 00000000..2e97afb2 --- /dev/null +++ b/cvo/post-azure-ha-volumes.adoc @@ -0,0 +1,610 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-volumes.html' +summary: 'Create a new volume' +--- + += Create a new volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/volumes`# + + + +Creates a new volume. If the aggregateName and maxNumOfDisksApprovedToAdd properties are not populated, the response fails with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|createAggregateIfNotFound +|boolean +|query +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|True +a|Cloud Volumes ONTAP system ID + + +|svmName +|string +|True +a|SVM name + + +|aggregateName +|string +|True +a|Aggregate in which the volume will be created + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|True +a|Snapshot policy name + + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|iscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableThinProvisioning +|boolean +|True +a|Enable thin provisioning on the volume + + +|enableCompression +|boolean +|True +a|Enable compression on the volume + + +|enableDeduplication +|boolean +|True +a|Enable deduplication on the volume + + +|maxNumOfDisksApprovedToAdd +|integer +|True +a|Maximum number of disks approved to allocate + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|providerVolumeType +|string +|False +a|Provider volume type + + +|syncToS3 +|boolean +|True +a|Add a cloud sync relationship + + +|capacityTier +|string +|False +a|Capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|junctionPath +|string +|False +a|Junction path + + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|volumeTags +|array[link:#VolumeTags[VolumeTags]] +|True +a|Optionally, provide key-value pairs with which to tag the ONTAP volume using the App Template service. + + +|comment +|string +|False +a|Volume Comment + + +|flexGroupVolumeInfo +|link:#FlexGroupVolumeInfo[FlexGroupVolumeInfo] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +[#VolumeTags] +[.api-collapsible-fifth-title] +VolumeTags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|False +a| + +|tagValue +|string +|False +a| + +|=== + + +[#FlexGroupVolumeInfo] +[.api-collapsible-fifth-title] +FlexGroupVolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateList +|array[string] +|False +a|Names of aggregates for the FlexGroup volume + + +|numberOfConstituents +|integer +|False +a|Number of constituents for the FlexGroup volume + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-ha-working-environments-change-serial.adoc b/cvo/post-azure-ha-working-environments-change-serial.adoc new file mode 100644 index 00000000..23568cf6 --- /dev/null +++ b/cvo/post-azure-ha-working-environments-change-serial.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-change-serial.html' +summary: 'Update the serial number of a system' +--- + += Update the serial number of a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/change-serial`# + + + +Updates the serial number of a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodeOne +|string +|True +a| + +|nodeTwo +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nodeOne": "string", + "nodeTwo": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-working-environments-change-tier-level.adoc b/cvo/post-azure-ha-working-environments-change-tier-level.adoc new file mode 100644 index 00000000..cb40a5a9 --- /dev/null +++ b/cvo/post-azure-ha-working-environments-change-tier-level.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-change-tier-level.html' +summary: 'Update the tier level' +--- + += Update the tier level + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/change-tier-level`# + + + +Updates the tier level. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|level +|string +|True +a|Update tier level + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "level": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-working-environments-cifs.adoc b/cvo/post-azure-ha-working-environments-cifs.adoc new file mode 100644 index 00000000..f7219f67 --- /dev/null +++ b/cvo/post-azure-ha-working-environments-cifs.adoc @@ -0,0 +1,121 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-cifs.html' +summary: 'Create a new CIFS configuration for a system' +--- + += Create a new CIFS configuration for a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/cifs`# + + + +Sets up a new CIFS configuration for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|False +a|DNS domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|activeDirectoryUsername +|string +|True +a|Active Directory username + + +|activeDirectoryPassword +|string +|True +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "activeDirectoryDomain": "string", + "activeDirectoryUsername": "string", + "activeDirectoryPassword": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-working-environments-delete-cifs.adoc b/cvo/post-azure-ha-working-environments-delete-cifs.adoc new file mode 100644 index 00000000..8666078a --- /dev/null +++ b/cvo/post-azure-ha-working-environments-delete-cifs.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-delete-cifs.html' +summary: 'Delete the CIFS configuration for a system' +--- + += Delete the CIFS configuration for a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/delete-cifs`# + + + +Deletes the CIFS configuration of an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|activeDirectoryUsername +|string +|False +a|Active Directory username + + +|activeDirectoryPassword +|string +|False +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "activeDirectoryUsername": "string", + "activeDirectoryPassword": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-working-environments-enable-capacity-tiering.adoc b/cvo/post-azure-ha-working-environments-enable-capacity-tiering.adoc new file mode 100644 index 00000000..faacb08e --- /dev/null +++ b/cvo/post-azure-ha-working-environments-enable-capacity-tiering.adoc @@ -0,0 +1,81 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-enable-capacity-tiering.html' +summary: 'Enable capacity tiering' +--- + += Enable capacity tiering + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering`# + + + +Enables capacity tiering. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceProfileName +|string +|False +a| + +|gcpStorageAccountId +|string +|False +a| + +|storageAccountPrefix +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceProfileName": "string", + "gcpStorageAccountId": "string", + "storageAccountPrefix": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-working-environments-extra-capacity-licenses.adoc b/cvo/post-azure-ha-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..7b909952 --- /dev/null +++ b/cvo/post-azure-ha-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-extra-capacity-licenses.html' +summary: 'Register an extra capacity license' +--- + += Register an extra capacity license + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Registers an extra capacity license. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licences +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licences": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-working-environments-extra-capacity-serials.adoc b/cvo/post-azure-ha-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..bfb9b526 --- /dev/null +++ b/cvo/post-azure-ha-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-extra-capacity-serials.html' +summary: 'Register extra capacity serial numbers' +--- + += Register extra capacity serial numbers + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Registers an extra capacity serial number. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-working-environments-ntp.adoc b/cvo/post-azure-ha-working-environments-ntp.adoc new file mode 100644 index 00000000..42081351 --- /dev/null +++ b/cvo/post-azure-ha-working-environments-ntp.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-ntp.html' +summary: 'Create an NTP server' +--- + += Create an NTP server + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/ntp`# + + + +Sets up an NTP server. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ntpServer +|string +|True +a|NTPS server + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "ntpServer": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-working-environments-parse-license-file.adoc b/cvo/post-azure-ha-working-environments-parse-license-file.adoc new file mode 100644 index 00000000..10fd5f09 --- /dev/null +++ b/cvo/post-azure-ha-working-environments-parse-license-file.adoc @@ -0,0 +1,232 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-parse-license-file.html' +summary: 'Parse an uploaded cloud license file' +--- + += Parse an uploaded cloud license file + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/parse-license-file`# + + + +Parses an uploaded cloud license file. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|license +|string +|True +a| + +|serialNumber +|string +|False +a| + +|contractEndDate +|link:#contractEndDate[contractEndDate] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "license": "string", + "serialNumber": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +[#contractEndDate] +[.api-collapsible-fifth-title] +contractEndDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-ha-working-environments-snapshot-policy.adoc b/cvo/post-azure-ha-working-environments-snapshot-policy.adoc new file mode 100644 index 00000000..6d03a842 --- /dev/null +++ b/cvo/post-azure-ha-working-environments-snapshot-policy.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-snapshot-policy.html' +summary: 'Create a snapshot policy' +--- + += Create a snapshot policy + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/snapshot-policy`# + + + +Creates a snapshot policy. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|schedules +|array[link:#SnapshotPolicyScheduleRequest[SnapshotPolicyScheduleRequest]] +|True +a|Snapshot policy schedules + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "schedules": [ + {} + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SnapshotPolicyScheduleRequest] +[.api-collapsible-fifth-title] +SnapshotPolicyScheduleRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scheduleType +|string +|True +a|Snapshot policy schedule type + + +|retention +|integer +|True +a|Snapshot policy retention + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-ha-working-environments-start.adoc b/cvo/post-azure-ha-working-environments-start.adoc new file mode 100644 index 00000000..2c0a00c7 --- /dev/null +++ b/cvo/post-azure-ha-working-environments-start.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-start.html' +summary: 'Start a Cloud Volumes ONTAP instance' +--- + += Start a Cloud Volumes ONTAP instance + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/start`# + + + +Starts a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-working-environments-stop.adoc b/cvo/post-azure-ha-working-environments-stop.adoc new file mode 100644 index 00000000..5f1f755d --- /dev/null +++ b/cvo/post-azure-ha-working-environments-stop.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-stop.html' +summary: 'Stop a Cloud Volumes ONTAP instance' +--- + += Stop a Cloud Volumes ONTAP instance + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/stop`# + + + +Stops a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|takeSnapshots +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-working-environments-support-registration.adoc b/cvo/post-azure-ha-working-environments-support-registration.adoc new file mode 100644 index 00000000..33dd3459 --- /dev/null +++ b/cvo/post-azure-ha-working-environments-support-registration.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-support-registration.html' +summary: 'Register a Cloud Volumes ONTAP system with NetApp' +--- + += Register a Cloud Volumes ONTAP system with NetApp + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/support-registration`# + + + +Registers a Cloud Volumes ONTAP system with NetApp. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|nssAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|licenseStartDate +|link:#licenseStartDate[licenseStartDate] +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "nssAccountId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#licenseStartDate] +[.api-collapsible-fifth-title] +licenseStartDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-ha-working-environments-svm.adoc b/cvo/post-azure-ha-working-environments-svm.adoc new file mode 100644 index 00000000..95ce705d --- /dev/null +++ b/cvo/post-azure-ha-working-environments-svm.adoc @@ -0,0 +1,187 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-svm.html' +summary: 'Create a new SVM' +--- + += Create a new SVM + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/svm`# + + + +Creates a new SVM. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|svmName +|string +|False +a| + +|svmPassword +|link:#AzureSvmPassword[AzureSvmPassword] +|False +a| + +|mgmtLif +|boolean +|True +a|Create a management LIF for the SVM + + +|rootVolumeAggregate +|string +|False +a|Root volume aggregate name + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#AzureSvmPassword] +[.api-collapsible-fifth-title] +AzureSvmPassword + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-ha-working-environments-sync-subscription.adoc b/cvo/post-azure-ha-working-environments-sync-subscription.adoc new file mode 100644 index 00000000..39f81334 --- /dev/null +++ b/cvo/post-azure-ha-working-environments-sync-subscription.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-sync-subscription.html' +summary: 'Trigger subscription synchronization' +--- + += Trigger subscription synchronization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/sync-subscription`# + + + +Manually triggers subscription synchronization for all Cloud Volumes ONTAP systems. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-working-environments-update-image.adoc b/cvo/post-azure-ha-working-environments-update-image.adoc new file mode 100644 index 00000000..753b767a --- /dev/null +++ b/cvo/post-azure-ha-working-environments-update-image.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-update-image.html' +summary: 'Perform an image update on a single node' +--- + += Perform an image update on a single node + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/update-image`# + + + +Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|updateType +|string +|True +a|System update type. System updates can be performed by providing either an external URL that ONTAP will use to download the image file or a name of an image provided by the NetApp Console. + + +|updateParameter +|string +|True +a|Parameter specific to the specified update type. External file URL or the NetApp Console provided image name. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "updateType": "string", + "updateParameter": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-working-environments-upload-license-file.adoc b/cvo/post-azure-ha-working-environments-upload-license-file.adoc new file mode 100644 index 00000000..54252567 --- /dev/null +++ b/cvo/post-azure-ha-working-environments-upload-license-file.adoc @@ -0,0 +1,197 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-upload-license-file.html' +summary: 'Upload a cloud license file' +--- + += Upload a cloud license file + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/upload-license-file`# + + + +Uploads a cloud license file on the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-ha-working-environments-upload-licenses.adoc b/cvo/post-azure-ha-working-environments-upload-licenses.adoc new file mode 100644 index 00000000..9bdd3dd9 --- /dev/null +++ b/cvo/post-azure-ha-working-environments-upload-licenses.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments-upload-licenses.html' +summary: 'Upload cloud license file content' +--- + += Upload cloud license file content + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/upload-licenses`# + + + +Uploads the content of a cloud license file on the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenseOne +|string +|True +a| + +|licenseTwo +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licenseOne": "string", + "licenseTwo": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-ha-working-environments.adoc b/cvo/post-azure-ha-working-environments.adoc new file mode 100644 index 00000000..8661a6bf --- /dev/null +++ b/cvo/post-azure-ha-working-environments.adoc @@ -0,0 +1,4062 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-ha-working-environments.html' +summary: 'Create a new Azure HA system' +--- + += Create a new Azure HA system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/ha/working-environments`# + + + +Creates a new Azure HA Cloud Volumes ONTAP system. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|svmPassword +|string +|False +a| + +|username +|link:#AdminUsername[AdminUsername] +|False +a| + +|vnetId +|string +|True +a| + +|cidr +|string +|False +a| + +|description +|string +|False +a| + +|volume +|link:#VsaVolumeOnNewVsaCreateRequest[VsaVolumeOnNewVsaCreateRequest] +|False +a| + +|region +|string +|False +a| + +|tenantId +|string +|False +a| + +|subnetId +|string +|True +a|Subnet ID for a single node cluster + + +|dataEncryptionType +|string +|True +a|Type of encryption to use for this system + + +|ontapEncryptionParameters +|link:#OntapEncryption[OntapEncryption] +|False +a| + +|securityGroupId +|string +|False +a| + +|openSecurityGroup +|link:#openSecurityGroup[openSecurityGroup] +|False +a|Open the security group to all IP ranges + + +|serialNumber +|string +|False +a| + +|cifsConfigurationRequest +|link:#CIFSConfigurationRequest[CIFSConfigurationRequest] +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|storageType +|string +|True +a|Storage type + + +|azureTags +|array[link:#AzureTag[AzureTag]] +|True +a|Optionally, provide up to four key-value pairs used to tag the resource group created by NetApp Console. + + +|writingSpeedState +|string +|False +a|Writing speed state + + +|vsaMetadata +|link:#VsaMetadataRequest[VsaMetadataRequest] +|True +a| + +|failedToCreateWorkingEnvironmentId +|string +|False +a|Public ID of a failed-to-create system + + +|packageName +|string +|False +a|Pre-configured package name + + +|vhdImageRequest +|link:#VhdImageRequest[VhdImageRequest] +|False +a| + +|resourceGroup +|string +|False +a|Custom resource group name + + +|subscriptionId +|string +|False +a|Subscription ID + + +|capacityTier +|string +|False +a|Capacity tier + + +|haParams +|link:#AzureHaParameters[AzureHaParameters] +|False +a| + +|allowDeployInExistingRg +|boolean +|False +a|Allow deployment in an existing resource group + + +|svmName +|string +|False +a|SVM name + + +|wormRequest +|link:#WormRequest[WormRequest] +|False +a| + +|cloudProviderAccount +|string +|False +a|Cloud provider account + + +|nssAccount +|string +|False +a|NetApp Support Site (NSS) account + + +|saasSubscriptionId +|string +|False +a|SaaS subscription ID + + +|enableCompliance +|boolean +|True +a|Enable compliance + + +|storageAccountPrefix +|string +|False +a|Storage account prefix + + +|backupVolumesToCbs +|boolean +|False +a|Automatically back up all volumes to the cloud + + +|tierLevel +|string +|False +a|Tier Level + + +|availabilityZone +|integer +|False +a|Availability Zone + + +|enableMonitoring +|boolean +|True +a|Enable monitoring + + +|azureEncryptionParameters +|link:#AzureEncryption[AzureEncryption] +|False +a| + +|enableServices +|array[string] +|False +a|Enable services + + +|storageAccountNetworkAccess +|string +|False +a|Storage account public network access + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#AzureProperties[AzureProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|False +a| + +|haProperties +|link:#AzureHaProperties[AzureHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "name": "string", + "tenantId": "string", + "svmName": "string", + "creatorUserEmail": "string", + "status": { + "status": "string", + "message": "string", + "extendedFailureReason": "string" + }, + "providerProperties": { + "regionName": "string", + "vnetCidr": "string", + "subscriptionId": "string", + "deploymentId": "string", + "instanceType": "string", + "subscriptionName": "string", + "cloudProviderAccountId": "string", + "dataDisks": [ + { + "name": "string", + "id": "string", + "caching": "string", + "accountType": "string", + "encryptionSet": "string" + } + ] + }, + "clusterProperties": { + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "clusterName": "string", + "ontapVersion": "string", + "accountId": "string", + "productCode": "string", + "amiId": "string", + "systemManagerUrl": "string", + "instanceId": "string", + "platformLicense": "string", + "instanceType": "string", + "publicIp": "string", + "publicDnsName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string" + }, + "ontapClusterProperties": { + "nodes": [ + { + "name": "string", + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "platformLicense": "string", + "platformSerialNumber": "string", + "cloudProviderId": "string" + } + ], + "clusterName": "string", + "clusterUuid": "string", + "ontapVersion": "string", + "systemManagerUrl": "string", + "licensePackageName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string", + "broadcastDomainInfos": [ + {} + ], + "capacityTierInfo": { + "s3BucketName": "string", + "tierLevel": "string" + }, + "userName": "string", + "vscanFileOperationDefaultProfile": "string" + }, + "cloudProviderName": "string", + "snapshotPolicies": [ + { + "name": "string", + "schedules": [ + {} + ], + "description": "string" + } + ], + "actionsRequired": [ + {} + ], + "activeActions": [ + "string" + ], + "replicationProperties": { + "peers": [ + "string" + ], + "replicationTargets": [ + "string" + ] + }, + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ], + "svms": [ + {} + ], + "workingEnvironmentType": "string", + "supportRegistrationProperties": { + "supportRegistrationStatus": "string" + }, + "supportRegistrationInformation": [ + { + "supportRegistrationStatus": "string", + "serialNumber": "string", + "nssAccountId": "string" + } + ], + "capacityFeatures": { + "providerVolumesType": [ + { + "supportedVolumeTypes": [ + "string" + ], + "maxDisksAllow": { + "reason": "string" + } + } + ], + "defaultProviderVolumeType": { + "diskType": "string", + "capacityTier": "string" + }, + "supportedCapacityTiers": { + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] + }, + "existingIops": [ + "object" + ] + }, + "encryptionProperties": { + "keyManagers": [ + { + "publicId": "string", + "name": "string", + "address": "string", + "usernameField": "string", + "usernameValue": "string", + "status": "string" + } + ], + "encryptionCertificates": [ + {} + ], + "awsEncryptionKey": { + "alias": "string", + "keyId": "string", + "status": "string", + "origin": "string" + } + }, + "haProperties": { + "loadBalancerName": "string", + "applicationSecurityGroupName": "string", + "azureHaDeploymentType": "string" + }, + "fpolicyProperties": { + "fileExtensions": [ + "string" + ] + }, + "saasProperties": { + "subscription": { + "id": "string", + "name": "string" + }, + "capacityLicensePackage": "string" + }, + "cbsProperties": { + "cbsBackupStatus": "string", + "cbsRules": [ + { + "snapmirrorLabel": "string" + } + ], + "objectStoreName": "string", + "providerSpecific": { + "azureRgName": "string", + "gcpProjectId": "string", + "gcpRegion": "string" + }, + "cbsPolicyName": "string", + "ipSpace": "string", + "region": "string", + "providerAccountName": "string", + "exclusionReason": "string" + }, + "complianceProperties": { + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" + }, + "monitoringProperties": { + "monitoringStatus": "string", + "monitoringInfo": { + "averageLatency": { + "unit": "string" + }, + "storageAverageThroughput": { + "unit": "string" + }, + "node1AverageThroughput": { + "unit": "string" + }, + "node2AverageThroughput": { + "unit": "string" + } + }, + "tenantUrl": "string" + }, + "licensesInformation": [ + { + "type": "string", + "useType": "string", + "package": "string", + "serialNumbers": [ + "string" + ], + "expirations": [ + "object" + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#AdminUsername] +[.api-collapsible-fifth-title] +AdminUsername + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#VsaVolumeOnNewVsaCreateRequest] +[.api-collapsible-fifth-title] +VsaVolumeOnNewVsaCreateRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|False +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|False +a| + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|iscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableThinProvisioning +|boolean +|False +a|Enable thin provisioning on the volume + + +|enableCompression +|boolean +|False +a|Enable compression on the volume + + +|enableDeduplication +|boolean +|False +a|Enable deduplication on the volume + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|junctionPath +|string +|False +a|Junction path + + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|=== + + +[#OntapEncryption] +[.api-collapsible-fifth-title] +OntapEncryption + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|keyManagerIds +|array[string] +|False +a| + +|keyManagerCaCertificateId +|string +|False +a| + +|=== + + +[#openSecurityGroup] +[.api-collapsible-fifth-title] +openSecurityGroup + +Open the security group to all IP ranges + + + +[#CIFSConfigurationRequest] +[.api-collapsible-fifth-title] +CIFSConfigurationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|False +a|DNS domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|activeDirectoryUsername +|string +|True +a|Active Directory username + + +|activeDirectoryPassword +|string +|True +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +[#AzureTag] +[.api-collapsible-fifth-title] +AzureTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|False +a| + +|tagValue +|string +|False +a| + +|=== + + +[#VsaMetadataRequest] +[.api-collapsible-fifth-title] +VsaMetadataRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a|ONTAP version + + +|licenseType +|string +|True +a|License type + + +|instanceType +|string +|True +a|Instance type + + +|platformSerialNumber +|string +|False +a|Optional platform serial number + + +|providedLicense +|string +|False +a|Optional provided license + + +|capacityPackageName +|string +|False +a|Optional capacity-based package + + +|keyStoneSubscription +|string +|False +a|Keystone subscription ID + + +|useLatestVersion +|boolean +|False +a|Use the latest version + + +|=== + + +[#VhdImageRequest] +[.api-collapsible-fifth-title] +VhdImageRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|blobUrl +|string +|False +a| + +|=== + + +[#AzureHaParameters] +[.api-collapsible-fifth-title] +AzureHaParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|platformSerialNumberNode1 +|string +|False +a| + +|platformSerialNumberNode2 +|string +|False +a| + +|availabilityZoneNode1 +|integer +|False +a| + +|availabilityZoneNode2 +|integer +|False +a| + +|enableHttps +|boolean +|False +a| + +|multiZone +|boolean +|False +a| + +|=== + + +[#WormRetentionPeriod] +[.api-collapsible-fifth-title] +WormRetentionPeriod + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|True +a|Length + + +|unit +|string +|True +a|Unit + + +|=== + + +[#WormRequest] +[.api-collapsible-fifth-title] +WormRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|retentionPeriod +|link:#WormRetentionPeriod[WormRetentionPeriod] +|True +a| + +|=== + + +[#AzureEncryption] +[.api-collapsible-fifth-title] +AzureEncryption + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|False +a| + +|vaultName +|string +|False +a| + +|userAssignedIdentity +|string +|False +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#AzureResourceGroupResponse] +[.api-collapsible-fifth-title] +AzureResourceGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|location +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|=== + + +[#availabilityZone] +[.api-collapsible-fifth-title] +availabilityZone + + +[#AzureDataDiskResponse] +[.api-collapsible-fifth-title] +AzureDataDiskResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|diskSizeGB +|integer +|False +a| + +|lun +|integer +|False +a| + +|id +|string +|False +a| + +|caching +|string +|False +a| + +|accountType +|string +|False +a| + +|managed +|boolean +|False +a| + +|encryptionSet +|string +|False +a| + +|=== + + +[#AzureProperties] +[.api-collapsible-fifth-title] +AzureProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|resourceGroup +|link:#AzureResourceGroupResponse[AzureResourceGroupResponse] +|False +a| + +|vnetCidr +|string +|False +a| + +|tags +|link:#tags[tags] +|False +a| + +|subscriptionId +|string +|False +a| + +|deploymentId +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceType +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|singleNetworkInterface +|boolean +|False +a| + +|subscriptionName +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|dataDisks +|array[link:#AzureDataDiskResponse[AzureDataDiskResponse]] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#AzureAvailabilitySet] +[.api-collapsible-fifth-title] +AzureAvailabilitySet + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|faultDomain +|integer +|False +a| + +|updateDomain +|integer +|False +a| + +|=== + + +[#AzureHaNodeInfo] +[.api-collapsible-fifth-title] +AzureHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceId +|string +|False +a| + +|primaryIp +|string +|False +a| + +|state +|string +|False +a| + +|serialNumber +|string +|False +a| + +|availabilitySet +|link:#AzureAvailabilitySet[AzureAvailabilitySet] +|True +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|=== + + +[#AzureHaProperties] +[.api-collapsible-fifth-title] +AzureHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|loadBalancerName +|string +|False +a| + +|haEnabledOnLbRules +|boolean +|False +a| + +|node1Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|node2Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|multiZone +|boolean +|False +a| + +|applicationSecurityGroupName +|string +|False +a| + +|azureHaDeploymentType +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-vsa-aggregates--disks.adoc b/cvo/post-azure-vsa-aggregates--disks.adoc new file mode 100644 index 00000000..10fd27ed --- /dev/null +++ b/cvo/post-azure-vsa-aggregates--disks.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-aggregates--disks.html' +summary: 'Add disks to an aggregate' +--- + += Add disks to an aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks`# + + + +Adds disks to an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|True +a|Number of disks + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-aggregates.adoc b/cvo/post-azure-vsa-aggregates.adoc new file mode 100644 index 00000000..7cf2f13e --- /dev/null +++ b/cvo/post-azure-vsa-aggregates.adoc @@ -0,0 +1,137 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-aggregates.html' +summary: 'Create a new aggregate' +--- + += Create a new aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/aggregates`# + + + +Creates a new aggregate. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|workingEnvironmentId +|string +|True +a| + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|initialEvAggregateSize +|link:#Capacity[Capacity] +|False +a| + +|homeNode +|string +|False +a| + +|providerVolumeType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "workingEnvironmentId": "string", + "homeNode": "string", + "providerVolumeType": "string", + "capacityTier": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-vsa-metadata-create-container.adoc b/cvo/post-azure-vsa-metadata-create-container.adoc new file mode 100644 index 00000000..d4a7a58d --- /dev/null +++ b/cvo/post-azure-vsa-metadata-create-container.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-metadata-create-container.html' +summary: 'Create a new blob container' +--- + += Create a new blob container + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/metadata/create-container`# + + + +Creates a new blob container. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|resourceGroupName +|string +|True +a| + +|storageAccountName +|string +|False +a| + +|containerName +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "subscriptionId": "string", + "cloudProviderAccountId": "string", + "resourceGroupName": "string", + "storageAccountName": "string", + "containerName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-metadata-validate-subscribed-to-ontap-cloud.adoc b/cvo/post-azure-vsa-metadata-validate-subscribed-to-ontap-cloud.adoc new file mode 100644 index 00000000..50799889 --- /dev/null +++ b/cvo/post-azure-vsa-metadata-validate-subscribed-to-ontap-cloud.adoc @@ -0,0 +1,169 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-metadata-validate-subscribed-to-ontap-cloud.html' +summary: 'Confirm the current user subscription' +--- + += Confirm the current user subscription + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/metadata/validate-subscribed-to-ontap-cloud`# + + + +Validates that the current user is subscribed to the Cloud Volumes ONTAP product in the Azure marketplace. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|True +a| + +|vsaMetadata +|link:#VsaMetadataRequest[VsaMetadataRequest] +|True +a| + +|subscriptionId +|string +|False +a| + +|cloudProviderAccount +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": "string", + "vsaMetadata": { + "ontapVersion": "string", + "licenseType": "string", + "instanceType": "string", + "platformSerialNumber": "string", + "providedLicense": "string", + "capacityPackageName": "string", + "keyStoneSubscription": "string" + }, + "subscriptionId": "string", + "cloudProviderAccount": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|failureInfo +|string +|False +a| + +|isSubscribed +|boolean +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#VsaMetadataRequest] +[.api-collapsible-fifth-title] +VsaMetadataRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a|ONTAP version + + +|licenseType +|string +|True +a|License type + + +|instanceType +|string +|True +a|Instance type + + +|platformSerialNumber +|string +|False +a|Optional platform serial number + + +|providedLicense +|string +|False +a|Optional provided license + + +|capacityPackageName +|string +|False +a|Optional capacity-based package + + +|keyStoneSubscription +|string +|False +a|Keystone subscription ID + + +|useLatestVersion +|boolean +|False +a|Use the latest version + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-vsa-recover.adoc b/cvo/post-azure-vsa-recover.adoc new file mode 100644 index 00000000..f6a718ba --- /dev/null +++ b/cvo/post-azure-vsa-recover.adoc @@ -0,0 +1,3164 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-recover.html' +summary: 'Save a previously discovered Cloud Volumes ONTAP system' +--- + += Save a previously discovered Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/recover`# + + + +Saves a previously discovered Cloud Volumes ONTAP system to the NetApp Console database. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|True +a| + +|id +|string +|False +a| + +|resourceGroupName +|string +|False +a| + +|instanceName +|string +|False +a| + +|clusterCredentials +|link:#ClusterCredentialsRequest[ClusterCredentialsRequest] +|True +a| + +|tenantId +|string +|False +a| + +|providerAccount +|string +|False +a|ID of subscription where VSA is located + + +|cloudProviderAccount +|string +|False +a|Cloud provider account + + +|nssAccountId +|string +|False +a|NetApp Support Site (NSS) account + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": "string", + "id": "string", + "resourceGroupName": "string", + "instanceName": "string", + "clusterCredentials": { + "userName": "string", + "password": "string" + }, + "tenantId": "string", + "providerAccount": "string", + "cloudProviderAccount": "string", + "nssAccountId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#AzureProperties[AzureProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|False +a| + +|haProperties +|link:#AzureHaProperties[AzureHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "name": "string", + "tenantId": "string", + "svmName": "string", + "creatorUserEmail": "string", + "status": { + "status": "string", + "message": "string", + "extendedFailureReason": "string" + }, + "providerProperties": { + "regionName": "string", + "vnetCidr": "string", + "subscriptionId": "string", + "deploymentId": "string", + "instanceType": "string", + "subscriptionName": "string", + "cloudProviderAccountId": "string", + "dataDisks": [ + { + "name": "string", + "id": "string", + "caching": "string", + "accountType": "string", + "encryptionSet": "string" + } + ] + }, + "clusterProperties": { + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "clusterName": "string", + "ontapVersion": "string", + "accountId": "string", + "productCode": "string", + "amiId": "string", + "systemManagerUrl": "string", + "instanceId": "string", + "platformLicense": "string", + "instanceType": "string", + "publicIp": "string", + "publicDnsName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string" + }, + "ontapClusterProperties": { + "nodes": [ + { + "name": "string", + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "platformLicense": "string", + "platformSerialNumber": "string", + "cloudProviderId": "string" + } + ], + "clusterName": "string", + "clusterUuid": "string", + "ontapVersion": "string", + "systemManagerUrl": "string", + "licensePackageName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string", + "broadcastDomainInfos": [ + {} + ], + "capacityTierInfo": { + "s3BucketName": "string", + "tierLevel": "string" + }, + "userName": "string", + "vscanFileOperationDefaultProfile": "string" + }, + "cloudProviderName": "string", + "snapshotPolicies": [ + { + "name": "string", + "schedules": [ + {} + ], + "description": "string" + } + ], + "actionsRequired": [ + {} + ], + "activeActions": [ + "string" + ], + "replicationProperties": { + "peers": [ + "string" + ], + "replicationTargets": [ + "string" + ] + }, + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ], + "svms": [ + {} + ], + "workingEnvironmentType": "string", + "supportRegistrationProperties": { + "supportRegistrationStatus": "string" + }, + "supportRegistrationInformation": [ + { + "supportRegistrationStatus": "string", + "serialNumber": "string", + "nssAccountId": "string" + } + ], + "capacityFeatures": { + "providerVolumesType": [ + { + "supportedVolumeTypes": [ + "string" + ], + "maxDisksAllow": { + "reason": "string" + } + } + ], + "defaultProviderVolumeType": { + "diskType": "string", + "capacityTier": "string" + }, + "supportedCapacityTiers": { + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] + }, + "existingIops": [ + "object" + ] + }, + "encryptionProperties": { + "keyManagers": [ + { + "publicId": "string", + "name": "string", + "address": "string", + "usernameField": "string", + "usernameValue": "string", + "status": "string" + } + ], + "encryptionCertificates": [ + {} + ], + "awsEncryptionKey": { + "alias": "string", + "keyId": "string", + "status": "string", + "origin": "string" + } + }, + "haProperties": { + "loadBalancerName": "string", + "applicationSecurityGroupName": "string", + "azureHaDeploymentType": "string" + }, + "fpolicyProperties": { + "fileExtensions": [ + "string" + ] + }, + "saasProperties": { + "subscription": { + "id": "string", + "name": "string" + }, + "capacityLicensePackage": "string" + }, + "cbsProperties": { + "cbsBackupStatus": "string", + "cbsRules": [ + { + "snapmirrorLabel": "string" + } + ], + "objectStoreName": "string", + "providerSpecific": { + "azureRgName": "string", + "gcpProjectId": "string", + "gcpRegion": "string" + }, + "cbsPolicyName": "string", + "ipSpace": "string", + "region": "string", + "providerAccountName": "string", + "exclusionReason": "string" + }, + "complianceProperties": { + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" + }, + "monitoringProperties": { + "monitoringStatus": "string", + "monitoringInfo": { + "averageLatency": { + "unit": "string" + }, + "storageAverageThroughput": { + "unit": "string" + }, + "node1AverageThroughput": { + "unit": "string" + }, + "node2AverageThroughput": { + "unit": "string" + } + }, + "tenantUrl": "string" + }, + "licensesInformation": [ + { + "type": "string", + "useType": "string", + "package": "string", + "serialNumbers": [ + "string" + ], + "expirations": [ + "object" + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ClusterCredentialsRequest] +[.api-collapsible-fifth-title] +ClusterCredentialsRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|userName +|string +|True +a| + +|password +|string +|False +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#AzureResourceGroupResponse] +[.api-collapsible-fifth-title] +AzureResourceGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|location +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|=== + + +[#availabilityZone] +[.api-collapsible-fifth-title] +availabilityZone + + +[#AzureDataDiskResponse] +[.api-collapsible-fifth-title] +AzureDataDiskResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|diskSizeGB +|integer +|False +a| + +|lun +|integer +|False +a| + +|id +|string +|False +a| + +|caching +|string +|False +a| + +|accountType +|string +|False +a| + +|managed +|boolean +|False +a| + +|encryptionSet +|string +|False +a| + +|=== + + +[#AzureProperties] +[.api-collapsible-fifth-title] +AzureProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|resourceGroup +|link:#AzureResourceGroupResponse[AzureResourceGroupResponse] +|False +a| + +|vnetCidr +|string +|False +a| + +|tags +|link:#tags[tags] +|False +a| + +|subscriptionId +|string +|False +a| + +|deploymentId +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceType +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|singleNetworkInterface +|boolean +|False +a| + +|subscriptionName +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|dataDisks +|array[link:#AzureDataDiskResponse[AzureDataDiskResponse]] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#AzureAvailabilitySet] +[.api-collapsible-fifth-title] +AzureAvailabilitySet + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|faultDomain +|integer +|False +a| + +|updateDomain +|integer +|False +a| + +|=== + + +[#AzureHaNodeInfo] +[.api-collapsible-fifth-title] +AzureHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceId +|string +|False +a| + +|primaryIp +|string +|False +a| + +|state +|string +|False +a| + +|serialNumber +|string +|False +a| + +|availabilitySet +|link:#AzureAvailabilitySet[AzureAvailabilitySet] +|True +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|=== + + +[#AzureHaProperties] +[.api-collapsible-fifth-title] +AzureHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|loadBalancerName +|string +|False +a| + +|haEnabledOnLbRules +|boolean +|False +a| + +|node1Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|node2Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|multiZone +|boolean +|False +a| + +|applicationSecurityGroupName +|string +|False +a| + +|azureHaDeploymentType +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-vsa-volumes--change-tier.adoc b/cvo/post-azure-vsa-volumes--change-tier.adoc new file mode 100644 index 00000000..3730f5c3 --- /dev/null +++ b/cvo/post-azure-vsa-volumes--change-tier.adoc @@ -0,0 +1,229 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-volumes--change-tier.html' +summary: 'Update the underlying volume tier' +--- + += Update the underlying volume tier + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier`# + + + +Updates the underlying volume tier. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Target aggregate name + + +|numOfDisks +|integer +|True +a|Number of new disks needed + + +|newAggregate +|boolean +|True +a|Indicates if it is a newly created aggregate + + +|newDiskTypeName +|string +|True +a|New disk type name + + +|newCapacityTier +|string +|False +a|New capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|newTieringPolicy +|string +|False +a|New tiering policy + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-vsa-volumes--clone.adoc b/cvo/post-azure-vsa-volumes--clone.adoc new file mode 100644 index 00000000..66f9b7ff --- /dev/null +++ b/cvo/post-azure-vsa-volumes--clone.adoc @@ -0,0 +1,89 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-volumes--clone.html' +summary: 'Clone an existing volume' +--- + += Clone an existing volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone`# + + + +Clones an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newVolumeName +|string +|True +a|New volume name + + +|parentSnapshot +|string +|False +a|Snapshot name to use for the clone + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "newVolumeName": "string", + "parentSnapshot": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-volumes--move.adoc b/cvo/post-azure-vsa-volumes--move.adoc new file mode 100644 index 00000000..7594ebd3 --- /dev/null +++ b/cvo/post-azure-vsa-volumes--move.adoc @@ -0,0 +1,203 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-volumes--move.html' +summary: 'Move an existing volume' +--- + += Move an existing volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move`# + + + +Moves an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|targetAggregateName +|string +|True +a|Target aggregate name + + +|numOfDisksToAdd +|integer +|True +a|Target aggregate number of disks to add + + +|createTargetAggregate +|boolean +|True +a|Specifies if the aggregate is a new target aggregate + + +|newDiskTypeName +|string +|False +a|New disk type for the volume + + +|newCapacityTier +|string +|False +a|New capacity tier + + +|newTieringPolicy +|string +|False +a|New tiering policy + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-vsa-volumes--snapshot.adoc b/cvo/post-azure-vsa-volumes--snapshot.adoc new file mode 100644 index 00000000..012bdcf5 --- /dev/null +++ b/cvo/post-azure-vsa-volumes--snapshot.adoc @@ -0,0 +1,82 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-volumes--snapshot.html' +summary: 'Create a snapshot' +--- + += Create a snapshot + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Creates a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|string +|False +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-volumes-initiator.adoc b/cvo/post-azure-vsa-volumes-initiator.adoc new file mode 100644 index 00000000..7ed5f022 --- /dev/null +++ b/cvo/post-azure-vsa-volumes-initiator.adoc @@ -0,0 +1,59 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-volumes-initiator.html' +summary: 'Add an iSCSI initiator' +--- + += Add an iSCSI initiator + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/volumes/initiator`# + + + +Adds an iSCSI initiator. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-volumes-quote.adoc b/cvo/post-azure-vsa-volumes-quote.adoc new file mode 100644 index 00000000..bf301919 --- /dev/null +++ b/cvo/post-azure-vsa-volumes-quote.adoc @@ -0,0 +1,285 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-volumes-quote.html' +summary: 'Retrieve quotes for a new Azure volume' +--- + += Retrieve quotes for a new Azure volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/volumes/quote`# + + + +Retrieves quotes for a new volume. Returns the resource quote required for the requested volume. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|True +a|Cloud Volumes ONTAP system ID + + +|svmName +|string +|True +a|SVM name + + +|aggregateName +|string +|False +a|Optionally choose in which aggregate to create the volume + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|enableThinProvisioning +|boolean +|True +a|Enable thin provisioning on the volume + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|verifyNameUniqueness +|boolean +|True +a|Verify volume name uniqueness within the SVM + + +|capacityTier +|string +|False +a|Capacity tier + + +|isReplicationFlow +|boolean +|True +a|Is replication flow + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|aggregateName +|string +|True +a|The aggregate on which the requested volume will be created + + +|newAggregate +|boolean +|True +a|Is it a newly created aggregate + + +|autoVsaCapacityManagement +|boolean +|True +a|Indicates if automatic Cloud Volumes ONTAP capacity management is enabled + + +|elasticVolumeQuoteResponse +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-vsa-volumes.adoc b/cvo/post-azure-vsa-volumes.adoc new file mode 100644 index 00000000..8a4ce87f --- /dev/null +++ b/cvo/post-azure-vsa-volumes.adoc @@ -0,0 +1,610 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-volumes.html' +summary: 'Create a new volume' +--- + += Create a new volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/volumes`# + + + +Creates a new volume. If the aggregateName and maxNumOfDisksApprovedToAdd properties are not populated, the response fails with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|createAggregateIfNotFound +|boolean +|query +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|True +a|Cloud Volumes ONTAP system ID + + +|svmName +|string +|True +a|SVM name + + +|aggregateName +|string +|True +a|Aggregate in which the volume will be created + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|True +a|Snapshot policy name + + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|iscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableThinProvisioning +|boolean +|True +a|Enable thin provisioning on the volume + + +|enableCompression +|boolean +|True +a|Enable compression on the volume + + +|enableDeduplication +|boolean +|True +a|Enable deduplication on the volume + + +|maxNumOfDisksApprovedToAdd +|integer +|True +a|Maximum number of disks approved to allocate + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|providerVolumeType +|string +|False +a|Provider volume type + + +|syncToS3 +|boolean +|True +a|Add a cloud sync relationship + + +|capacityTier +|string +|False +a|Capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|junctionPath +|string +|False +a|Junction path + + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|volumeTags +|array[link:#VolumeTags[VolumeTags]] +|True +a|Optionally, provide key-value pairs with which to tag the ONTAP volume using the App Template service. + + +|comment +|string +|False +a|Volume Comment + + +|flexGroupVolumeInfo +|link:#FlexGroupVolumeInfo[FlexGroupVolumeInfo] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +[#VolumeTags] +[.api-collapsible-fifth-title] +VolumeTags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|False +a| + +|tagValue +|string +|False +a| + +|=== + + +[#FlexGroupVolumeInfo] +[.api-collapsible-fifth-title] +FlexGroupVolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateList +|array[string] +|False +a|Names of aggregates for the FlexGroup volume + + +|numberOfConstituents +|integer +|False +a|Number of constituents for the FlexGroup volume + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-vsa-working-environments-change-serial.adoc b/cvo/post-azure-vsa-working-environments-change-serial.adoc new file mode 100644 index 00000000..3b35c03c --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-change-serial.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-change-serial.html' +summary: 'Update the serial number of Cloud Volumes ONTAP' +--- + += Update the serial number of Cloud Volumes ONTAP + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/change-serial`# + + + +Updates the serial number of a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodeOne +|string +|True +a| + +|nodeTwo +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nodeOne": "string", + "nodeTwo": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-working-environments-change-tier-level.adoc b/cvo/post-azure-vsa-working-environments-change-tier-level.adoc new file mode 100644 index 00000000..e4decec9 --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-change-tier-level.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-change-tier-level.html' +summary: 'Change the tier level' +--- + += Change the tier level + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/change-tier-level`# + + + +Updates the tier level. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|level +|string +|True +a|Update tier level + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "level": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-working-environments-cifs.adoc b/cvo/post-azure-vsa-working-environments-cifs.adoc new file mode 100644 index 00000000..45e5906e --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-cifs.adoc @@ -0,0 +1,121 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-cifs.html' +summary: 'Set up a new CIFS configuration' +--- + += Set up a new CIFS configuration + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/cifs`# + + + +Sets up a new CIFS configuration for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|False +a|DNS domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|activeDirectoryUsername +|string +|True +a|Active Directory username + + +|activeDirectoryPassword +|string +|True +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "activeDirectoryDomain": "string", + "activeDirectoryUsername": "string", + "activeDirectoryPassword": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-working-environments-delete-cifs.adoc b/cvo/post-azure-vsa-working-environments-delete-cifs.adoc new file mode 100644 index 00000000..9964ba8e --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-delete-cifs.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-delete-cifs.html' +summary: 'Delete a CIFS configuration' +--- + += Delete a CIFS configuration + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/delete-cifs`# + + + +Deletes the CIFS configuration of an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|activeDirectoryUsername +|string +|False +a|Active Directory username + + +|activeDirectoryPassword +|string +|False +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "activeDirectoryUsername": "string", + "activeDirectoryPassword": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-working-environments-enable-capacity-tiering.adoc b/cvo/post-azure-vsa-working-environments-enable-capacity-tiering.adoc new file mode 100644 index 00000000..d14b4e7d --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-enable-capacity-tiering.adoc @@ -0,0 +1,81 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-enable-capacity-tiering.html' +summary: 'Enable capacity tiering' +--- + += Enable capacity tiering + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering`# + + + +Enables capacity tiering. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceProfileName +|string +|False +a| + +|gcpStorageAccountId +|string +|False +a| + +|storageAccountPrefix +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceProfileName": "string", + "gcpStorageAccountId": "string", + "storageAccountPrefix": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-working-environments-extra-capacity-licenses.adoc b/cvo/post-azure-vsa-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..4d303c63 --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-extra-capacity-licenses.html' +summary: 'Register extra capacity licenses' +--- + += Register extra capacity licenses + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Registers an extra capacity license. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licences +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licences": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-working-environments-extra-capacity-serials.adoc b/cvo/post-azure-vsa-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..00e78efd --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-extra-capacity-serials.html' +summary: 'Register extra capacity serial numbers' +--- + += Register extra capacity serial numbers + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Registers an extra capacity serial number. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-working-environments-ntp.adoc b/cvo/post-azure-vsa-working-environments-ntp.adoc new file mode 100644 index 00000000..90216541 --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-ntp.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-ntp.html' +summary: 'Set up an NTP server' +--- + += Set up an NTP server + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/ntp`# + + + +Sets up an NTP server. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ntpServer +|string +|True +a|NTPS server + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "ntpServer": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-working-environments-parse-license-file.adoc b/cvo/post-azure-vsa-working-environments-parse-license-file.adoc new file mode 100644 index 00000000..8960d0dd --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-parse-license-file.adoc @@ -0,0 +1,232 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-parse-license-file.html' +summary: 'Parse an uploaded cloud license file' +--- + += Parse an uploaded cloud license file + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/parse-license-file`# + + + +Parses an uploaded cloud license file. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|license +|string +|True +a| + +|serialNumber +|string +|False +a| + +|contractEndDate +|link:#contractEndDate[contractEndDate] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "license": "string", + "serialNumber": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +[#contractEndDate] +[.api-collapsible-fifth-title] +contractEndDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-vsa-working-environments-snapshot-policy.adoc b/cvo/post-azure-vsa-working-environments-snapshot-policy.adoc new file mode 100644 index 00000000..fa25f39b --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-snapshot-policy.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-snapshot-policy.html' +summary: 'Create a snapshot policy' +--- + += Create a snapshot policy + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/snapshot-policy`# + + + +Creates a snapshot policy. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|schedules +|array[link:#SnapshotPolicyScheduleRequest[SnapshotPolicyScheduleRequest]] +|True +a|Snapshot policy schedules + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "schedules": [ + {} + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SnapshotPolicyScheduleRequest] +[.api-collapsible-fifth-title] +SnapshotPolicyScheduleRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scheduleType +|string +|True +a|Snapshot policy schedule type + + +|retention +|integer +|True +a|Snapshot policy retention + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-vsa-working-environments-start.adoc b/cvo/post-azure-vsa-working-environments-start.adoc new file mode 100644 index 00000000..4d68ec3b --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-start.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-start.html' +summary: 'Start a specific Cloud Volumes ONTAP instance' +--- + += Start a specific Cloud Volumes ONTAP instance + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/start`# + + + +Starts a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-working-environments-stop.adoc b/cvo/post-azure-vsa-working-environments-stop.adoc new file mode 100644 index 00000000..265a35b7 --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-stop.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-stop.html' +summary: 'Stop a specific Cloud Volumes ONTAP instance' +--- + += Stop a specific Cloud Volumes ONTAP instance + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/stop`# + + + +Stops a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|takeSnapshots +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-working-environments-support-registration.adoc b/cvo/post-azure-vsa-working-environments-support-registration.adoc new file mode 100644 index 00000000..f9bcfc8e --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-support-registration.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-support-registration.html' +summary: 'Register a Cloud Volumes ONTAP system with NetApp' +--- + += Register a Cloud Volumes ONTAP system with NetApp + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/support-registration`# + + + +Registers a Cloud Volumes ONTAP system with NetApp. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|nssAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|licenseStartDate +|link:#licenseStartDate[licenseStartDate] +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "nssAccountId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#licenseStartDate] +[.api-collapsible-fifth-title] +licenseStartDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-vsa-working-environments-svm.adoc b/cvo/post-azure-vsa-working-environments-svm.adoc new file mode 100644 index 00000000..68351ebf --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-svm.adoc @@ -0,0 +1,187 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-svm.html' +summary: 'Create a new SVM' +--- + += Create a new SVM + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/svm`# + + + +Creates a new SVM. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|svmName +|string +|False +a| + +|svmPassword +|link:#AzureSvmPassword[AzureSvmPassword] +|False +a| + +|mgmtLif +|boolean +|True +a|Create a management LIF for the SVM + + +|rootVolumeAggregate +|string +|False +a|Root volume aggregate name + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#AzureSvmPassword] +[.api-collapsible-fifth-title] +AzureSvmPassword + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-vsa-working-environments-sync-subscription.adoc b/cvo/post-azure-vsa-working-environments-sync-subscription.adoc new file mode 100644 index 00000000..7cdf8dfa --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-sync-subscription.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-sync-subscription.html' +summary: 'Trigger subscription synchronization' +--- + += Trigger subscription synchronization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/sync-subscription`# + + + +Manually triggers subscription synchronization for all Cloud Volumes ONTAP systems. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-working-environments-update-image.adoc b/cvo/post-azure-vsa-working-environments-update-image.adoc new file mode 100644 index 00000000..7b08c8b7 --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-update-image.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-update-image.html' +summary: 'Perform a complete image update operation' +--- + += Perform a complete image update operation + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/update-image`# + + + +Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|updateType +|string +|True +a|System update type. System updates can be performed by providing either an external URL that ONTAP will use to download the image file or a name of an image provided by the NetApp Console. + + +|updateParameter +|string +|True +a|Parameter specific to the specified update type. External file URL or the NetApp Console provided image name. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "updateType": "string", + "updateParameter": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-working-environments-upload-license-file.adoc b/cvo/post-azure-vsa-working-environments-upload-license-file.adoc new file mode 100644 index 00000000..31f2bcb1 --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-upload-license-file.adoc @@ -0,0 +1,197 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-upload-license-file.html' +summary: 'Upload a cloud license file' +--- + += Upload a cloud license file + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/upload-license-file`# + + + +Uploads a cloud license file on the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +//end collapsible .Definitions block +==== diff --git a/cvo/post-azure-vsa-working-environments-upload-licenses.adoc b/cvo/post-azure-vsa-working-environments-upload-licenses.adoc new file mode 100644 index 00000000..d9d62bf7 --- /dev/null +++ b/cvo/post-azure-vsa-working-environments-upload-licenses.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments-upload-licenses.html' +summary: 'Upload cloud license file content' +--- + += Upload cloud license file content + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/upload-licenses`# + + + +Uploads the content of a cloud license file on the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenseOne +|string +|True +a| + +|licenseTwo +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licenseOne": "string", + "licenseTwo": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-azure-vsa-working-environments.adoc b/cvo/post-azure-vsa-working-environments.adoc new file mode 100644 index 00000000..fda50ac1 --- /dev/null +++ b/cvo/post-azure-vsa-working-environments.adoc @@ -0,0 +1,4062 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-azure-vsa-working-environments.html' +summary: 'Create a new Cloud Volumes ONTAP system' +--- + += Create a new Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/azure/vsa/working-environments`# + + + +Creates a new Cloud Volumes ONTAP system. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|svmPassword +|string +|False +a| + +|username +|link:#AdminUsername[AdminUsername] +|False +a| + +|vnetId +|string +|True +a| + +|cidr +|string +|False +a| + +|description +|string +|False +a| + +|volume +|link:#VsaVolumeOnNewVsaCreateRequest[VsaVolumeOnNewVsaCreateRequest] +|False +a| + +|region +|string +|False +a| + +|tenantId +|string +|False +a| + +|subnetId +|string +|True +a|Subnet ID for a single node cluster + + +|dataEncryptionType +|string +|True +a|Type of encryption to use for this system + + +|ontapEncryptionParameters +|link:#OntapEncryption[OntapEncryption] +|False +a| + +|securityGroupId +|string +|False +a| + +|openSecurityGroup +|link:#openSecurityGroup[openSecurityGroup] +|False +a|Open the security group to all IP ranges + + +|serialNumber +|string +|False +a| + +|cifsConfigurationRequest +|link:#CIFSConfigurationRequest[CIFSConfigurationRequest] +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|storageType +|string +|True +a|Storage type + + +|azureTags +|array[link:#AzureTag[AzureTag]] +|True +a|Optionally, provide up to four key-value pairs used to tag the resource group created by NetApp Console. + + +|writingSpeedState +|string +|False +a|Writing speed state + + +|vsaMetadata +|link:#VsaMetadataRequest[VsaMetadataRequest] +|True +a| + +|failedToCreateWorkingEnvironmentId +|string +|False +a|Public ID of a failed-to-create system + + +|packageName +|string +|False +a|Pre-configured package name + + +|vhdImageRequest +|link:#VhdImageRequest[VhdImageRequest] +|False +a| + +|resourceGroup +|string +|False +a|Custom resource group name + + +|subscriptionId +|string +|False +a|Subscription ID + + +|capacityTier +|string +|False +a|Capacity tier + + +|haParams +|link:#AzureHaParameters[AzureHaParameters] +|False +a| + +|allowDeployInExistingRg +|boolean +|False +a|Allow deployment in an existing resource group + + +|svmName +|string +|False +a|SVM name + + +|wormRequest +|link:#WormRequest[WormRequest] +|False +a| + +|cloudProviderAccount +|string +|False +a|Cloud provider account + + +|nssAccount +|string +|False +a|NetApp Support Site (NSS) account + + +|saasSubscriptionId +|string +|False +a|SaaS subscription ID + + +|enableCompliance +|boolean +|True +a|Enable compliance + + +|storageAccountPrefix +|string +|False +a|Storage account prefix + + +|backupVolumesToCbs +|boolean +|False +a|Automatically back up all volumes to the cloud + + +|tierLevel +|string +|False +a|Tier Level + + +|availabilityZone +|integer +|False +a|Availability Zone + + +|enableMonitoring +|boolean +|True +a|Enable monitoring + + +|azureEncryptionParameters +|link:#AzureEncryption[AzureEncryption] +|False +a| + +|enableServices +|array[string] +|False +a|Enable services + + +|storageAccountNetworkAccess +|string +|False +a|Storage account public network access + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#AzureProperties[AzureProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|False +a| + +|haProperties +|link:#AzureHaProperties[AzureHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "name": "string", + "tenantId": "string", + "svmName": "string", + "creatorUserEmail": "string", + "status": { + "status": "string", + "message": "string", + "extendedFailureReason": "string" + }, + "providerProperties": { + "regionName": "string", + "vnetCidr": "string", + "subscriptionId": "string", + "deploymentId": "string", + "instanceType": "string", + "subscriptionName": "string", + "cloudProviderAccountId": "string", + "dataDisks": [ + { + "name": "string", + "id": "string", + "caching": "string", + "accountType": "string", + "encryptionSet": "string" + } + ] + }, + "clusterProperties": { + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "clusterName": "string", + "ontapVersion": "string", + "accountId": "string", + "productCode": "string", + "amiId": "string", + "systemManagerUrl": "string", + "instanceId": "string", + "platformLicense": "string", + "instanceType": "string", + "publicIp": "string", + "publicDnsName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string" + }, + "ontapClusterProperties": { + "nodes": [ + { + "name": "string", + "lifs": [ + {} + ], + "serialNumber": "string", + "systemId": "string", + "platformLicense": "string", + "platformSerialNumber": "string", + "cloudProviderId": "string" + } + ], + "clusterName": "string", + "clusterUuid": "string", + "ontapVersion": "string", + "systemManagerUrl": "string", + "licensePackageName": "string", + "upgradeVersions": [ + {} + ], + "writingSpeedState": "string", + "broadcastDomainInfos": [ + {} + ], + "capacityTierInfo": { + "s3BucketName": "string", + "tierLevel": "string" + }, + "userName": "string", + "vscanFileOperationDefaultProfile": "string" + }, + "cloudProviderName": "string", + "snapshotPolicies": [ + { + "name": "string", + "schedules": [ + {} + ], + "description": "string" + } + ], + "actionsRequired": [ + {} + ], + "activeActions": [ + "string" + ], + "replicationProperties": { + "peers": [ + "string" + ], + "replicationTargets": [ + "string" + ] + }, + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ], + "svms": [ + {} + ], + "workingEnvironmentType": "string", + "supportRegistrationProperties": { + "supportRegistrationStatus": "string" + }, + "supportRegistrationInformation": [ + { + "supportRegistrationStatus": "string", + "serialNumber": "string", + "nssAccountId": "string" + } + ], + "capacityFeatures": { + "providerVolumesType": [ + { + "supportedVolumeTypes": [ + "string" + ], + "maxDisksAllow": { + "reason": "string" + } + } + ], + "defaultProviderVolumeType": { + "diskType": "string", + "capacityTier": "string" + }, + "supportedCapacityTiers": { + "supportedCapacityTiersPerVolumeType": [ + { + "volumeType": "string", + "supportedCapacityTiers": [ + "string" + ], + "availableTieringPolicies": [ + "string" + ] + } + ], + "capacityTiersDisableReasons": [ + "string" + ] + }, + "existingIops": [ + "object" + ] + }, + "encryptionProperties": { + "keyManagers": [ + { + "publicId": "string", + "name": "string", + "address": "string", + "usernameField": "string", + "usernameValue": "string", + "status": "string" + } + ], + "encryptionCertificates": [ + {} + ], + "awsEncryptionKey": { + "alias": "string", + "keyId": "string", + "status": "string", + "origin": "string" + } + }, + "haProperties": { + "loadBalancerName": "string", + "applicationSecurityGroupName": "string", + "azureHaDeploymentType": "string" + }, + "fpolicyProperties": { + "fileExtensions": [ + "string" + ] + }, + "saasProperties": { + "subscription": { + "id": "string", + "name": "string" + }, + "capacityLicensePackage": "string" + }, + "cbsProperties": { + "cbsBackupStatus": "string", + "cbsRules": [ + { + "snapmirrorLabel": "string" + } + ], + "objectStoreName": "string", + "providerSpecific": { + "azureRgName": "string", + "gcpProjectId": "string", + "gcpRegion": "string" + }, + "cbsPolicyName": "string", + "ipSpace": "string", + "region": "string", + "providerAccountName": "string", + "exclusionReason": "string" + }, + "complianceProperties": { + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" + }, + "monitoringProperties": { + "monitoringStatus": "string", + "monitoringInfo": { + "averageLatency": { + "unit": "string" + }, + "storageAverageThroughput": { + "unit": "string" + }, + "node1AverageThroughput": { + "unit": "string" + }, + "node2AverageThroughput": { + "unit": "string" + } + }, + "tenantUrl": "string" + }, + "licensesInformation": [ + { + "type": "string", + "useType": "string", + "package": "string", + "serialNumbers": [ + "string" + ], + "expirations": [ + "object" + ] + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#AdminUsername] +[.api-collapsible-fifth-title] +AdminUsername + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#VsaVolumeOnNewVsaCreateRequest] +[.api-collapsible-fifth-title] +VsaVolumeOnNewVsaCreateRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|False +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|False +a| + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|iscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableThinProvisioning +|boolean +|False +a|Enable thin provisioning on the volume + + +|enableCompression +|boolean +|False +a|Enable compression on the volume + + +|enableDeduplication +|boolean +|False +a|Enable deduplication on the volume + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|junctionPath +|string +|False +a|Junction path + + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|=== + + +[#OntapEncryption] +[.api-collapsible-fifth-title] +OntapEncryption + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|keyManagerIds +|array[string] +|False +a| + +|keyManagerCaCertificateId +|string +|False +a| + +|=== + + +[#openSecurityGroup] +[.api-collapsible-fifth-title] +openSecurityGroup + +Open the security group to all IP ranges + + + +[#CIFSConfigurationRequest] +[.api-collapsible-fifth-title] +CIFSConfigurationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|False +a|DNS domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|activeDirectoryUsername +|string +|True +a|Active Directory username + + +|activeDirectoryPassword +|string +|True +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +[#AzureTag] +[.api-collapsible-fifth-title] +AzureTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|False +a| + +|tagValue +|string +|False +a| + +|=== + + +[#VsaMetadataRequest] +[.api-collapsible-fifth-title] +VsaMetadataRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a|ONTAP version + + +|licenseType +|string +|True +a|License type + + +|instanceType +|string +|True +a|Instance type + + +|platformSerialNumber +|string +|False +a|Optional platform serial number + + +|providedLicense +|string +|False +a|Optional provided license + + +|capacityPackageName +|string +|False +a|Optional capacity-based package + + +|keyStoneSubscription +|string +|False +a|Keystone subscription ID + + +|useLatestVersion +|boolean +|False +a|Use the latest version + + +|=== + + +[#VhdImageRequest] +[.api-collapsible-fifth-title] +VhdImageRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|blobUrl +|string +|False +a| + +|=== + + +[#AzureHaParameters] +[.api-collapsible-fifth-title] +AzureHaParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|platformSerialNumberNode1 +|string +|False +a| + +|platformSerialNumberNode2 +|string +|False +a| + +|availabilityZoneNode1 +|integer +|False +a| + +|availabilityZoneNode2 +|integer +|False +a| + +|enableHttps +|boolean +|False +a| + +|multiZone +|boolean +|False +a| + +|=== + + +[#WormRetentionPeriod] +[.api-collapsible-fifth-title] +WormRetentionPeriod + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|True +a|Length + + +|unit +|string +|True +a|Unit + + +|=== + + +[#WormRequest] +[.api-collapsible-fifth-title] +WormRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|retentionPeriod +|link:#WormRetentionPeriod[WormRetentionPeriod] +|True +a| + +|=== + + +[#AzureEncryption] +[.api-collapsible-fifth-title] +AzureEncryption + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|False +a| + +|vaultName +|string +|False +a| + +|userAssignedIdentity +|string +|False +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#AzureResourceGroupResponse] +[.api-collapsible-fifth-title] +AzureResourceGroupResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|location +|string +|False +a| + +|tags +|link:#tags[tags] +|True +a| + +|=== + + +[#availabilityZone] +[.api-collapsible-fifth-title] +availabilityZone + + +[#AzureDataDiskResponse] +[.api-collapsible-fifth-title] +AzureDataDiskResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|diskSizeGB +|integer +|False +a| + +|lun +|integer +|False +a| + +|id +|string +|False +a| + +|caching +|string +|False +a| + +|accountType +|string +|False +a| + +|managed +|boolean +|False +a| + +|encryptionSet +|string +|False +a| + +|=== + + +[#AzureProperties] +[.api-collapsible-fifth-title] +AzureProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|resourceGroup +|link:#AzureResourceGroupResponse[AzureResourceGroupResponse] +|False +a| + +|vnetCidr +|string +|False +a| + +|tags +|link:#tags[tags] +|False +a| + +|subscriptionId +|string +|False +a| + +|deploymentId +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceType +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|singleNetworkInterface +|boolean +|False +a| + +|subscriptionName +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|dataDisks +|array[link:#AzureDataDiskResponse[AzureDataDiskResponse]] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#AzureAvailabilitySet] +[.api-collapsible-fifth-title] +AzureAvailabilitySet + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|faultDomain +|integer +|False +a| + +|updateDomain +|integer +|False +a| + +|=== + + +[#AzureHaNodeInfo] +[.api-collapsible-fifth-title] +AzureHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceId +|string +|False +a| + +|primaryIp +|string +|False +a| + +|state +|string +|False +a| + +|serialNumber +|string +|False +a| + +|availabilitySet +|link:#AzureAvailabilitySet[AzureAvailabilitySet] +|True +a| + +|availabilityZone +|link:#availabilityZone[availabilityZone] +|False +a| + +|=== + + +[#AzureHaProperties] +[.api-collapsible-fifth-title] +AzureHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|loadBalancerName +|string +|False +a| + +|haEnabledOnLbRules +|boolean +|False +a| + +|node1Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|node2Info +|link:#AzureHaNodeInfo[AzureHaNodeInfo] +|False +a| + +|multiZone +|boolean +|False +a| + +|applicationSecurityGroupName +|string +|False +a| + +|azureHaDeploymentType +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-cloud-compliance-deploy-by-working-environments.adoc b/cvo/post-cloud-compliance-deploy-by-working-environments.adoc new file mode 100644 index 00000000..4e7c73ae --- /dev/null +++ b/cvo/post-cloud-compliance-deploy-by-working-environments.adoc @@ -0,0 +1,58 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-cloud-compliance-deploy-by-working-environments.html' +summary: 'Deploy a cloud compliance instance by systems' +--- + += Deploy a cloud compliance instance by systems + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/cloud-compliance/deploy-by-working-environments`# + + + +Deploys a Cloud Compliance instance by systems. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentIds +|array[string] +|True +a| + +|enableAnf +|boolean +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "workingEnvironmentIds": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-cloud-compliance-disable-onprem-scan.adoc b/cvo/post-cloud-compliance-disable-onprem-scan.adoc new file mode 100644 index 00000000..91da890a --- /dev/null +++ b/cvo/post-cloud-compliance-disable-onprem-scan.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-cloud-compliance-disable-onprem-scan.html' +summary: 'Disable on-premises scanning' +--- + += Disable on-premises scanning + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/cloud-compliance/{workingEnvironmentId}/disable-onprem-scan`# + + + +Disables on-premises scanning. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-cloud-compliance-disable-scan.adoc b/cvo/post-cloud-compliance-disable-scan.adoc new file mode 100644 index 00000000..3bd5b82d --- /dev/null +++ b/cvo/post-cloud-compliance-disable-scan.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-cloud-compliance-disable-scan.html' +summary: 'Disable scanning using the system ID' +--- + += Disable scanning using the system ID + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/cloud-compliance/{workingEnvironmentId}/disable-scan`# + + + +Disables scanning using the system ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-cloud-compliance-disable-service-scan.adoc b/cvo/post-cloud-compliance-disable-service-scan.adoc new file mode 100644 index 00000000..0c119022 --- /dev/null +++ b/cvo/post-cloud-compliance-disable-service-scan.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-cloud-compliance-disable-service-scan.html' +summary: 'Disable scanning using the service ID' +--- + += Disable scanning using the service ID + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/cloud-compliance/{serviceId}/disable-service-scan`# + + + +Disables scanning using the service ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|serviceId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-cloud-compliance-enable-onprem-scan.adoc b/cvo/post-cloud-compliance-enable-onprem-scan.adoc new file mode 100644 index 00000000..9f6df060 --- /dev/null +++ b/cvo/post-cloud-compliance-enable-onprem-scan.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-cloud-compliance-enable-onprem-scan.html' +summary: 'Enable on-premises scanning using the system ID' +--- + += Enable on-premises scanning using the system ID + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/cloud-compliance/{workingEnvironmentId}/enable-onprem-scan`# + + + +Enables on-premises scanning using the system ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-cloud-compliance-enable-scan.adoc b/cvo/post-cloud-compliance-enable-scan.adoc new file mode 100644 index 00000000..80572035 --- /dev/null +++ b/cvo/post-cloud-compliance-enable-scan.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-cloud-compliance-enable-scan.html' +summary: 'Enable scanning using the system ID' +--- + += Enable scanning using the system ID + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/cloud-compliance/{workingEnvironmentId}/enable-scan`# + + + +Enables scanning using the system ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-cloud-compliance-enable-service-scan.adoc b/cvo/post-cloud-compliance-enable-service-scan.adoc new file mode 100644 index 00000000..c124e42f --- /dev/null +++ b/cvo/post-cloud-compliance-enable-service-scan.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-cloud-compliance-enable-service-scan.html' +summary: 'Enable scanning using the service ID' +--- + += Enable scanning using the service ID + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/cloud-compliance/{serviceId}/enable-service-scan`# + + + +Enables scanning using the service ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|serviceId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceProfileName +|string +|False +a|Instance profile name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceProfileName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-cloud-compliance-fsx-disable-scan.adoc b/cvo/post-cloud-compliance-fsx-disable-scan.adoc new file mode 100644 index 00000000..a2a7cafb --- /dev/null +++ b/cvo/post-cloud-compliance-fsx-disable-scan.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-cloud-compliance-fsx-disable-scan.html' +summary: 'Disable scanning using the file system ID' +--- + += Disable scanning using the file system ID + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/cloud-compliance/fsx/{fileSystemId}/disable-scan`# + + + +Disables scanning using the file system ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-cloud-compliance-fsx-enable-scan.adoc b/cvo/post-cloud-compliance-fsx-enable-scan.adoc new file mode 100644 index 00000000..d1ad89ed --- /dev/null +++ b/cvo/post-cloud-compliance-fsx-enable-scan.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-cloud-compliance-fsx-enable-scan.html' +summary: 'Enable scanning using the file system ID' +--- + += Enable scanning using the file system ID + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/cloud-compliance/fsx/{fileSystemId}/enable-scan`# + + + +Enables scanning using the file system ID. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-flexcache-fsx.adoc b/cvo/post-flexcache-fsx.adoc new file mode 100644 index 00000000..553ffb15 --- /dev/null +++ b/cvo/post-flexcache-fsx.adoc @@ -0,0 +1,109 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-flexcache-fsx.html' +summary: 'Create a new FlexCache volume for an FSx system' +--- + += Create a new FlexCache volume for an FSx system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/flexcache/fsx`# + + + +Creates a new FlexCache volume in an FSx system. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sourceWorkingEnvironmentId +|string +|True +a|Source system ID + + +|destinationWorkingEnvironmentId +|string +|True +a|Destination system ID + + +|sourceSvmName +|string +|True +a|Source SVM name + + +|destinationSvmName +|string +|True +a|Destination SVM name + + +|sourceIpSpace +|string +|False +a|Source IPspace + + +|destinationIpSpace +|string +|False +a|Destination IPspace + + +|sourceVolumes +|array[string] +|True +a|Names of source volumes + + +|cacheVolumePercentage +|integer +|True +a|FlexCache volume percentage + + +|nameForSingleVolume +|string +|False +a|FlexCache volume name for a single volume + + +|namePrefix +|string +|False +a|FlexCache name prefix + + +|nameSuffix +|string +|False +a|FlexCache name suffix + + +|replicateNfsCifsShares +|boolean +|True +a|Replicate NFS and CIFS shares as source volume + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-flexcache.adoc b/cvo/post-flexcache.adoc new file mode 100644 index 00000000..6bbdf7d0 --- /dev/null +++ b/cvo/post-flexcache.adoc @@ -0,0 +1,109 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-flexcache.html' +summary: 'Create a new FlexCache volume' +--- + += Create a new FlexCache volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/flexcache`# + + + +Creates a new FlexCache volume in a Cloud Volumes ONTAP system. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sourceWorkingEnvironmentId +|string +|True +a|Source system ID + + +|destinationWorkingEnvironmentId +|string +|True +a|Destination system ID + + +|sourceSvmName +|string +|True +a|Source SVM name + + +|destinationSvmName +|string +|True +a|Destination SVM name + + +|sourceIpSpace +|string +|False +a|Source IPspace + + +|destinationIpSpace +|string +|False +a|Destination IPspace + + +|sourceVolumes +|array[string] +|True +a|Names of source volumes + + +|cacheVolumePercentage +|integer +|True +a|FlexCache volume percentage + + +|nameForSingleVolume +|string +|False +a|FlexCache volume name for a single volume + + +|namePrefix +|string +|False +a|FlexCache name prefix + + +|nameSuffix +|string +|False +a|FlexCache name suffix + + +|replicateNfsCifsShares +|boolean +|True +a|Replicate NFS and CIFS shares as source volume + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-fsx-volumes--clone.adoc b/cvo/post-fsx-volumes--clone.adoc new file mode 100644 index 00000000..5a587cb6 --- /dev/null +++ b/cvo/post-fsx-volumes--clone.adoc @@ -0,0 +1,89 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-fsx-volumes--clone.html' +summary: 'Clone a volume' +--- + += Clone a volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/clone`# + + + +Clones an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newVolumeName +|string +|True +a|New volume name + + +|parentSnapshot +|string +|False +a|Snapshot name to use for the clone + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "newVolumeName": "string", + "parentSnapshot": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-fsx-volumes--snapshot.adoc b/cvo/post-fsx-volumes--snapshot.adoc new file mode 100644 index 00000000..57bcf3b2 --- /dev/null +++ b/cvo/post-fsx-volumes--snapshot.adoc @@ -0,0 +1,82 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-fsx-volumes--snapshot.html' +summary: 'Create a snapshot' +--- + += Create a snapshot + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/snapshot`# + + + +Creates a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|string +|False +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-fsx-volumes-initiator.adoc b/cvo/post-fsx-volumes-initiator.adoc new file mode 100644 index 00000000..cb278bf2 --- /dev/null +++ b/cvo/post-fsx-volumes-initiator.adoc @@ -0,0 +1,59 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-fsx-volumes-initiator.html' +summary: 'Add an iSCSI initiator' +--- + += Add an iSCSI initiator + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/fsx/volumes/initiator`# + + + +Adds an iSCSI initiator. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-fsx-volumes.adoc b/cvo/post-fsx-volumes.adoc new file mode 100644 index 00000000..e9dc16b8 --- /dev/null +++ b/cvo/post-fsx-volumes.adoc @@ -0,0 +1,401 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-fsx-volumes.html' +summary: 'Create a new volume' +--- + += Create a new volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/fsx/volumes`# + + + +Creates a new volume. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|fileSystemId +|string +|True +a|Target file system ID + + +|svmName +|string +|True +a|SVM name + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|True +a|Snapshot policy name + + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|ProtocolIscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableStorageEfficiency +|boolean +|True +a|Storage efficiency + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|awsTags +|array[link:#AwsTag[AwsTag]] +|True +a|Optionally, provide up to 50 key-value pairs to be used as volume tags. + + +|numberOfConstituents +|link:#numberOfConstituents[numberOfConstituents] +|False +a|Number of constituents for the FlexGroup volume + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#AwsTag] +[.api-collapsible-fifth-title] +AwsTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|False +a| + +|tagValue +|string +|False +a| + +|=== + + +[#numberOfConstituents] +[.api-collapsible-fifth-title] +numberOfConstituents + +Number of constituents for the FlexGroup volume + + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-fsx-working-environments-cifs.adoc b/cvo/post-fsx-working-environments-cifs.adoc new file mode 100644 index 00000000..059e6345 --- /dev/null +++ b/cvo/post-fsx-working-environments-cifs.adoc @@ -0,0 +1,121 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-fsx-working-environments-cifs.html' +summary: 'Create a new CIFS configuration for an FSx system' +--- + += Create a new CIFS configuration for an FSx system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/fsx/working-environments/{fileSystemId}/cifs`# + + + +Sets up a new CIFS configuration for an existing FSx system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|False +a|DNS domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|activeDirectoryUsername +|string +|True +a|Active Directory username + + +|activeDirectoryPassword +|string +|True +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "activeDirectoryDomain": "string", + "activeDirectoryUsername": "string", + "activeDirectoryPassword": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-fsx-working-environments-validate-credentials.adoc b/cvo/post-fsx-working-environments-validate-credentials.adoc new file mode 100644 index 00000000..5fa7e303 --- /dev/null +++ b/cvo/post-fsx-working-environments-validate-credentials.adoc @@ -0,0 +1,158 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-fsx-working-environments-validate-credentials.html' +summary: 'Validate the credentials for an FSx system' +--- + += Validate the credentials for an FSx system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/fsx/working-environments/validate-credentials`# + + + +Validates the provided credentials for an existing FSx system. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a| + +|weId +|string +|False +a| + +|default +|link:#SvmCredentials[SvmCredentials] +|False +a| + +|backup +|link:#SvmCredentials[SvmCredentials] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "ip": "string", + "weId": "string", + "default": { + "userName": "string", + "password": "string" + }, + "backup": { + "userName": "string", + "password": "string" + } +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|valid +|boolean +|True +a| + +|clusterInfo +|link:#ClusterInfo[ClusterInfo] +|False +a| + +|failureReason +|string +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SvmCredentials] +[.api-collapsible-fifth-title] +SvmCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|userName +|string +|False +a| + +|password +|string +|False +a| + +|=== + + +[#ClusterInfo] +[.api-collapsible-fifth-title] +ClusterInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-ha-aggregates--disks.adoc b/cvo/post-gcp-ha-aggregates--disks.adoc new file mode 100644 index 00000000..3bd409bb --- /dev/null +++ b/cvo/post-gcp-ha-aggregates--disks.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-aggregates--disks.html' +summary: 'Add disks to an aggregate' +--- + += Add disks to an aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks`# + + + +Adds disks to an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|True +a|Number of disks + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-aggregates.adoc b/cvo/post-gcp-ha-aggregates.adoc new file mode 100644 index 00000000..2bc137e9 --- /dev/null +++ b/cvo/post-gcp-ha-aggregates.adoc @@ -0,0 +1,137 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-aggregates.html' +summary: 'Create a new aggregate' +--- + += Create a new aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/aggregates`# + + + +Creates a new aggregate. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|workingEnvironmentId +|string +|True +a| + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|initialEvAggregateSize +|link:#Capacity[Capacity] +|False +a| + +|homeNode +|string +|False +a| + +|providerVolumeType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "workingEnvironmentId": "string", + "homeNode": "string", + "providerVolumeType": "string", + "capacityTier": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-ha-discovery-recover.adoc b/cvo/post-gcp-ha-discovery-recover.adoc new file mode 100644 index 00000000..cbb3fbda --- /dev/null +++ b/cvo/post-gcp-ha-discovery-recover.adoc @@ -0,0 +1,2760 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-discovery-recover.html' +summary: 'Save an HA system to the NetApp Console database' +--- + += Save an HA system to the NetApp Console database + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/discovery/recover`# + + + +Saves a previously discovered Cloud Volumes ONTAP system to the NetApp Console database. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|True +a| + +|name +|string +|False +a| + +|clusterCredentials +|link:#ClusterCredentialsRequest[ClusterCredentialsRequest] +|True +a| + +|tenantId +|string +|False +a| + +|projectId +|string +|False +a| + +|nssAccountId +|string +|False +a|NetApp Support Site (NSS) account + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": "string", + "name": "string", + "clusterCredentials": { + "userName": "string", + "password": "string" + }, + "tenantId": "string", + "projectId": "string", + "nssAccountId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#GcpProperties[GcpProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|True +a| + +|haProperties +|link:#GcpHaProperties[GcpHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ClusterCredentialsRequest] +[.api-collapsible-fifth-title] +ClusterCredentialsRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|userName +|string +|True +a| + +|password +|string +|False +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#labels] +[.api-collapsible-fifth-title] +labels +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#GcpProperties] +[.api-collapsible-fifth-title] +GcpProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|regionName +|string +|False +a| + +|zoneName +|array[string] +|False +a| + +|instanceType +|string +|False +a| + +|subnetCidr +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|projectName +|string +|False +a| + +|deploymentName +|string +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#GcpHaMediatorInfo] +[.api-collapsible-fifth-title] +GcpHaMediatorInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInstanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|version +|string +|False +a| + +|=== + + +[#GcpHaNodeInfo] +[.api-collapsible-fifth-title] +GcpHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|=== + + +[#GcpHaProperties] +[.api-collapsible-fifth-title] +GcpHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInfo +|link:#GcpHaMediatorInfo[GcpHaMediatorInfo] +|False +a| + +|node1Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|node2Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|projectName +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-ha-metadata-create-bucket.adoc b/cvo/post-gcp-ha-metadata-create-bucket.adoc new file mode 100644 index 00000000..c1bf7ecf --- /dev/null +++ b/cvo/post-gcp-ha-metadata-create-bucket.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-metadata-create-bucket.html' +summary: 'Create a new bucket' +--- + += Create a new bucket + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/metadata/create-bucket`# + + + +Creates a new bucket. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|projectId +|string +|False +a| + +|bucketName +|string +|True +a| + +|location +|string +|False +a| + +|storageClass +|string +|False +a| + +|kmsKeyName +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "projectId": "string", + "bucketName": "string", + "location": "string", + "storageClass": "string", + "kmsKeyName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-volumes--change-tier.adoc b/cvo/post-gcp-ha-volumes--change-tier.adoc new file mode 100644 index 00000000..0f9b6b39 --- /dev/null +++ b/cvo/post-gcp-ha-volumes--change-tier.adoc @@ -0,0 +1,229 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-volumes--change-tier.html' +summary: 'Update the underlying volume tier' +--- + += Update the underlying volume tier + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier`# + + + +Updates the underlying volume tier. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Target aggregate name + + +|numOfDisks +|integer +|True +a|Number of new disks needed + + +|newAggregate +|boolean +|True +a|Indicates if it is a newly created aggregate + + +|newDiskTypeName +|string +|True +a|New disk type name + + +|newCapacityTier +|string +|False +a|New capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|newTieringPolicy +|string +|False +a|New tiering policy + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-ha-volumes--clone.adoc b/cvo/post-gcp-ha-volumes--clone.adoc new file mode 100644 index 00000000..9ad83609 --- /dev/null +++ b/cvo/post-gcp-ha-volumes--clone.adoc @@ -0,0 +1,89 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-volumes--clone.html' +summary: 'Clone an existing volume' +--- + += Clone an existing volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone`# + + + +Clones an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newVolumeName +|string +|True +a|New volume name + + +|parentSnapshot +|string +|False +a|Snapshot name to use for the clone + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "newVolumeName": "string", + "parentSnapshot": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-volumes--move.adoc b/cvo/post-gcp-ha-volumes--move.adoc new file mode 100644 index 00000000..a67bde1c --- /dev/null +++ b/cvo/post-gcp-ha-volumes--move.adoc @@ -0,0 +1,203 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-volumes--move.html' +summary: 'Move an existing volume' +--- + += Move an existing volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move`# + + + +Moves an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|targetAggregateName +|string +|True +a|Target aggregate name + + +|numOfDisksToAdd +|integer +|True +a|Target aggregate number of disks to add + + +|createTargetAggregate +|boolean +|True +a|Specifies if the aggregate is a new target aggregate + + +|newDiskTypeName +|string +|False +a|New disk type for the volume + + +|newCapacityTier +|string +|False +a|New capacity tier + + +|newTieringPolicy +|string +|False +a|New tiering policy + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-ha-volumes--snapshot.adoc b/cvo/post-gcp-ha-volumes--snapshot.adoc new file mode 100644 index 00000000..99c86e72 --- /dev/null +++ b/cvo/post-gcp-ha-volumes--snapshot.adoc @@ -0,0 +1,82 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-volumes--snapshot.html' +summary: 'Create a snapshot' +--- + += Create a snapshot + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Creates a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|string +|False +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-volumes-initiator.adoc b/cvo/post-gcp-ha-volumes-initiator.adoc new file mode 100644 index 00000000..a2a93923 --- /dev/null +++ b/cvo/post-gcp-ha-volumes-initiator.adoc @@ -0,0 +1,59 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-volumes-initiator.html' +summary: 'Add an iSCSI initiator' +--- + += Add an iSCSI initiator + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/volumes/initiator`# + + + +Adds an iSCSI initiator. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-volumes-quote.adoc b/cvo/post-gcp-ha-volumes-quote.adoc new file mode 100644 index 00000000..07ae17b7 --- /dev/null +++ b/cvo/post-gcp-ha-volumes-quote.adoc @@ -0,0 +1,285 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-volumes-quote.html' +summary: 'Retrieve quotes for a new volume' +--- + += Retrieve quotes for a new volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/volumes/quote`# + + + +Retrieves quotes for a new volume. Returns the resource quote required for the requested volume. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|True +a|Cloud Volumes ONTAP system ID + + +|svmName +|string +|True +a|SVM name + + +|aggregateName +|string +|False +a|Optionally choose in which aggregate to create the volume + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|enableThinProvisioning +|boolean +|True +a|Enable thin provisioning on the volume + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|verifyNameUniqueness +|boolean +|True +a|Verify volume name uniqueness within the SVM + + +|capacityTier +|string +|False +a|Capacity tier + + +|isReplicationFlow +|boolean +|True +a|Is replication flow + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|aggregateName +|string +|True +a|The aggregate on which the requested volume will be created + + +|newAggregate +|boolean +|True +a|Is it a newly created aggregate + + +|autoVsaCapacityManagement +|boolean +|True +a|Indicates if automatic Cloud Volumes ONTAP capacity management is enabled + + +|elasticVolumeQuoteResponse +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-ha-volumes.adoc b/cvo/post-gcp-ha-volumes.adoc new file mode 100644 index 00000000..652d91f6 --- /dev/null +++ b/cvo/post-gcp-ha-volumes.adoc @@ -0,0 +1,610 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-volumes.html' +summary: 'Create a new volume' +--- + += Create a new volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/volumes`# + + + +Creates a new volume. If the aggregateName and maxNumOfDisksApprovedToAdd properties are not populated, the response fails with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|createAggregateIfNotFound +|boolean +|query +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|True +a|Cloud Volumes ONTAP system ID + + +|svmName +|string +|True +a|SVM name + + +|aggregateName +|string +|True +a|Aggregate in which the volume will be created + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|True +a|Snapshot policy name + + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|iscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableThinProvisioning +|boolean +|True +a|Enable thin provisioning on the volume + + +|enableCompression +|boolean +|True +a|Enable compression on the volume + + +|enableDeduplication +|boolean +|True +a|Enable deduplication on the volume + + +|maxNumOfDisksApprovedToAdd +|integer +|True +a|Maximum number of disks approved to allocate + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|providerVolumeType +|string +|False +a|Provider volume type + + +|syncToS3 +|boolean +|True +a|Add a cloud sync relationship + + +|capacityTier +|string +|False +a|Capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|junctionPath +|string +|False +a|Junction path + + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|volumeTags +|array[link:#VolumeTags[VolumeTags]] +|True +a|Optionally, provide key-value pairs with which to tag the ONTAP volume using the App Template service. + + +|comment +|string +|False +a|Volume Comment + + +|flexGroupVolumeInfo +|link:#FlexGroupVolumeInfo[FlexGroupVolumeInfo] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +[#VolumeTags] +[.api-collapsible-fifth-title] +VolumeTags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|False +a| + +|tagValue +|string +|False +a| + +|=== + + +[#FlexGroupVolumeInfo] +[.api-collapsible-fifth-title] +FlexGroupVolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateList +|array[string] +|False +a|Names of aggregates for the FlexGroup volume + + +|numberOfConstituents +|integer +|False +a|Number of constituents for the FlexGroup volume + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-ha-working-environments-change-serial.adoc b/cvo/post-gcp-ha-working-environments-change-serial.adoc new file mode 100644 index 00000000..6b5fe0c6 --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-change-serial.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-change-serial.html' +summary: 'Update the serial number of a system' +--- + += Update the serial number of a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/change-serial`# + + + +Updates the serial number of a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodeOne +|string +|True +a| + +|nodeTwo +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nodeOne": "string", + "nodeTwo": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-working-environments-change-tier-level.adoc b/cvo/post-gcp-ha-working-environments-change-tier-level.adoc new file mode 100644 index 00000000..95d5d4b4 --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-change-tier-level.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-change-tier-level.html' +summary: 'Update the tier level' +--- + += Update the tier level + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/change-tier-level`# + + + +Updates the tier level. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|level +|string +|True +a|Update tier level + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "level": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-working-environments-cifs.adoc b/cvo/post-gcp-ha-working-environments-cifs.adoc new file mode 100644 index 00000000..b55f0e0d --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-cifs.adoc @@ -0,0 +1,121 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-cifs.html' +summary: 'Create a new CIFS configuration for a system' +--- + += Create a new CIFS configuration for a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/cifs`# + + + +Sets up a new CIFS configuration for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|False +a|DNS domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|activeDirectoryUsername +|string +|True +a|Active Directory username + + +|activeDirectoryPassword +|string +|True +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "activeDirectoryDomain": "string", + "activeDirectoryUsername": "string", + "activeDirectoryPassword": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-working-environments-delete-cifs.adoc b/cvo/post-gcp-ha-working-environments-delete-cifs.adoc new file mode 100644 index 00000000..458b1e8a --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-delete-cifs.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-delete-cifs.html' +summary: 'Delete the CIFS configuration for a system' +--- + += Delete the CIFS configuration for a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/delete-cifs`# + + + +Deletes the CIFS configuration of an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|activeDirectoryUsername +|string +|False +a|Active Directory username + + +|activeDirectoryPassword +|string +|False +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "activeDirectoryUsername": "string", + "activeDirectoryPassword": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-working-environments-enable-capacity-tiering.adoc b/cvo/post-gcp-ha-working-environments-enable-capacity-tiering.adoc new file mode 100644 index 00000000..e1641d0b --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-enable-capacity-tiering.adoc @@ -0,0 +1,81 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-enable-capacity-tiering.html' +summary: 'Enable capacity tiering' +--- + += Enable capacity tiering + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering`# + + + +Enables capacity tiering. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceProfileName +|string +|False +a| + +|gcpStorageAccountId +|string +|False +a| + +|storageAccountPrefix +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceProfileName": "string", + "gcpStorageAccountId": "string", + "storageAccountPrefix": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-working-environments-extra-capacity-licenses.adoc b/cvo/post-gcp-ha-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..a88c91ad --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-extra-capacity-licenses.html' +summary: 'Register an extra capacity license' +--- + += Register an extra capacity license + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Registers an extra capacity license. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licences +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licences": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-working-environments-extra-capacity-serials.adoc b/cvo/post-gcp-ha-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..6adbfb01 --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-extra-capacity-serials.html' +summary: 'Register extra capacity license serial numbers' +--- + += Register extra capacity license serial numbers + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Registers an extra capacity serial number. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-working-environments-ntp.adoc b/cvo/post-gcp-ha-working-environments-ntp.adoc new file mode 100644 index 00000000..23e1b0de --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-ntp.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-ntp.html' +summary: 'Set up an NTP server' +--- + += Set up an NTP server + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/ntp`# + + + +Sets up an NTP server. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ntpServer +|string +|True +a|NTPS server + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "ntpServer": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-working-environments-parse-license-file.adoc b/cvo/post-gcp-ha-working-environments-parse-license-file.adoc new file mode 100644 index 00000000..e1c4e9b4 --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-parse-license-file.adoc @@ -0,0 +1,232 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-parse-license-file.html' +summary: 'Parse an uploaded cloud license file' +--- + += Parse an uploaded cloud license file + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/parse-license-file`# + + + +Parses an uploaded cloud license file. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|license +|string +|True +a| + +|serialNumber +|string +|False +a| + +|contractEndDate +|link:#contractEndDate[contractEndDate] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "license": "string", + "serialNumber": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +[#contractEndDate] +[.api-collapsible-fifth-title] +contractEndDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-ha-working-environments-snapshot-policy.adoc b/cvo/post-gcp-ha-working-environments-snapshot-policy.adoc new file mode 100644 index 00000000..c614e969 --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-snapshot-policy.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-snapshot-policy.html' +summary: ' Create a snapshot policy' +--- + += Create a snapshot policy + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/snapshot-policy`# + + + +Creates a snapshot policy. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|schedules +|array[link:#SnapshotPolicyScheduleRequest[SnapshotPolicyScheduleRequest]] +|True +a|Snapshot policy schedules + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "schedules": [ + {} + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SnapshotPolicyScheduleRequest] +[.api-collapsible-fifth-title] +SnapshotPolicyScheduleRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scheduleType +|string +|True +a|Snapshot policy schedule type + + +|retention +|integer +|True +a|Snapshot policy retention + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-ha-working-environments-start.adoc b/cvo/post-gcp-ha-working-environments-start.adoc new file mode 100644 index 00000000..462b265e --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-start.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-start.html' +summary: 'Start a Cloud Volumes ONTAP instance' +--- + += Start a Cloud Volumes ONTAP instance + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/start`# + + + +Starts a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-working-environments-stop.adoc b/cvo/post-gcp-ha-working-environments-stop.adoc new file mode 100644 index 00000000..1095dba1 --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-stop.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-stop.html' +summary: 'Stop a specific Cloud Volumes ONTAP instance' +--- + += Stop a specific Cloud Volumes ONTAP instance + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/stop`# + + + +Stops a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|takeSnapshots +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-working-environments-support-registration.adoc b/cvo/post-gcp-ha-working-environments-support-registration.adoc new file mode 100644 index 00000000..fa7a95ac --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-support-registration.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-support-registration.html' +summary: 'Register a Cloud Volumes ONTAP system with NetApp' +--- + += Register a Cloud Volumes ONTAP system with NetApp + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/support-registration`# + + + +Registers a Cloud Volumes ONTAP system with NetApp. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|nssAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|licenseStartDate +|link:#licenseStartDate[licenseStartDate] +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "nssAccountId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#licenseStartDate] +[.api-collapsible-fifth-title] +licenseStartDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-ha-working-environments-svm.adoc b/cvo/post-gcp-ha-working-environments-svm.adoc new file mode 100644 index 00000000..fd300687 --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-svm.adoc @@ -0,0 +1,187 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-svm.html' +summary: 'Create a new SVM' +--- + += Create a new SVM + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/svm`# + + + +Creates a new SVM. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|svmName +|string +|False +a| + +|svmPassword +|link:#VsaSvmPassword[VsaSvmPassword] +|False +a| + +|mgmtLif +|boolean +|True +a|Create a management LIF for the SVM + + +|rootVolumeAggregate +|string +|False +a|Aggregate name for the SVM root volume + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VsaSvmPassword] +[.api-collapsible-fifth-title] +VsaSvmPassword + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-ha-working-environments-sync-subscription.adoc b/cvo/post-gcp-ha-working-environments-sync-subscription.adoc new file mode 100644 index 00000000..f021d2ff --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-sync-subscription.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-sync-subscription.html' +summary: 'Trigger subscription synchronization' +--- + += Trigger subscription synchronization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/sync-subscription`# + + + +Manually triggers subscription synchronization for all Cloud Volumes ONTAP systems. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-working-environments-update-image.adoc b/cvo/post-gcp-ha-working-environments-update-image.adoc new file mode 100644 index 00000000..c576b857 --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-update-image.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-update-image.html' +summary: 'Perform a complete image update' +--- + += Perform a complete image update + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/update-image`# + + + +Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|updateType +|string +|True +a|System update type. System updates can be performed by providing either an external URL that ONTAP will use to download the image file or a name of an image provided by the NetApp Console. + + +|updateParameter +|string +|True +a|Parameter specific to the specified update type. External file URL or the NetApp Console provided image name. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "updateType": "string", + "updateParameter": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-working-environments-upload-license-file.adoc b/cvo/post-gcp-ha-working-environments-upload-license-file.adoc new file mode 100644 index 00000000..c9d64464 --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-upload-license-file.adoc @@ -0,0 +1,197 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-upload-license-file.html' +summary: 'Upload a cloud license file' +--- + += Upload a cloud license file + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/upload-license-file`# + + + +Uploads a cloud license file on the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-ha-working-environments-upload-licenses.adoc b/cvo/post-gcp-ha-working-environments-upload-licenses.adoc new file mode 100644 index 00000000..6728038d --- /dev/null +++ b/cvo/post-gcp-ha-working-environments-upload-licenses.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments-upload-licenses.html' +summary: 'Upload cloud license file content' +--- + += Upload cloud license file content + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/upload-licenses`# + + + +Uploads the content of a cloud license file on the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenseOne +|string +|True +a| + +|licenseTwo +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licenseOne": "string", + "licenseTwo": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-ha-working-environments.adoc b/cvo/post-gcp-ha-working-environments.adoc new file mode 100644 index 00000000..2ccdc056 --- /dev/null +++ b/cvo/post-gcp-ha-working-environments.adoc @@ -0,0 +1,3778 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-ha-working-environments.html' +summary: 'Create a new Cloud Volumes ONTAP Google Cloud HA system' +--- + += Create a new Cloud Volumes ONTAP Google Cloud HA system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/ha/working-environments`# + + + +Creates a new Cloud Volumes ONTAP Google Cloud HA system. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|svmPassword +|string +|False +a| + +|username +|link:#AdminUsername[AdminUsername] +|False +a| + +|vpcId +|string +|True +a| + +|volume +|link:#VsaVolumeOnNewVsaCreateRequest[VsaVolumeOnNewVsaCreateRequest] +|False +a| + +|region +|string +|False +a| + +|tenantId +|string +|False +a| + +|subnetPath +|string +|False +a|Subnet path for a single node cluster + + +|subnetId +|string +|True +a|Subnet ID for a single node cluster + + +|firewallRule +|string +|False +a|Firewall name for a single node cluster + + +|firewallTagNameRule +|string +|False +a|Firewall tag name for a single node cluster + + +|firewallIpRanges +|link:#firewallIpRanges[firewallIpRanges] +|False +a|Firewall IP ranges + + +|dataEncryptionType +|string +|True +a|Type of encryption to use for this system + + +|securityGroupId +|string +|False +a| + +|vsaMetadata +|link:#VsaMetadataRequest[VsaMetadataRequest] +|True +a| + +|cifsConfigurationRequest +|link:#CIFSConfigurationRequest[CIFSConfigurationRequest] +|False +a| + +|serialNumber +|string +|False +a|Serial number for BYOL + + +|gcpVolumeSize +|link:#Capacity[Capacity] +|True +a| + +|gcpVolumeType +|string +|True +a|Google Cloud volume type + + +|gcpLabels +|array[link:#GcpLabel[GcpLabel]] +|True +a|Optionally, provide up to four key-value pairs with which to tag all Google Cloud entities created by the NetApp Console. + + +|workerPool +|string +|False +a|The worker pool URI. Required for private mode Google Cloud deployments with Cloud Volumes ONTAP. + + +|writingSpeedState +|string +|False +a|Writing speed state + + +|failedToCreateWorkingEnvironmentId +|string +|False +a|Public ID of the failed-to-create system + + +|capacityTier +|string +|False +a|Capacity tier + + +|packageName +|string +|False +a|Pre-configured package name + + +|svmName +|string +|False +a|SVM name + + +|wormRequest +|link:#WormRequest[WormRequest] +|False +a| + +|nssAccount +|string +|False +a|NetApp Support Service (NSS) account + + +|gcpStorageAccount +|string +|False +a|Google Cloud storage account + + +|gcpServiceAccount +|string +|False +a|Google Cloud service account + + +|tierLevel +|string +|False +a|Google Cloud available storage classes + + +|saasSubscriptionId +|string +|False +a|SaaS subscription ID + + +|cloudProviderAccount +|string +|False +a| + +|project +|string +|False +a|Google Cloud optional project + + +|enableCompliance +|boolean +|True +a|Enable compliance + + +|gcpEncryptionParameters +|link:#GcpEncryption[GcpEncryption] +|False +a| + +|providedImage +|string +|False +a|Provided external Cloud Volumes ONTAP image + + +|providedMediatorImage +|string +|False +a|Provided external mediator image + + +|enableMonitoring +|boolean +|True +a|Enable monitoring + + +|enableServices +|array[string] +|False +a|Enable services + + +|backupVolumesToCbs +|boolean +|False +a|Automatically back up all volumes to the cloud + + +|haParams +|link:#GcpHaParameters[GcpHaParameters] +|False +a| + +|gcpPerformance +|link:#GcpPerformance[GcpPerformance] +|False +a| + +|skipSvmManagementLif +|boolean +|True +a|SVM management LIF flag. Beginning with ONTAP 9.11.1, the flag is always set to true. + + +|flashCache +|boolean +|True +a|Enable Flash Cache + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#GcpProperties[GcpProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|True +a| + +|haProperties +|link:#GcpHaProperties[GcpHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#AdminUsername] +[.api-collapsible-fifth-title] +AdminUsername + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#VsaVolumeOnNewVsaCreateRequest] +[.api-collapsible-fifth-title] +VsaVolumeOnNewVsaCreateRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|False +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|False +a| + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|iscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableThinProvisioning +|boolean +|False +a|Enable thin provisioning on the volume + + +|enableCompression +|boolean +|False +a|Enable compression on the volume + + +|enableDeduplication +|boolean +|False +a|Enable deduplication on the volume + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|junctionPath +|string +|False +a|Junction path + + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|=== + + +[#firewallIpRanges] +[.api-collapsible-fifth-title] +firewallIpRanges + +Firewall IP ranges + + + +[#VsaMetadataRequest] +[.api-collapsible-fifth-title] +VsaMetadataRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a|ONTAP version + + +|licenseType +|string +|True +a|License type + + +|instanceType +|string +|True +a|Instance type + + +|platformSerialNumber +|string +|False +a|Optional platform serial number + + +|providedLicense +|string +|False +a|Optional provided license + + +|capacityPackageName +|string +|False +a|Optional capacity-based package + + +|keyStoneSubscription +|string +|False +a|Keystone subscription ID + + +|useLatestVersion +|boolean +|False +a|Use the latest version + + +|=== + + +[#CIFSConfigurationRequest] +[.api-collapsible-fifth-title] +CIFSConfigurationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|False +a|DNS domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|activeDirectoryUsername +|string +|True +a|Active Directory username + + +|activeDirectoryPassword +|string +|True +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +[#GcpLabel] +[.api-collapsible-fifth-title] +GcpLabel + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|labelKey +|string +|False +a| + +|labelValue +|string +|False +a| + +|=== + + +[#WormRetentionPeriod] +[.api-collapsible-fifth-title] +WormRetentionPeriod + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|True +a|Length + + +|unit +|string +|True +a|Unit + + +|=== + + +[#WormRequest] +[.api-collapsible-fifth-title] +WormRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|retentionPeriod +|link:#WormRetentionPeriod[WormRetentionPeriod] +|True +a| + +|=== + + +[#GcpEncryption] +[.api-collapsible-fifth-title] +GcpEncryption + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|False +a| + +|=== + + +[#GcpHaParameters] +[.api-collapsible-fifth-title] +GcpHaParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|platformSerialNumberNode1 +|string +|False +a|Platform serial number for node 1 + + +|platformSerialNumberNode2 +|string +|False +a|Platform serial number for node 2 + + +|node1Zone +|string +|False +a|Zone for node 1 + + +|node2Zone +|string +|False +a|Zone for node 2 + + +|mediatorZone +|string +|False +a|Zone for mediator + + +|vpc0NodeAndDataConnectivity +|string +|False +a|VPC path for nic1, required for node and data connectivity + + +|vpc1ClusterConnectivity +|string +|False +a|VPC path for nic2, required for cluster connectivity + + +|vpc2HAConnectivity +|string +|False +a|VPC path for nic3, required for HA connectivity + + +|vpc3DataReplication +|string +|False +a|VPC path for nic4, required for data replication + + +|subnet0NodeAndDataConnectivity +|string +|False +a|Subnet path for nic1, required for node and data connectivity + + +|subnet1ClusterConnectivity +|string +|False +a|Subnet path for nic2, required for cluster connectivity + + +|subnet2HAConnectivity +|string +|False +a|Subnet path for nic3, required for HA connectivity + + +|subnet3DataReplication +|string +|False +a|Subnet path for nic4, required for data replication + + +|vpc0FirewallRuleName +|string +|False +a|Optional firewall rule name for vpc1 + + +|vpc1FirewallRuleName +|string +|False +a|Optional firewall rule name for vpc2 + + +|vpc2FirewallRuleName +|string +|False +a|Optional firewall rule name for vpc3 + + +|vpc3FirewallRuleName +|string +|False +a|Optional firewall rule name for vpc4 + + +|vpc0FirewallRuleTagName +|string +|False +a|Optional firewall tag name for vpc1 + + +|vpc1FirewallRuleTagName +|string +|False +a|Optional firewall tag name for vpc2 + + +|vpc2FirewallRuleTagName +|string +|False +a|Optional firewall tag name for vpc3 + + +|vpc3FirewallRuleTagName +|string +|False +a|Optional firewall tag name for vpc4 + + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + +Optional IOPS for the aggregate + + + +[#throughput] +[.api-collapsible-fifth-title] +throughput + +Optional throughput for the aggregate + + + +[#GcpPerformance] +[.api-collapsible-fifth-title] +GcpPerformance + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|iops +|link:#iops[iops] +|False +a|Optional IOPS for the aggregate + + +|throughput +|link:#throughput[throughput] +|False +a|Optional throughput for the aggregate + + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#labels] +[.api-collapsible-fifth-title] +labels +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#GcpProperties] +[.api-collapsible-fifth-title] +GcpProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|regionName +|string +|False +a| + +|zoneName +|array[string] +|False +a| + +|instanceType +|string +|False +a| + +|subnetCidr +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|projectName +|string +|False +a| + +|deploymentName +|string +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#GcpHaMediatorInfo] +[.api-collapsible-fifth-title] +GcpHaMediatorInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInstanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|version +|string +|False +a| + +|=== + + +[#GcpHaNodeInfo] +[.api-collapsible-fifth-title] +GcpHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|=== + + +[#GcpHaProperties] +[.api-collapsible-fifth-title] +GcpHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInfo +|link:#GcpHaMediatorInfo[GcpHaMediatorInfo] +|False +a| + +|node1Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|node2Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|projectName +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-vsa-aggregates--disks.adoc b/cvo/post-gcp-vsa-aggregates--disks.adoc new file mode 100644 index 00000000..3a06392f --- /dev/null +++ b/cvo/post-gcp-vsa-aggregates--disks.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-aggregates--disks.html' +summary: 'Add disks to an aggregate' +--- + += Add disks to an aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks`# + + + +Adds disks to an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|True +a|Number of disks + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-aggregates.adoc b/cvo/post-gcp-vsa-aggregates.adoc new file mode 100644 index 00000000..c1b36ed3 --- /dev/null +++ b/cvo/post-gcp-vsa-aggregates.adoc @@ -0,0 +1,137 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-aggregates.html' +summary: 'Create a new aggregate' +--- + += Create a new aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/aggregates`# + + + +Creates a new aggregate. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|workingEnvironmentId +|string +|True +a| + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|initialEvAggregateSize +|link:#Capacity[Capacity] +|False +a| + +|homeNode +|string +|False +a| + +|providerVolumeType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "workingEnvironmentId": "string", + "homeNode": "string", + "providerVolumeType": "string", + "capacityTier": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-vsa-metadata-create-bucket.adoc b/cvo/post-gcp-vsa-metadata-create-bucket.adoc new file mode 100644 index 00000000..77778fa1 --- /dev/null +++ b/cvo/post-gcp-vsa-metadata-create-bucket.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-metadata-create-bucket.html' +summary: 'Create a new bucket' +--- + += Create a new bucket + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/metadata/create-bucket`# + + + +Creates a new bucket. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|projectId +|string +|False +a| + +|bucketName +|string +|True +a| + +|location +|string +|False +a| + +|storageClass +|string +|False +a| + +|kmsKeyName +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "projectId": "string", + "bucketName": "string", + "location": "string", + "storageClass": "string", + "kmsKeyName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-recover.adoc b/cvo/post-gcp-vsa-recover.adoc new file mode 100644 index 00000000..de523e2c --- /dev/null +++ b/cvo/post-gcp-vsa-recover.adoc @@ -0,0 +1,2760 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-recover.html' +summary: 'Save a system to the NetApp Console database' +--- + += Save a system to the NetApp Console database + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/recover`# + + + +Saves a previously discovered Cloud Volumes ONTAP system to the NetApp Console database. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|zone +|string +|True +a| + +|instanceName +|string +|False +a| + +|clusterCredentials +|link:#ClusterCredentialsRequest[ClusterCredentialsRequest] +|True +a| + +|tenantId +|string +|False +a| + +|projectId +|string +|False +a| + +|nssAccountId +|string +|False +a|NetApp Support Site (NSS) account + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "zone": "string", + "instanceName": "string", + "clusterCredentials": { + "userName": "string", + "password": "string" + }, + "tenantId": "string", + "projectId": "string", + "nssAccountId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#GcpProperties[GcpProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|True +a| + +|haProperties +|link:#GcpHaProperties[GcpHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ClusterCredentialsRequest] +[.api-collapsible-fifth-title] +ClusterCredentialsRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|userName +|string +|True +a| + +|password +|string +|False +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#labels] +[.api-collapsible-fifth-title] +labels +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#GcpProperties] +[.api-collapsible-fifth-title] +GcpProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|regionName +|string +|False +a| + +|zoneName +|array[string] +|False +a| + +|instanceType +|string +|False +a| + +|subnetCidr +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|projectName +|string +|False +a| + +|deploymentName +|string +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#GcpHaMediatorInfo] +[.api-collapsible-fifth-title] +GcpHaMediatorInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInstanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|version +|string +|False +a| + +|=== + + +[#GcpHaNodeInfo] +[.api-collapsible-fifth-title] +GcpHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|=== + + +[#GcpHaProperties] +[.api-collapsible-fifth-title] +GcpHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInfo +|link:#GcpHaMediatorInfo[GcpHaMediatorInfo] +|False +a| + +|node1Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|node2Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|projectName +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-vsa-volumes--change-tier.adoc b/cvo/post-gcp-vsa-volumes--change-tier.adoc new file mode 100644 index 00000000..3a928298 --- /dev/null +++ b/cvo/post-gcp-vsa-volumes--change-tier.adoc @@ -0,0 +1,229 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-volumes--change-tier.html' +summary: 'Update the underlying volume tier' +--- + += Update the underlying volume tier + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier`# + + + +Updates the underlying volume tier. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Target aggregate name + + +|numOfDisks +|integer +|True +a|Number of new disks needed + + +|newAggregate +|boolean +|True +a|Indicates if it is a newly created aggregate + + +|newDiskTypeName +|string +|True +a|New disk type name + + +|newCapacityTier +|string +|False +a|New capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|newTieringPolicy +|string +|False +a|New tiering policy + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-vsa-volumes--clone.adoc b/cvo/post-gcp-vsa-volumes--clone.adoc new file mode 100644 index 00000000..4f5512ea --- /dev/null +++ b/cvo/post-gcp-vsa-volumes--clone.adoc @@ -0,0 +1,89 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-volumes--clone.html' +summary: 'Clone a volume' +--- + += Clone a volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone`# + + + +Clones an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newVolumeName +|string +|True +a|New volume name + + +|parentSnapshot +|string +|False +a|Snapshot name to use for the clone + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "newVolumeName": "string", + "parentSnapshot": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-volumes--move.adoc b/cvo/post-gcp-vsa-volumes--move.adoc new file mode 100644 index 00000000..9632b700 --- /dev/null +++ b/cvo/post-gcp-vsa-volumes--move.adoc @@ -0,0 +1,203 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-volumes--move.html' +summary: 'Move a volume' +--- + += Move a volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move`# + + + +Moves an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|targetAggregateName +|string +|True +a|Target aggregate name + + +|numOfDisksToAdd +|integer +|True +a|Target aggregate number of disks to add + + +|createTargetAggregate +|boolean +|True +a|Specifies if the aggregate is a new target aggregate + + +|newDiskTypeName +|string +|False +a|New disk type for the volume + + +|newCapacityTier +|string +|False +a|New capacity tier + + +|newTieringPolicy +|string +|False +a|New tiering policy + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-vsa-volumes--snapshot.adoc b/cvo/post-gcp-vsa-volumes--snapshot.adoc new file mode 100644 index 00000000..d398680f --- /dev/null +++ b/cvo/post-gcp-vsa-volumes--snapshot.adoc @@ -0,0 +1,82 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-volumes--snapshot.html' +summary: 'Create a snapshot' +--- + += Create a snapshot + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Creates a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|string +|False +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-volumes-initiator.adoc b/cvo/post-gcp-vsa-volumes-initiator.adoc new file mode 100644 index 00000000..acb2605e --- /dev/null +++ b/cvo/post-gcp-vsa-volumes-initiator.adoc @@ -0,0 +1,59 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-volumes-initiator.html' +summary: 'Add an iSCSI initiator' +--- + += Add an iSCSI initiator + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/volumes/initiator`# + + + +Adds an iSCSI initiator. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-volumes-quote.adoc b/cvo/post-gcp-vsa-volumes-quote.adoc new file mode 100644 index 00000000..59ed89ac --- /dev/null +++ b/cvo/post-gcp-vsa-volumes-quote.adoc @@ -0,0 +1,285 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-volumes-quote.html' +summary: 'Retrieve quotes for a new volume' +--- + += Retrieve quotes for a new volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/volumes/quote`# + + + +Retrieves quotes for a new volume. Returns the resource quote required for the requested volume. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|True +a|Cloud Volumes ONTAP system ID + + +|svmName +|string +|True +a|SVM name + + +|aggregateName +|string +|False +a|Optionally choose in which aggregate to create the volume + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|enableThinProvisioning +|boolean +|True +a|Enable thin provisioning on the volume + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|verifyNameUniqueness +|boolean +|True +a|Verify volume name uniqueness within the SVM + + +|capacityTier +|string +|False +a|Capacity tier + + +|isReplicationFlow +|boolean +|True +a|Is replication flow + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|aggregateName +|string +|True +a|The aggregate on which the requested volume will be created + + +|newAggregate +|boolean +|True +a|Is it a newly created aggregate + + +|autoVsaCapacityManagement +|boolean +|True +a|Indicates if automatic Cloud Volumes ONTAP capacity management is enabled + + +|elasticVolumeQuoteResponse +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-vsa-volumes.adoc b/cvo/post-gcp-vsa-volumes.adoc new file mode 100644 index 00000000..4b3aeb81 --- /dev/null +++ b/cvo/post-gcp-vsa-volumes.adoc @@ -0,0 +1,610 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-volumes.html' +summary: 'Create a new volume' +--- + += Create a new volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/volumes`# + + + +Creates a new volume. If the aggregateName and maxNumOfDisksApprovedToAdd properties are not populated, the response fails with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|createAggregateIfNotFound +|boolean +|query +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|True +a|Cloud Volumes ONTAP system ID + + +|svmName +|string +|True +a|SVM name + + +|aggregateName +|string +|True +a|Aggregate in which the volume will be created + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|True +a|Snapshot policy name + + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|iscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableThinProvisioning +|boolean +|True +a|Enable thin provisioning on the volume + + +|enableCompression +|boolean +|True +a|Enable compression on the volume + + +|enableDeduplication +|boolean +|True +a|Enable deduplication on the volume + + +|maxNumOfDisksApprovedToAdd +|integer +|True +a|Maximum number of disks approved to allocate + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|providerVolumeType +|string +|False +a|Provider volume type + + +|syncToS3 +|boolean +|True +a|Add a cloud sync relationship + + +|capacityTier +|string +|False +a|Capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|junctionPath +|string +|False +a|Junction path + + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|volumeTags +|array[link:#VolumeTags[VolumeTags]] +|True +a|Optionally, provide key-value pairs with which to tag the ONTAP volume using the App Template service. + + +|comment +|string +|False +a|Volume Comment + + +|flexGroupVolumeInfo +|link:#FlexGroupVolumeInfo[FlexGroupVolumeInfo] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +[#VolumeTags] +[.api-collapsible-fifth-title] +VolumeTags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|False +a| + +|tagValue +|string +|False +a| + +|=== + + +[#FlexGroupVolumeInfo] +[.api-collapsible-fifth-title] +FlexGroupVolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateList +|array[string] +|False +a|Names of aggregates for the FlexGroup volume + + +|numberOfConstituents +|integer +|False +a|Number of constituents for the FlexGroup volume + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-vsa-working-environments-change-serial.adoc b/cvo/post-gcp-vsa-working-environments-change-serial.adoc new file mode 100644 index 00000000..15e39adc --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-change-serial.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-change-serial.html' +summary: 'Update the serial number of Cloud Volumes ONTAP' +--- + += Update the serial number of Cloud Volumes ONTAP + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/change-serial`# + + + +Updates the serial number of a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodeOne +|string +|True +a| + +|nodeTwo +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nodeOne": "string", + "nodeTwo": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-working-environments-change-tier-level.adoc b/cvo/post-gcp-vsa-working-environments-change-tier-level.adoc new file mode 100644 index 00000000..aaab0bb6 --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-change-tier-level.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-change-tier-level.html' +summary: 'Update the tier level' +--- + += Update the tier level + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/change-tier-level`# + + + +Updates the tier level. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|level +|string +|True +a|Update tier level + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "level": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-working-environments-cifs.adoc b/cvo/post-gcp-vsa-working-environments-cifs.adoc new file mode 100644 index 00000000..b3ef353f --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-cifs.adoc @@ -0,0 +1,121 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-cifs.html' +summary: 'Set up a new CIFS configuration' +--- + += Set up a new CIFS configuration + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/cifs`# + + + +Sets up a new CIFS configuration for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|False +a|DNS domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|activeDirectoryUsername +|string +|True +a|Active Directory username + + +|activeDirectoryPassword +|string +|True +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "activeDirectoryDomain": "string", + "activeDirectoryUsername": "string", + "activeDirectoryPassword": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-working-environments-delete-cifs.adoc b/cvo/post-gcp-vsa-working-environments-delete-cifs.adoc new file mode 100644 index 00000000..9f0030d7 --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-delete-cifs.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-delete-cifs.html' +summary: 'Delete a CIFS configuration' +--- + += Delete a CIFS configuration + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/delete-cifs`# + + + +Deletes the CIFS configuration of an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|activeDirectoryUsername +|string +|False +a|Active Directory username + + +|activeDirectoryPassword +|string +|False +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "activeDirectoryUsername": "string", + "activeDirectoryPassword": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-working-environments-enable-capacity-tiering.adoc b/cvo/post-gcp-vsa-working-environments-enable-capacity-tiering.adoc new file mode 100644 index 00000000..6b197176 --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-enable-capacity-tiering.adoc @@ -0,0 +1,81 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-enable-capacity-tiering.html' +summary: 'Enable capacity tiering' +--- + += Enable capacity tiering + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering`# + + + +Enables capacity tiering. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceProfileName +|string +|False +a| + +|gcpStorageAccountId +|string +|False +a| + +|storageAccountPrefix +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceProfileName": "string", + "gcpStorageAccountId": "string", + "storageAccountPrefix": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-working-environments-extra-capacity-licenses.adoc b/cvo/post-gcp-vsa-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..c9cac0d2 --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-extra-capacity-licenses.html' +summary: 'Register extra capacity licenses' +--- + += Register extra capacity licenses + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Registers an extra capacity license. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licences +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licences": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-working-environments-extra-capacity-serials.adoc b/cvo/post-gcp-vsa-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..916b656b --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-extra-capacity-serials.html' +summary: 'Register extra capacity serial numbers' +--- + += Register extra capacity serial numbers + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Registers an extra capacity serial number. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-working-environments-ntp.adoc b/cvo/post-gcp-vsa-working-environments-ntp.adoc new file mode 100644 index 00000000..d076a9ec --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-ntp.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-ntp.html' +summary: 'Set up an NTP server' +--- + += Set up an NTP server + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/ntp`# + + + +Sets up an NTP server. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ntpServer +|string +|True +a|NTPS server + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "ntpServer": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-working-environments-parse-license-file.adoc b/cvo/post-gcp-vsa-working-environments-parse-license-file.adoc new file mode 100644 index 00000000..646cece9 --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-parse-license-file.adoc @@ -0,0 +1,232 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-parse-license-file.html' +summary: 'Parse an uploaded cloud license file' +--- + += Parse an uploaded cloud license file + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/parse-license-file`# + + + +Parses an uploaded cloud license file. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|license +|string +|True +a| + +|serialNumber +|string +|False +a| + +|contractEndDate +|link:#contractEndDate[contractEndDate] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "license": "string", + "serialNumber": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +[#contractEndDate] +[.api-collapsible-fifth-title] +contractEndDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-vsa-working-environments-snapshot-policy.adoc b/cvo/post-gcp-vsa-working-environments-snapshot-policy.adoc new file mode 100644 index 00000000..752acb26 --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-snapshot-policy.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-snapshot-policy.html' +summary: 'Create a snapshot policy' +--- + += Create a snapshot policy + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/snapshot-policy`# + + + +Creates a snapshot policy. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|schedules +|array[link:#SnapshotPolicyScheduleRequest[SnapshotPolicyScheduleRequest]] +|True +a|Snapshot policy schedules + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "schedules": [ + {} + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SnapshotPolicyScheduleRequest] +[.api-collapsible-fifth-title] +SnapshotPolicyScheduleRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scheduleType +|string +|True +a|Snapshot policy schedule type + + +|retention +|integer +|True +a|Snapshot policy retention + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-vsa-working-environments-start.adoc b/cvo/post-gcp-vsa-working-environments-start.adoc new file mode 100644 index 00000000..91dc8912 --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-start.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-start.html' +summary: 'Start a Cloud Volumes ONTAP instance' +--- + += Start a Cloud Volumes ONTAP instance + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/start`# + + + +Starts a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-working-environments-stop.adoc b/cvo/post-gcp-vsa-working-environments-stop.adoc new file mode 100644 index 00000000..cdd6e1a0 --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-stop.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-stop.html' +summary: 'Stop a Cloud Volumes ONTAP instance' +--- + += Stop a Cloud Volumes ONTAP instance + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/stop`# + + + +Stops a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|takeSnapshots +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-working-environments-support-registration.adoc b/cvo/post-gcp-vsa-working-environments-support-registration.adoc new file mode 100644 index 00000000..c8008c91 --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-support-registration.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-support-registration.html' +summary: 'Register a Cloud Volumes ONTAP system' +--- + += Register a Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/support-registration`# + + + +Registers a Cloud Volumes ONTAP system with NetApp. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|nssAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|licenseStartDate +|link:#licenseStartDate[licenseStartDate] +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "nssAccountId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#licenseStartDate] +[.api-collapsible-fifth-title] +licenseStartDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-vsa-working-environments-svm.adoc b/cvo/post-gcp-vsa-working-environments-svm.adoc new file mode 100644 index 00000000..f351b59c --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-svm.adoc @@ -0,0 +1,187 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-svm.html' +summary: 'Create a new SVM' +--- + += Create a new SVM + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/svm`# + + + +Creates a new SVM. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|svmName +|string +|False +a| + +|svmPassword +|link:#VsaSvmPassword[VsaSvmPassword] +|False +a| + +|mgmtLif +|boolean +|True +a|Create a management LIF for the SVM + + +|rootVolumeAggregate +|string +|False +a|Aggregate name for the SVM root volume + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VsaSvmPassword] +[.api-collapsible-fifth-title] +VsaSvmPassword + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-vsa-working-environments-sync-subscription.adoc b/cvo/post-gcp-vsa-working-environments-sync-subscription.adoc new file mode 100644 index 00000000..715cf10c --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-sync-subscription.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-sync-subscription.html' +summary: 'Trigger subscription synchronization' +--- + += Trigger subscription synchronization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/sync-subscription`# + + + +Manually triggers subscription synchronization for all Cloud Volumes ONTAP systems. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-working-environments-update-image.adoc b/cvo/post-gcp-vsa-working-environments-update-image.adoc new file mode 100644 index 00000000..59591229 --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-update-image.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-update-image.html' +summary: 'Perform a complete image update operation' +--- + += Perform a complete image update operation + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/update-image`# + + + +Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|updateType +|string +|True +a|System update type. System updates can be performed by providing either an external URL that ONTAP will use to download the image file or a name of an image provided by the NetApp Console. + + +|updateParameter +|string +|True +a|Parameter specific to the specified update type. External file URL or the NetApp Console provided image name. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "updateType": "string", + "updateParameter": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-working-environments-upload-license-file.adoc b/cvo/post-gcp-vsa-working-environments-upload-license-file.adoc new file mode 100644 index 00000000..c7d5305c --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-upload-license-file.adoc @@ -0,0 +1,197 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-upload-license-file.html' +summary: 'Upload a cloud license file' +--- + += Upload a cloud license file + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/upload-license-file`# + + + +Uploads a cloud license file on the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +//end collapsible .Definitions block +==== diff --git a/cvo/post-gcp-vsa-working-environments-upload-licenses.adoc b/cvo/post-gcp-vsa-working-environments-upload-licenses.adoc new file mode 100644 index 00000000..04a60f85 --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments-upload-licenses.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments-upload-licenses.html' +summary: 'Upload cloud license file content' +--- + += Upload cloud license file content + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/upload-licenses`# + + + +Uploads the content of a cloud license file on the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenseOne +|string +|True +a| + +|licenseTwo +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licenseOne": "string", + "licenseTwo": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-gcp-vsa-working-environments.adoc b/cvo/post-gcp-vsa-working-environments.adoc new file mode 100644 index 00000000..76976997 --- /dev/null +++ b/cvo/post-gcp-vsa-working-environments.adoc @@ -0,0 +1,3778 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-gcp-vsa-working-environments.html' +summary: 'Create a new Cloud Volumes ONTAP system' +--- + += Create a new Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/gcp/vsa/working-environments`# + + + +Creates a new Cloud Volumes ONTAP system. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|svmPassword +|string +|False +a| + +|username +|link:#AdminUsername[AdminUsername] +|False +a| + +|vpcId +|string +|True +a| + +|volume +|link:#VsaVolumeOnNewVsaCreateRequest[VsaVolumeOnNewVsaCreateRequest] +|False +a| + +|region +|string +|False +a| + +|tenantId +|string +|False +a| + +|subnetPath +|string +|False +a|Subnet path for a single node cluster + + +|subnetId +|string +|True +a|Subnet ID for a single node cluster + + +|firewallRule +|string +|False +a|Firewall name for a single node cluster + + +|firewallTagNameRule +|string +|False +a|Firewall tag name for a single node cluster + + +|firewallIpRanges +|link:#firewallIpRanges[firewallIpRanges] +|False +a|Firewall IP ranges + + +|dataEncryptionType +|string +|True +a|Type of encryption to use for this system + + +|securityGroupId +|string +|False +a| + +|vsaMetadata +|link:#VsaMetadataRequest[VsaMetadataRequest] +|True +a| + +|cifsConfigurationRequest +|link:#CIFSConfigurationRequest[CIFSConfigurationRequest] +|False +a| + +|serialNumber +|string +|False +a|Serial number for BYOL + + +|gcpVolumeSize +|link:#Capacity[Capacity] +|True +a| + +|gcpVolumeType +|string +|True +a|Google Cloud volume type + + +|gcpLabels +|array[link:#GcpLabel[GcpLabel]] +|True +a|Optionally, provide up to four key-value pairs with which to tag all Google Cloud entities created by the NetApp Console. + + +|workerPool +|string +|False +a|The worker pool URI. Required for private mode Google Cloud deployments with Cloud Volumes ONTAP. + + +|writingSpeedState +|string +|False +a|Writing speed state + + +|failedToCreateWorkingEnvironmentId +|string +|False +a|Public ID of the failed-to-create system + + +|capacityTier +|string +|False +a|Capacity tier + + +|packageName +|string +|False +a|Pre-configured package name + + +|svmName +|string +|False +a|SVM name + + +|wormRequest +|link:#WormRequest[WormRequest] +|False +a| + +|nssAccount +|string +|False +a|NetApp Support Service (NSS) account + + +|gcpStorageAccount +|string +|False +a|Google Cloud storage account + + +|gcpServiceAccount +|string +|False +a|Google Cloud service account + + +|tierLevel +|string +|False +a|Google Cloud available storage classes + + +|saasSubscriptionId +|string +|False +a|SaaS subscription ID + + +|cloudProviderAccount +|string +|False +a| + +|project +|string +|False +a|Google Cloud optional project + + +|enableCompliance +|boolean +|True +a|Enable compliance + + +|gcpEncryptionParameters +|link:#GcpEncryption[GcpEncryption] +|False +a| + +|providedImage +|string +|False +a|Provided external Cloud Volumes ONTAP image + + +|providedMediatorImage +|string +|False +a|Provided external mediator image + + +|enableMonitoring +|boolean +|True +a|Enable monitoring + + +|enableServices +|array[string] +|False +a|Enable services + + +|backupVolumesToCbs +|boolean +|False +a|Automatically back up all volumes to the cloud + + +|haParams +|link:#GcpHaParameters[GcpHaParameters] +|False +a| + +|gcpPerformance +|link:#GcpPerformance[GcpPerformance] +|False +a| + +|skipSvmManagementLif +|boolean +|True +a|SVM management LIF flag. Beginning with ONTAP 9.11.1, the flag is always set to true. + + +|flashCache +|boolean +|True +a|Enable Flash Cache + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|providerProperties +|link:#GcpProperties[GcpProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|cloudProviderName +|string +|False +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|isHA +|boolean +|True +a| + +|haProperties +|link:#GcpHaProperties[GcpHaProperties] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#AdminUsername] +[.api-collapsible-fifth-title] +AdminUsername + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#VsaVolumeOnNewVsaCreateRequest] +[.api-collapsible-fifth-title] +VsaVolumeOnNewVsaCreateRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|False +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|False +a| + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|iscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableThinProvisioning +|boolean +|False +a|Enable thin provisioning on the volume + + +|enableCompression +|boolean +|False +a|Enable compression on the volume + + +|enableDeduplication +|boolean +|False +a|Enable deduplication on the volume + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|junctionPath +|string +|False +a|Junction path + + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|=== + + +[#firewallIpRanges] +[.api-collapsible-fifth-title] +firewallIpRanges + +Firewall IP ranges + + + +[#VsaMetadataRequest] +[.api-collapsible-fifth-title] +VsaMetadataRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a|ONTAP version + + +|licenseType +|string +|True +a|License type + + +|instanceType +|string +|True +a|Instance type + + +|platformSerialNumber +|string +|False +a|Optional platform serial number + + +|providedLicense +|string +|False +a|Optional provided license + + +|capacityPackageName +|string +|False +a|Optional capacity-based package + + +|keyStoneSubscription +|string +|False +a|Keystone subscription ID + + +|useLatestVersion +|boolean +|False +a|Use the latest version + + +|=== + + +[#CIFSConfigurationRequest] +[.api-collapsible-fifth-title] +CIFSConfigurationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|False +a|DNS domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|activeDirectoryUsername +|string +|True +a|Active Directory username + + +|activeDirectoryPassword +|string +|True +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +[#GcpLabel] +[.api-collapsible-fifth-title] +GcpLabel + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|labelKey +|string +|False +a| + +|labelValue +|string +|False +a| + +|=== + + +[#WormRetentionPeriod] +[.api-collapsible-fifth-title] +WormRetentionPeriod + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|True +a|Length + + +|unit +|string +|True +a|Unit + + +|=== + + +[#WormRequest] +[.api-collapsible-fifth-title] +WormRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|retentionPeriod +|link:#WormRetentionPeriod[WormRetentionPeriod] +|True +a| + +|=== + + +[#GcpEncryption] +[.api-collapsible-fifth-title] +GcpEncryption + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|False +a| + +|=== + + +[#GcpHaParameters] +[.api-collapsible-fifth-title] +GcpHaParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|platformSerialNumberNode1 +|string +|False +a|Platform serial number for node 1 + + +|platformSerialNumberNode2 +|string +|False +a|Platform serial number for node 2 + + +|node1Zone +|string +|False +a|Zone for node 1 + + +|node2Zone +|string +|False +a|Zone for node 2 + + +|mediatorZone +|string +|False +a|Zone for mediator + + +|vpc0NodeAndDataConnectivity +|string +|False +a|VPC path for nic1, required for node and data connectivity + + +|vpc1ClusterConnectivity +|string +|False +a|VPC path for nic2, required for cluster connectivity + + +|vpc2HAConnectivity +|string +|False +a|VPC path for nic3, required for HA connectivity + + +|vpc3DataReplication +|string +|False +a|VPC path for nic4, required for data replication + + +|subnet0NodeAndDataConnectivity +|string +|False +a|Subnet path for nic1, required for node and data connectivity + + +|subnet1ClusterConnectivity +|string +|False +a|Subnet path for nic2, required for cluster connectivity + + +|subnet2HAConnectivity +|string +|False +a|Subnet path for nic3, required for HA connectivity + + +|subnet3DataReplication +|string +|False +a|Subnet path for nic4, required for data replication + + +|vpc0FirewallRuleName +|string +|False +a|Optional firewall rule name for vpc1 + + +|vpc1FirewallRuleName +|string +|False +a|Optional firewall rule name for vpc2 + + +|vpc2FirewallRuleName +|string +|False +a|Optional firewall rule name for vpc3 + + +|vpc3FirewallRuleName +|string +|False +a|Optional firewall rule name for vpc4 + + +|vpc0FirewallRuleTagName +|string +|False +a|Optional firewall tag name for vpc1 + + +|vpc1FirewallRuleTagName +|string +|False +a|Optional firewall tag name for vpc2 + + +|vpc2FirewallRuleTagName +|string +|False +a|Optional firewall tag name for vpc3 + + +|vpc3FirewallRuleTagName +|string +|False +a|Optional firewall tag name for vpc4 + + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + +Optional IOPS for the aggregate + + + +[#throughput] +[.api-collapsible-fifth-title] +throughput + +Optional throughput for the aggregate + + + +[#GcpPerformance] +[.api-collapsible-fifth-title] +GcpPerformance + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|iops +|link:#iops[iops] +|False +a|Optional IOPS for the aggregate + + +|throughput +|link:#throughput[throughput] +|False +a|Optional throughput for the aggregate + + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#labels] +[.api-collapsible-fifth-title] +labels +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#GcpProperties] +[.api-collapsible-fifth-title] +GcpProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|regionName +|string +|False +a| + +|zoneName +|array[string] +|False +a| + +|instanceType +|string +|False +a| + +|subnetCidr +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|projectName +|string +|False +a| + +|deploymentName +|string +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#GcpHaMediatorInfo] +[.api-collapsible-fifth-title] +GcpHaMediatorInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInstanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|version +|string +|False +a| + +|=== + + +[#GcpHaNodeInfo] +[.api-collapsible-fifth-title] +GcpHaNodeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|zone +|string +|False +a| + +|instanceType +|string +|False +a| + +|primaryIp +|string +|False +a| + +|instanceStatus +|string +|False +a| + +|numOfNics +|integer +|False +a| + +|labels +|link:#labels[labels] +|False +a| + +|=== + + +[#GcpHaProperties] +[.api-collapsible-fifth-title] +GcpHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorInfo +|link:#GcpHaMediatorInfo[GcpHaMediatorInfo] +|False +a| + +|node1Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|node2Info +|link:#GcpHaNodeInfo[GcpHaNodeInfo] +|False +a| + +|projectName +|string +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-monitoring-deploy-by-working-environments.adoc b/cvo/post-monitoring-deploy-by-working-environments.adoc new file mode 100644 index 00000000..619d608a --- /dev/null +++ b/cvo/post-monitoring-deploy-by-working-environments.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-monitoring-deploy-by-working-environments.html' +summary: 'Deploy a monitoring instance by systems' +--- + += Deploy a monitoring instance by systems + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/monitoring/deploy-by-working-environments`# + + + +Deploys a monitoring instance by systems. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentIds +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "workingEnvironmentIds": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-monitoring-disable-monitoring.adoc b/cvo/post-monitoring-disable-monitoring.adoc new file mode 100644 index 00000000..c172c264 --- /dev/null +++ b/cvo/post-monitoring-disable-monitoring.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-monitoring-disable-monitoring.html' +summary: 'Disable monitoring' +--- + += Disable monitoring + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/monitoring/{workingEnvironmentId}/disable-monitoring`# + + + +Disables monitoring. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-monitoring-enable-monitoring.adoc b/cvo/post-monitoring-enable-monitoring.adoc new file mode 100644 index 00000000..21aad966 --- /dev/null +++ b/cvo/post-monitoring-enable-monitoring.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-monitoring-enable-monitoring.html' +summary: 'Enable monitoring' +--- + += Enable monitoring + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/monitoring/{workingEnvironmentId}/enable-monitoring`# + + + +Enables monitoring. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-asup-send-cot-asup.adoc b/cvo/post-occm-asup-send-cot-asup.adoc new file mode 100644 index 00000000..f09164dd --- /dev/null +++ b/cvo/post-occm-asup-send-cot-asup.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-asup-send-cot-asup.html' +summary: 'Send Cloud Volumes ONTAP support data to NetApp support' +--- + += Send Cloud Volumes ONTAP support data to NetApp support + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/asup/send-Cot-Asup`# + + + +Sends Cloud Volumes ONTAP support data to NetApp Support. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|sendToOccm +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-asup-send-cot-performance-asup-.adoc b/cvo/post-occm-asup-send-cot-performance-asup-.adoc new file mode 100644 index 00000000..916036e0 --- /dev/null +++ b/cvo/post-occm-asup-send-cot-performance-asup-.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-asup-send-cot-performance-asup-.html' +summary: 'Send performance archive support data to NetApp support' +--- + += Send performance archive support data to NetApp support + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/asup/send-Cot-performance-Asup/{workingEnvironmentId}`# + + + +Sends Cloud Volumes ONTAP performance archive support data to NetApp Support. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-asup-send.adoc b/cvo/post-occm-asup-send.adoc new file mode 100644 index 00000000..239d2a86 --- /dev/null +++ b/cvo/post-occm-asup-send.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-asup-send.html' +summary: 'Send NetApp Console support data to NetApp support' +--- + += Send NetApp Console support data to NetApp support + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/asup/send`# + + + +Sends NetApp Console support data to NetApp Support. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|serial +|string +|header +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-encryption-certificate.adoc b/cvo/post-occm-encryption-certificate.adoc new file mode 100644 index 00000000..11d7185d --- /dev/null +++ b/cvo/post-occm-encryption-certificate.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-encryption-certificate.html' +summary: 'Validate and install a certificate' +--- + += Validate and install a certificate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/encryption/certificate`# + + + +Validates and installs the provided certificate. Successive API calls overwrite any previously installed certificates. The certificate must match a previously generated certificate signing request (CSR). + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|occmCertificate +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "occmCertificate": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + diff --git a/cvo/post-occm-encryption-csr.adoc b/cvo/post-occm-encryption-csr.adoc new file mode 100644 index 00000000..693192ee --- /dev/null +++ b/cvo/post-occm-encryption-csr.adoc @@ -0,0 +1,48 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-encryption-csr.html' +summary: 'Generate, store, and return a certificate signing request' +--- + += Generate, store, and return a certificate signing request + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/encryption/csr`# + + + +Generates, stores, and returns a certificate signing request (CSR). This CSR can be signed by a certificate authority (CA) and installed in the NetApp Console using /install_certificate. Successive calls will not overwrite previously generated CSRs. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|csr +|string +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "csr": "string" +} +==== + diff --git a/cvo/post-occm-encryption-key-managers-ca-certificates.adoc b/cvo/post-occm-encryption-key-managers-ca-certificates.adoc new file mode 100644 index 00000000..325c35ba --- /dev/null +++ b/cvo/post-occm-encryption-key-managers-ca-certificates.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-encryption-key-managers-ca-certificates.html' +summary: 'Add a new key manager CA certificate' +--- + += Add a new key manager CA certificate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/encryption/key-managers-ca-certificates`# + + + +Adds a new key manager certificate authority (CA) certificate. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|certificate +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "certificate": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + diff --git a/cvo/post-occm-encryption-key-managers.adoc b/cvo/post-occm-encryption-key-managers.adoc new file mode 100644 index 00000000..855f2cd6 --- /dev/null +++ b/cvo/post-occm-encryption-key-managers.adoc @@ -0,0 +1,156 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-encryption-key-managers.html' +summary: 'Add a new key manager' +--- + += Add a new key manager + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/encryption/key-managers`# + + + +Adds a new key manager. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|link:#NonEmptyOptionalString[NonEmptyOptionalString] +|False +a| + +|usernameValue +|link:#NonEmptyOptionalString[NonEmptyOptionalString] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "address": "string", + "usernameField": { + "_1": "string" + }, + "usernameValue": { + "_1": "string" + } +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "name": "string", + "address": "string", + "usernameField": "string", + "usernameValue": "string", + "status": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#NonEmptyOptionalString] +[.api-collapsible-fifth-title] +NonEmptyOptionalString + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-occm-key-store-external-certificate-file.adoc b/cvo/post-occm-key-store-external-certificate-file.adoc new file mode 100644 index 00000000..2ae91a08 --- /dev/null +++ b/cvo/post-occm-key-store-external-certificate-file.adoc @@ -0,0 +1,254 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-key-store-external-certificate-file.html' +summary: 'Generate a new key pair and self-signed certificate at the key store' +--- + += Generate a new key pair and self-signed certificate at the key store + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/key-store/external-certificate-file`# + + + +Generates a new key pair and self-signed certificate at the key store and returns a certificate signing request (CSR). + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|certificateFilename +|string +|header +|False +a| + +|privateKeyFilename +|string +|header +|False +a| + +|algorithm +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +//end collapsible .Definitions block +==== diff --git a/cvo/post-occm-key-store-external-certificate.adoc b/cvo/post-occm-key-store-external-certificate.adoc new file mode 100644 index 00000000..18bea964 --- /dev/null +++ b/cvo/post-occm-key-store-external-certificate.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-key-store-external-certificate.html' +summary: 'Generate a new key pair and self-signed certificate at the key store' +--- + += Generate a new key pair and self-signed certificate at the key store + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/key-store/external-certificate`# + + + +Generates a new key pair and self-signed certificate at the key store and returns a certificate signing request (CSR). + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|occmCertificate +|string +|True +a| + +|privateKey +|string +|False +a| + +|algorithm +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "occmCertificate": "string", + "privateKey": "string", + "algorithm": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + diff --git a/cvo/post-occm-key-store-signed-certificate-file.adoc b/cvo/post-occm-key-store-signed-certificate-file.adoc new file mode 100644 index 00000000..67acc181 --- /dev/null +++ b/cvo/post-occm-key-store-signed-certificate-file.adoc @@ -0,0 +1,242 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-key-store-signed-certificate-file.html' +summary: 'Validate and install the provided root CA chain' +--- + += Validate and install the provided root CA chain + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/key-store/signed-certificate-file`# + + + +Validates and installs the provided root certificate authority (CA) chain. Successive calls will overwrite any previously installed root certificate authority (CA) chain. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +//end collapsible .Definitions block +==== diff --git a/cvo/post-occm-key-store-signed-certificate.adoc b/cvo/post-occm-key-store-signed-certificate.adoc new file mode 100644 index 00000000..fc8227af --- /dev/null +++ b/cvo/post-occm-key-store-signed-certificate.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-key-store-signed-certificate.html' +summary: 'Validate and install the provided root CA chain' +--- + += Validate and install the provided root CA chain + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/key-store/signed-certificate`# + + + +Validates and installs the provided root certificate authority (CA) chain. Successive calls will overwrite any previously installed root certificate authority (CA) chain. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|occmCertificate +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "occmCertificate": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + diff --git a/cvo/post-occm-key-store-trusted-certificate-file.adoc b/cvo/post-occm-key-store-trusted-certificate-file.adoc new file mode 100644 index 00000000..da56dc03 --- /dev/null +++ b/cvo/post-occm-key-store-trusted-certificate-file.adoc @@ -0,0 +1,193 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-key-store-trusted-certificate-file.html' +summary: 'Validate and install the certificate in the trust store' +--- + += Validate and install the certificate in the trust store + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/key-store/trusted-certificate-file`# + + + +Validates and installs the provided certificate in the trust store. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +//end collapsible .Definitions block +==== diff --git a/cvo/post-occm-key-store.adoc b/cvo/post-occm-key-store.adoc new file mode 100644 index 00000000..effb97cf --- /dev/null +++ b/cvo/post-occm-key-store.adoc @@ -0,0 +1,76 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-key-store.html' +summary: 'Generate a new key pair and self-signed certificate' +--- + += Generate a new key pair and self-signed certificate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/key-store`# + + + +Generates a new key pair and self-signed certificate at the key store and returns a certificate signing request (CSR). + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|commonName +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "commonName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|csr +|string +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "csr": "string" +} +==== + diff --git a/cvo/post-occm-setup-portal-complete-connectivity-pending-setup.adoc b/cvo/post-occm-setup-portal-complete-connectivity-pending-setup.adoc new file mode 100644 index 00000000..4215a8e7 --- /dev/null +++ b/cvo/post-occm-setup-portal-complete-connectivity-pending-setup.adoc @@ -0,0 +1,48 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-setup-portal-complete-connectivity-pending-setup.html' +summary: 'Complete the setup' +--- + += Complete the setup + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/setup-portal/complete-connectivity-pending-setup`# + + + +Completes the setup that is pending connectivity. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|upgradeToVersion +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "upgradeToVersion": "string" +} +==== + diff --git a/cvo/post-occm-setup-portal-init-standalone-local-auth.adoc b/cvo/post-occm-setup-portal-init-standalone-local-auth.adoc new file mode 100644 index 00000000..09006844 --- /dev/null +++ b/cvo/post-occm-setup-portal-init-standalone-local-auth.adoc @@ -0,0 +1,148 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-setup-portal-init-standalone-local-auth.html' +summary: 'Perform an initial standalone setup with the local identity provider' +--- + += Perform an initial standalone setup with the local identity provider + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/setup-portal/init-standalone-local-auth`# + + + +Performs initial standalone setup with a local identity provider. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|Authorization +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|adminUser +|link:#LocalAuthSetupUserRequest[LocalAuthSetupUserRequest] +|True +a| + +|site +|string +|False +a| + +|company +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "adminUser": { + "email": "string", + "password": "string", + "fullName": "string" + }, + "site": "string", + "company": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|upgradeToVersion +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "upgradeToVersion": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#LocalAuthSetupUserRequest] +[.api-collapsible-fifth-title] +LocalAuthSetupUserRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|email +|string +|False +a| + +|password +|string +|False +a| + +|fullName +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-occm-setup-portal-init.adoc b/cvo/post-occm-setup-portal-init.adoc new file mode 100644 index 00000000..c8aed761 --- /dev/null +++ b/cvo/post-occm-setup-portal-init.adoc @@ -0,0 +1,163 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-setup-portal-init.html' +summary: 'Perform an initial setup with NetApp Console' +--- + += Perform an initial setup with NetApp Console + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/setup-portal/init`# + + + +Performs initial setup with NetApp Cloud Central. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|Authorization +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|site +|string +|False +a|Site + + +|company +|string +|False +a|Company + + +|tenancyAccountId +|string +|False +a|Tenancy account ID + + +|proxyUrl +|link:#ProxyUri[ProxyUri] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "site": "string", + "company": "string", + "tenancyAccountId": "string", + "proxyUrl": { + "uri": "string", + "proxyUserName": "string", + "proxyPassword": "string", + "proxyDomain": "string" + } +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|upgradeToVersion +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "upgradeToVersion": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ProxyUri] +[.api-collapsible-fifth-title] +ProxyUri + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uri +|string +|False +a| + +|proxyUserName +|string +|False +a| + +|proxyPassword +|string +|False +a| + +|proxyDomain +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-occm-setup-portal-proxy-setup.adoc b/cvo/post-occm-setup-portal-proxy-setup.adoc new file mode 100644 index 00000000..8ea89e18 --- /dev/null +++ b/cvo/post-occm-setup-portal-proxy-setup.adoc @@ -0,0 +1,69 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-setup-portal-proxy-setup.html' +summary: 'Set up a proxy URL' +--- + += Set up a proxy URL + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/setup-portal/proxy/setup`# + + + +Sets up a specified proxy URL. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uri +|string +|True +a| + +|proxyUserName +|string +|False +a| + +|proxyPassword +|string +|False +a| + +|proxyDomain +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "uri": "string", + "proxyUserName": "string", + "proxyPassword": "string", + "proxyDomain": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-setup-portal-register-in-local-auth.adoc b/cvo/post-occm-setup-portal-register-in-local-auth.adoc new file mode 100644 index 00000000..ce22dd3f --- /dev/null +++ b/cvo/post-occm-setup-portal-register-in-local-auth.adoc @@ -0,0 +1,48 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-setup-portal-register-in-local-auth.html' +summary: 'Register NetApp Console to a dark site' +--- + += Register NetApp Console to a dark site + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/setup-portal/register-in-local-auth`# + + + +Registers NetApp Console in a dark site. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clientId +|string +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "clientId": "string" +} +==== + diff --git a/cvo/post-occm-setup-portal-register.adoc b/cvo/post-occm-setup-portal-register.adoc new file mode 100644 index 00000000..a47c6108 --- /dev/null +++ b/cvo/post-occm-setup-portal-register.adoc @@ -0,0 +1,48 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-setup-portal-register.html' +summary: 'Register NetApp Console' +--- + += Register NetApp Console + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/setup-portal/register`# + + + +Registers the NetApp Console to NetApp Cloud Central. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clientId +|string +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "clientId": "string" +} +==== + diff --git a/cvo/post-occm-setup-portal-validate-connectivity.adoc b/cvo/post-occm-setup-portal-validate-connectivity.adoc new file mode 100644 index 00000000..9cb707ff --- /dev/null +++ b/cvo/post-occm-setup-portal-validate-connectivity.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-setup-portal-validate-connectivity.html' +summary: 'Confirm the NetApp Console active internet connection' +--- + += Confirm the NetApp Console active internet connection + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/setup-portal/validate/connectivity`# + + + +Validates that the NetApp Console has an active internet connection. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-setup-validate-connectivity.adoc b/cvo/post-occm-setup-validate-connectivity.adoc new file mode 100644 index 00000000..ab6bc2b4 --- /dev/null +++ b/cvo/post-occm-setup-validate-connectivity.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-setup-validate-connectivity.html' +summary: 'Validate an active internet connection' +--- + += Validate an active internet connection + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/setup/validate/connectivity`# + + + +Validates that the NetApp Console has an active internet connection. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-setup-validate-proxy.adoc b/cvo/post-occm-setup-validate-proxy.adoc new file mode 100644 index 00000000..9b0fdc60 --- /dev/null +++ b/cvo/post-occm-setup-validate-proxy.adoc @@ -0,0 +1,69 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-setup-validate-proxy.html' +summary: 'Validate a proxy URL' +--- + += Validate a proxy URL + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/setup/validate/proxy`# + + + +Validates the specified proxy URL. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uri +|string +|False +a| + +|proxyUserName +|string +|False +a| + +|proxyPassword +|string +|False +a| + +|proxyDomain +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "uri": "string", + "proxyUserName": "string", + "proxyPassword": "string", + "proxyDomain": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-system-cloud-ontap-update-image-metadata.adoc b/cvo/post-occm-system-cloud-ontap-update-image-metadata.adoc new file mode 100644 index 00000000..b4044756 --- /dev/null +++ b/cvo/post-occm-system-cloud-ontap-update-image-metadata.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-system-cloud-ontap-update-image-metadata.html' +summary: 'Perform a fetch and process of image update metadata files' +--- + += Perform a fetch and process of image update metadata files + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/system/cloud-ontap-update-image-metadata`# + + + +Retrieves and processes Cloud Volumes ONTAP image update metadata files. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-system-cloud-ontap-update-metadata.adoc b/cvo/post-occm-system-cloud-ontap-update-metadata.adoc new file mode 100644 index 00000000..69880674 --- /dev/null +++ b/cvo/post-occm-system-cloud-ontap-update-metadata.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-system-cloud-ontap-update-metadata.html' +summary: 'Perform a fetch and cache of Cloud Volumes ONTAP and NetApp Console files' +--- + += Perform a fetch and cache of Cloud Volumes ONTAP and NetApp Console files + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/system/cloud-ontap-update-metadata`# + + + +Performs fetch and cache of Cloud Volumes ONTAP and NetApp Console version information files from S3. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-system-manually-activate-auto-vsa-capacity-management-cycle.adoc b/cvo/post-occm-system-manually-activate-auto-vsa-capacity-management-cycle.adoc new file mode 100644 index 00000000..0de6b406 --- /dev/null +++ b/cvo/post-occm-system-manually-activate-auto-vsa-capacity-management-cycle.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-system-manually-activate-auto-vsa-capacity-management-cycle.html' +summary: 'Activate the Cloud Volumes ONTAP capacity automatic management cycle' +--- + += Activate the Cloud Volumes ONTAP capacity automatic management cycle + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/system/manually-activate-auto-vsa-capacity-management-cycle`# + + + +Activates the Cloud Volumes ONTAP capacity automatic management cycle manually. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-system-manually-trigger-send-daily-notification.adoc b/cvo/post-occm-system-manually-trigger-send-daily-notification.adoc new file mode 100644 index 00000000..3bfdb57f --- /dev/null +++ b/cvo/post-occm-system-manually-trigger-send-daily-notification.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-system-manually-trigger-send-daily-notification.html' +summary: 'Trigger sending daily notifications' +--- + += Trigger sending daily notifications + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/system/manually-trigger-send-daily-notification`# + + + +Triggers daily notification sending manually. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-system-patch.adoc b/cvo/post-occm-system-patch.adoc new file mode 100644 index 00000000..5bc4670c --- /dev/null +++ b/cvo/post-occm-system-patch.adoc @@ -0,0 +1,191 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-system-patch.html' +summary: 'Update the NetApp Console with the specified patch version' +--- + += Update the NetApp Console with the specified patch version + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/system/patch`# + + + +Updates the NetApp Console with the specified patch version. Backups should be provided in multipart/form-data, with the file at a part named 'patch'. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +//end collapsible .Definitions block +==== diff --git a/cvo/post-occm-system-restart-server.adoc b/cvo/post-occm-system-restart-server.adoc new file mode 100644 index 00000000..f97d97dc --- /dev/null +++ b/cvo/post-occm-system-restart-server.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-system-restart-server.html' +summary: 'Restart the server' +--- + += Restart the server + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/system/restart-server`# + + + +Restarts the server. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-system-update.adoc b/cvo/post-occm-system-update.adoc new file mode 100644 index 00000000..d4f4bc67 --- /dev/null +++ b/cvo/post-occm-system-update.adoc @@ -0,0 +1,52 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-system-update.html' +summary: 'Update the NetApp Console' +--- + += Update the NetApp Console + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/system/update`# + + + +Updates the NetApp Console to the specified version. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|date +|integer +|True +a| + +|releaseNumber +|integer +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-occm-tenancy-service-workspaces-associate.adoc b/cvo/post-occm-tenancy-service-workspaces-associate.adoc new file mode 100644 index 00000000..7bfa55d6 --- /dev/null +++ b/cvo/post-occm-tenancy-service-workspaces-associate.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-occm-tenancy-service-workspaces-associate.html' +summary: 'Associate a console agent with a workspace' +--- + += Associate a console agent with a workspace + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/occm/tenancy-service/workspaces/{workspaceId}/associate`# + + + +Associates a a console agent with a workspace. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workspaceId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-onprem-volumes--clone.adoc b/cvo/post-onprem-volumes--clone.adoc new file mode 100644 index 00000000..1f423f08 --- /dev/null +++ b/cvo/post-onprem-volumes--clone.adoc @@ -0,0 +1,89 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-onprem-volumes--clone.html' +summary: 'Clone an existing volume' +--- + += Clone an existing volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone`# + + + +Clones an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newVolumeName +|string +|True +a|New volume name + + +|parentSnapshot +|string +|False +a|Snapshot name to use for the clone + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "newVolumeName": "string", + "parentSnapshot": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-onprem-volumes--snapshot.adoc b/cvo/post-onprem-volumes--snapshot.adoc new file mode 100644 index 00000000..a1fd5bc8 --- /dev/null +++ b/cvo/post-onprem-volumes--snapshot.adoc @@ -0,0 +1,82 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-onprem-volumes--snapshot.html' +summary: 'Create a snapshot' +--- + += Create a snapshot + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Creates a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|string +|False +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-onprem-volumes.adoc b/cvo/post-onprem-volumes.adoc new file mode 100644 index 00000000..23476930 --- /dev/null +++ b/cvo/post-onprem-volumes.adoc @@ -0,0 +1,436 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-onprem-volumes.html' +summary: 'Create a new volume' +--- + += Create a new volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/onprem/volumes`# + + + +Creates a new volume. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|True +a|Target system ID + + +|svmName +|string +|True +a|SVM name + + +|aggregateName +|string +|False +a|Aggregate in which to create the volume + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|True +a|Snapshot policy name + + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|iscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableThinProvisioning +|boolean +|True +a|Enable thin provisioning on the volume + + +|enableCompression +|boolean +|True +a|Enable compression on the volume + + +|enableDeduplication +|boolean +|True +a|Enable deduplication on the volume + + +|syncToS3 +|boolean +|True +a|Add a cloud sync relationship + + +|volumeTags +|array[link:#VolumeTags[VolumeTags]] +|True +a|Optionally, provide key-value pairs with which to tag the ONTAP volume using the App Template service. + + +|flexGroupVolumeInfo +|link:#FlexGroupVolumeInfo[FlexGroupVolumeInfo] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#VolumeTags] +[.api-collapsible-fifth-title] +VolumeTags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|False +a| + +|tagValue +|string +|False +a| + +|=== + + +[#FlexGroupVolumeInfo] +[.api-collapsible-fifth-title] +FlexGroupVolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateList +|array[string] +|False +a|Names of aggregates for the FlexGroup volume + + +|numberOfConstituents +|integer +|False +a|Number of constituents for the FlexGroup volume + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-onprem-working-environments-aws-cloud-backup-setup.adoc b/cvo/post-onprem-working-environments-aws-cloud-backup-setup.adoc new file mode 100644 index 00000000..363151a0 --- /dev/null +++ b/cvo/post-onprem-working-environments-aws-cloud-backup-setup.adoc @@ -0,0 +1,112 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-onprem-working-environments-aws-cloud-backup-setup.html' +summary: 'Set up AWS backup to cloud' +--- + += Set up AWS backup to cloud + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/onprem/working-environments/{workingEnvironmentId}/aws-cloud-backup-setup`# + + + +Sets up AWS backup to cloud on an on-premises system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|awsAccessKeys +|link:#AwsAccessKeys[AwsAccessKeys] +|True +a| + +|ipSpace +|string +|False +a|IPspace + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "awsAccessKeys": { + "accessKey": "string", + "secretKey": "string" + }, + "ipSpace": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AwsAccessKeys] +[.api-collapsible-fifth-title] +AwsAccessKeys + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accessKey +|string +|True +a| + +|secretKey +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-onprem-working-environments-azure-cloud-backup-setup.adoc b/cvo/post-onprem-working-environments-azure-cloud-backup-setup.adoc new file mode 100644 index 00000000..9950fb01 --- /dev/null +++ b/cvo/post-onprem-working-environments-azure-cloud-backup-setup.adoc @@ -0,0 +1,91 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-onprem-working-environments-azure-cloud-backup-setup.html' +summary: 'Set up Azure backup to cloud' +--- + += Set up Azure backup to cloud + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/onprem/working-environments/{workingEnvironmentId}/azure-cloud-backup-setup`# + + + +Sets up Azure backup to cloud on an on-premises system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|rgName +|string +|False +a|Azure resource group name. By default, it creates a new resource group. + + +|ipSpace +|string +|False +a|IPspace + + +|region +|string +|False +a|The region. By default, the NetApp Console region. + + +|subscriptionId +|string +|False +a|The subscription ID. By default, the NetApp Console Azure subscription. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "rgName": "string", + "ipSpace": "string", + "region": "string", + "subscriptionId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-onprem-working-environments-gcp-cloud-backup-setup.adoc b/cvo/post-onprem-working-environments-gcp-cloud-backup-setup.adoc new file mode 100644 index 00000000..02984018 --- /dev/null +++ b/cvo/post-onprem-working-environments-gcp-cloud-backup-setup.adoc @@ -0,0 +1,98 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-onprem-working-environments-gcp-cloud-backup-setup.html' +summary: 'Set up Google Cloud backup to cloud' +--- + += Set up Google Cloud backup to cloud + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/onprem/working-environments/{workingEnvironmentId}/gcp-cloud-backup-setup`# + + + +Sets up Google Cloud backup to cloud on an on-premises system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|project +|string +|False +a|Google Cloud project ID. By default, the NetApp Console project. + + +|region +|string +|False +a|The region. By default, the NetApp Console region. + + +|accessKey +|string +|False +a|Google Cloud access key used by NetApp Backup and Recovery. + + +|secretKey +|string +|False +a|Google Cloud secret key used by NetApp Backup and Recovery. + + +|ipSpace +|string +|False +a|IPspace + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "project": "string", + "region": "string", + "accessKey": "string", + "secretKey": "string", + "ipSpace": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-onprem-working-environments-sgws-cloud-backup-setup.adoc b/cvo/post-onprem-working-environments-sgws-cloud-backup-setup.adoc new file mode 100644 index 00000000..ef0d1998 --- /dev/null +++ b/cvo/post-onprem-working-environments-sgws-cloud-backup-setup.adoc @@ -0,0 +1,121 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-onprem-working-environments-sgws-cloud-backup-setup.html' +summary: 'Set up StorageGRID backup to cloud' +--- + += Set up StorageGRID backup to cloud + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/onprem/working-environments/{workingEnvironmentId}/sgws-cloud-backup-setup`# + + + +Sets up StorageGRID backup to cloud on an on-premises system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sgwsCredentials +|link:#SgwsCredentialsRequest[SgwsCredentialsRequest] +|True +a| + +|ipSpace +|string +|False +a|IPspace + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "sgwsCredentials": { + "accessKey": "string", + "secretKey": "string", + "serviceUrl": "string" + }, + "ipSpace": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SgwsCredentialsRequest] +[.api-collapsible-fifth-title] +SgwsCredentialsRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accessKey +|string +|True +a|StorageGRID access key + + +|secretKey +|string +|True +a|StorageGRID secret key + + +|serviceUrl +|string +|False +a|StorageGRID endpoint (protocol, FQDN, and port) + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-onprem-working-environments.adoc b/cvo/post-onprem-working-environments.adoc new file mode 100644 index 00000000..3be80bb6 --- /dev/null +++ b/cvo/post-onprem-working-environments.adoc @@ -0,0 +1,1969 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-onprem-working-environments.html' +summary: 'Discover an on-premises system' +--- + += Discover an on-premises system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/onprem/working-environments`# + + + +Discovers an on-premises system in the NetApp Console. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tenantId +|string +|True +a| + +|description +|string +|False +a| + +|name +|string +|False +a| + +|clusterAddress +|string +|False +a| + +|clusterUserName +|string +|False +a| + +|clusterPassword +|string +|False +a| + +|location +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tenantId": "string", + "description": "string", + "name": "string", + "clusterAddress": "string", + "clusterUserName": "string", + "clusterPassword": "string", + "location": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|tenantId +|string +|False +a| + +|description +|string +|False +a| + +|name +|string +|False +a| + +|discoverUserEmail +|string +|False +a| + +|location +|string +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|interClusterLifs +|array[link:#InterClusterLif[InterClusterLif]] +|True +a| + +|cronJobSchedules +|array[link:#CronJobSchedule[CronJobSchedule]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|clusterProperties +|link:#OnPremClusterProperties[OnPremClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OnPremClusterProperties[OnPremClusterProperties] +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|cloudSyncProperties +|link:#CloudSyncProperties[CloudSyncProperties] +|False +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|capacityFeatures +|link:#OnPremCapacityFeatures[OnPremCapacityFeatures] +|False +a| + +|aff +|boolean +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "tenantId": "string", + "description": "string", + "name": "string", + "discoverUserEmail": "string", + "location": "string", + "status": { + "status": "string", + "message": "string", + "extendedFailureReason": "string" + }, + "interClusterLifs": [ + { + "name": "string", + "address": "string", + "port": "string", + "node": "string", + "status": "string" + } + ], + "cronJobSchedules": [ + { + "name": "string", + "description": "string", + "months": [ + "string" + ], + "days": [ + "string" + ], + "weekDays": [ + "string" + ], + "hours": [ + "string" + ], + "minutes": [ + "string" + ] + } + ], + "svms": [ + {} + ], + "snapshotPolicies": [ + { + "name": "string", + "schedules": [ + {} + ], + "description": "string" + } + ], + "replicationProperties": { + "peers": [ + "string" + ], + "replicationTargets": [ + "string" + ] + }, + "clusterProperties": { + "clusterAddress": "string", + "ontapVersion": "string", + "clusterName": "string", + "serialNumber": "string", + "systemId": "string", + "licenses": [ + "string" + ], + "systemManagerUrl": "string", + "clusterUuid": "string", + "nodeModels": [ + "string" + ], + "lifs": [ + {} + ] + }, + "ontapClusterProperties": { + "clusterAddress": "string", + "ontapVersion": "string", + "clusterName": "string", + "serialNumber": "string", + "systemId": "string", + "licenses": [ + "string" + ], + "systemManagerUrl": "string", + "clusterUuid": "string", + "nodeModels": [ + "string" + ], + "lifs": [ + {} + ] + }, + "workingEnvironmentType": "string", + "cloudSyncProperties": { + "status": { + "status": "string", + "failureMessage": "string" + }, + "dataBrokerProperties": { + "id": "string", + "name": "string", + "dataBrokerPlacement": { + "vpcId": "string", + "subnetId": "string", + "instanceType": "string", + "instanceId": "string", + "keyPair": "string" + } + }, + "s3Location": "string", + "relationships": [ + { + "volumeName": "string", + "svmName": "string", + "relationshipStatus": "string", + "s3Location": "string", + "id": "string", + "failureMessage": "string" + } + ] + }, + "actionsRequired": [ + {} + ], + "capacityFeatures": { + "objectStoreConfigExtended": { + "objectStoreConfig": { + "objectStoreName": "string", + "s3Name": "string", + "server": "string", + "providerType": "string" + }, + "tierLevel": "string" + } + }, + "cbsProperties": { + "cbsBackupStatus": "string", + "cbsRules": [ + { + "snapmirrorLabel": "string" + } + ], + "objectStoreName": "string", + "providerSpecific": { + "azureRgName": "string", + "gcpProjectId": "string", + "gcpRegion": "string" + }, + "cbsPolicyName": "string", + "ipSpace": "string", + "region": "string", + "providerAccountName": "string", + "exclusionReason": "string" + }, + "complianceProperties": { + "scanStatus": "string", + "complianceStatus": { + "scanStatus": { + "volumes": [ + { + "name": "string", + "status": "string", + "error": "string" + } + ] + } + }, + "lastDeploymentError": "string", + "complianceBackupStatus": "string" + }, + "monitoringProperties": { + "monitoringStatus": "string", + "monitoringInfo": { + "averageLatency": { + "unit": "string" + }, + "storageAverageThroughput": { + "unit": "string" + }, + "node1AverageThroughput": { + "unit": "string" + }, + "node2AverageThroughput": { + "unit": "string" + } + }, + "tenantUrl": "string" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#InterClusterLif] +[.api-collapsible-fifth-title] +InterClusterLif + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|port +|string +|False +a| + +|node +|string +|False +a| + +|status +|string +|False +a| + +|isPeered +|boolean +|False +a| + +|=== + + +[#CronJobSchedule] +[.api-collapsible-fifth-title] +CronJobSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|description +|string +|False +a| + +|months +|array[string] +|True +a| + +|days +|array[string] +|False +a| + +|weekDays +|array[string] +|False +a| + +|hours +|array[string] +|False +a| + +|minutes +|array[string] +|False +a| + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#OnPremClusterProperties] +[.api-collapsible-fifth-title] +OnPremClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clusterAddress +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|clusterName +|string +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|isSnapmirrorLicenseExists +|boolean +|False +a| + +|licenses +|array[string] +|False +a| + +|systemManagerUrl +|string +|False +a| + +|location +|link:#Value[Value] +|False +a| + +|clusterUuid +|string +|False +a| + +|nodeModels +|array[string] +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|isAff +|boolean +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|sanOptimized +|boolean +|False +a| + +|disaggregated +|boolean +|False +a| + +|=== + + +[#CloudSyncStatus] +[.api-collapsible-fifth-title] +CloudSyncStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#DataBrokerPlacement] +[.api-collapsible-fifth-title] +DataBrokerPlacement + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|False +a| + +|subnetId +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|keyPair +|string +|False +a| + +|=== + + +[#DataBrokerProperties] +[.api-collapsible-fifth-title] +DataBrokerProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|dataBrokerPlacement +|link:#DataBrokerPlacement[DataBrokerPlacement] +|False +a| + +|=== + + +[#CloudSyncRelationship] +[.api-collapsible-fifth-title] +CloudSyncRelationship + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|relationshipStatus +|string +|False +a| + +|s3Location +|string +|False +a| + +|id +|string +|False +a| + +|progress +|integer +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#CloudSyncProperties] +[.api-collapsible-fifth-title] +CloudSyncProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSynced +|boolean +|False +a| + +|status +|link:#CloudSyncStatus[CloudSyncStatus] +|False +a| + +|dataBrokerProperties +|link:#DataBrokerProperties[DataBrokerProperties] +|False +a| + +|s3Location +|string +|False +a| + +|relationships +|array[link:#CloudSyncRelationship[CloudSyncRelationship]] +|False +a| + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#ObjectStoreConfigInfo] +[.api-collapsible-fifth-title] +ObjectStoreConfigInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectStoreName +|string +|False +a| + +|s3Name +|string +|False +a| + +|usedSpace +|link:#Capacity[Capacity] +|False +a| + +|server +|string +|False +a| + +|providerType +|string +|False +a| + +|=== + + +[#ExtendedObjectStoreConfigInfo] +[.api-collapsible-fifth-title] +ExtendedObjectStoreConfigInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectStoreConfig +|link:#ObjectStoreConfigInfo[ObjectStoreConfigInfo] +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OnPremCapacityFeatures] +[.api-collapsible-fifth-title] +OnPremCapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|objectStoreConfigExtended +|link:#ExtendedObjectStoreConfigInfo[ExtendedObjectStoreConfigInfo] +|False +a| + +|performanceTierUsedCapacity +|link:#Capacity[Capacity] +|False +a| + +|inactiveUserData +|link:#Capacity[Capacity] +|False +a| + +|rawCapacity +|link:#Capacity[Capacity] +|False +a| + +|fiveYearSavings +|number +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-replication-break--.adoc b/cvo/post-replication-break--.adoc new file mode 100644 index 00000000..69cfaac4 --- /dev/null +++ b/cvo/post-replication-break--.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-replication-break--.html' +summary: 'Break a SnapMirror replication relationship' +--- + += Break a SnapMirror replication relationship + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/replication/break/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}`# + + + +Breaks a SnapMirror replication relationship. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|destinationWorkingEnvironmentId +|string +|path +|True +a| + +|destinationSvmName +|string +|path +|True +a| + +|destinationVolumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-replication-initialize--.adoc b/cvo/post-replication-initialize--.adoc new file mode 100644 index 00000000..aa16955f --- /dev/null +++ b/cvo/post-replication-initialize--.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-replication-initialize--.html' +summary: 'Initialize an existing SnapMirror relationship' +--- + += Initialize an existing SnapMirror relationship + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/replication/initialize/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}`# + + + +Initializes an existing SnapMirror relationship. This method can only be performed when the relationship has already been established and is healthy, idle, and uninitialized. For example, if the initial transfer were interrupted, it can be restarted with this request. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|destinationWorkingEnvironmentId +|string +|path +|True +a| + +|destinationSvmName +|string +|path +|True +a| + +|destinationVolumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-replication-onprem.adoc b/cvo/post-replication-onprem.adoc new file mode 100644 index 00000000..d0f4803d --- /dev/null +++ b/cvo/post-replication-onprem.adoc @@ -0,0 +1,225 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-replication-onprem.html' +summary: 'Create a new replication for an on-premises system' +--- + += Create a new replication for an on-premises system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/replication/onprem`# + + + +Creates a new replication to an on-premises system. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|replicationRequest +|link:#ReplicationRequest[ReplicationRequest] +|True +a| + +|replicationVolume +|link:#OnPremVolumeRequest[OnPremVolumeRequest] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "replicationRequest": { + "sourceWorkingEnvironmentId": "string", + "destinationWorkingEnvironmentId": "string", + "sourceInterclusterLifIps": [ + "string" + ], + "destinationInterclusterLifIps": [ + "string" + ], + "policyName": "string", + "scheduleName": "string", + "sourceIpSpace": "string", + "destinationIpSpace": "string" + }, + "replicationVolume": { + "sourceSvmName": "string", + "sourceVolumeName": "string", + "destinationVolumeName": "string", + "destinationAggregateName": "string", + "destinationSvmName": "string", + "destinationCapacityTier": "string", + "tieringPolicy": "string" + } +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ReplicationRequest] +[.api-collapsible-fifth-title] +ReplicationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sourceWorkingEnvironmentId +|string +|True +a|Source system ID + + +|destinationWorkingEnvironmentId +|string +|True +a|Destination system ID + + +|sourceInterclusterLifIps +|array[string] +|True +a|Source intercluster LIF IPs + + +|destinationInterclusterLifIps +|array[string] +|True +a|Destination intercluster LIF IPs + + +|policyName +|string +|True +a|SnapMirror policy name + + +|scheduleName +|string +|False +a|Schedule name + + +|maxTransferRate +|integer +|False +a|Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624 + + +|sourceIpSpace +|string +|False +a|Source IpSpace + + +|destinationIpSpace +|string +|False +a|Destination IpSpace + + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +[#OnPremVolumeRequest] +[.api-collapsible-fifth-title] +OnPremVolumeRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sourceSvmName +|string +|True +a|Source SVM name + + +|sourceVolumeName +|string +|True +a|Source volume name + + +|destinationVolumeName +|string +|True +a|Destination volume name + + +|destinationAggregateName +|string +|True +a|Destination aggregate name + + +|destinationSvmName +|string +|True +a|Destination SVM name + + +|destinationCapacityTier +|string +|False +a|Destination aggregate capacity tier + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-replication-resync--.adoc b/cvo/post-replication-resync--.adoc new file mode 100644 index 00000000..91fc0508 --- /dev/null +++ b/cvo/post-replication-resync--.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-replication-resync--.html' +summary: 'Resync a SnapMirror replication relationship' +--- + += Resync a SnapMirror replication relationship + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/replication/resync/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}`# + + + +Resyncs a SnapMirror replication relationship. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|destinationWorkingEnvironmentId +|string +|path +|True +a| + +|destinationSvmName +|string +|path +|True +a| + +|destinationVolumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-replication-reverse--.adoc b/cvo/post-replication-reverse--.adoc new file mode 100644 index 00000000..eca356cc --- /dev/null +++ b/cvo/post-replication-reverse--.adoc @@ -0,0 +1,96 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-replication-reverse--.html' +summary: 'Reverse an existing SnapMirror relationship' +--- + += Reverse an existing SnapMirror relationship + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/replication/reverse/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}`# + + + +Reverses an existing SnapMirror relationship. This method can only be performed when the relationship has already been established and is healthy and idle. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|destinationWorkingEnvironmentId +|string +|path +|True +a| + +|destinationSvmName +|string +|path +|True +a| + +|destinationVolumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sourceWorkingEnvironmentId +|string +|True +a|System ID + + +|sourceSvmName +|string +|True +a|SVM name + + +|sourceVolumeName +|string +|True +a|volume name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "sourceWorkingEnvironmentId": "string", + "sourceSvmName": "string", + "sourceVolumeName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-replication-update--.adoc b/cvo/post-replication-update--.adoc new file mode 100644 index 00000000..f9a42c88 --- /dev/null +++ b/cvo/post-replication-update--.adoc @@ -0,0 +1,53 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-replication-update--.html' +summary: 'Update the destination endpoint of the SnapMirror relationship' +--- + += Update the destination endpoint of the SnapMirror relationship + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/replication/update/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}`# + + + +Updates the destination endpoint of the SnapMirror relationship. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|destinationWorkingEnvironmentId +|string +|path +|True +a| + +|destinationSvmName +|string +|path +|True +a| + +|destinationVolumeName +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-replication-vsa.adoc b/cvo/post-replication-vsa.adoc new file mode 100644 index 00000000..1b6af60f --- /dev/null +++ b/cvo/post-replication-vsa.adoc @@ -0,0 +1,315 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-replication-vsa.html' +summary: 'Create a new replication for a Cloud Volumes ONTAP system' +--- + += Create a new replication for a Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/replication/vsa`# + + + +Creates a new replication to a Cloud Volumes ONTAP system. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|replicationRequest +|link:#ReplicationRequest[ReplicationRequest] +|True +a| + +|replicationVolume +|link:#VsaVolumeRequest[VsaVolumeRequest] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ReplicationRequest] +[.api-collapsible-fifth-title] +ReplicationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sourceWorkingEnvironmentId +|string +|True +a|Source system ID + + +|destinationWorkingEnvironmentId +|string +|True +a|Destination system ID + + +|sourceInterclusterLifIps +|array[string] +|True +a|Source intercluster LIF IPs + + +|destinationInterclusterLifIps +|array[string] +|True +a|Destination intercluster LIF IPs + + +|policyName +|string +|True +a|SnapMirror policy name + + +|scheduleName +|string +|False +a|Schedule name + + +|maxTransferRate +|integer +|False +a|Maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624 + + +|sourceIpSpace +|string +|False +a|Source IpSpace + + +|destinationIpSpace +|string +|False +a|Destination IpSpace + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +[#VsaVolumeRequest] +[.api-collapsible-fifth-title] +VsaVolumeRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sourceSvmName +|string +|True +a|Source SVM name + + +|sourceVolumeName +|string +|True +a|Source volume name + + +|destinationVolumeName +|string +|True +a|Destination volume name + + +|destinationAggregateName +|string +|True +a|Destination aggregate name + + +|numOfDisksApprovedToAdd +|integer +|True +a|Maximum number of disks approved to add + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|advancedMode +|boolean +|True +a|Use advanced allocation for destination volume + + +|destinationProviderVolumeType +|string +|False +a|Destination provider volume type + + +|destinationCapacityTier +|string +|False +a|Destination aggregate capacity tier + + +|destinationSvmName +|string +|False +a|Destination SVM name + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-tenants.adoc b/cvo/post-tenants.adoc new file mode 100644 index 00000000..ec5f4b13 --- /dev/null +++ b/cvo/post-tenants.adoc @@ -0,0 +1,203 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-tenants.html' +summary: 'Create a new tenant' +--- + += Create a new tenant + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenants`# + + + +Creates a new tenant. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Tenant name + + +|description +|string +|False +a|Tenant description + + +|costCenter +|string +|False +a|Tenant cost center + + +|nssKeys +|link:#SetNssKeysRequest[SetNssKeysRequest] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "description": "string", + "costCenter": "string", + "nssKeys": { + "nssUserName": "string", + "nssPassword": "string" + } +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|publicId +|string +|False +a| + +|workingEnvironmentsInformation +|link:#WorkingEnvironmentsInformation[WorkingEnvironmentsInformation] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "publicId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SetNssKeysRequest] +[.api-collapsible-fifth-title] +SetNssKeysRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nssUserName +|string +|False +a|NetApp Support Site user name + + +|nssPassword +|string +|False +a|NetApp Support Site password + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#WorkingEnvironmentsInformation] +[.api-collapsible-fifth-title] +WorkingEnvironmentsInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionsCount +|integer +|False +a|Number of regions for which systems exist over this tenant + + +|totalReservedSize +|link:#Capacity[Capacity] +|False +a| + +|workingEnvironmentsCount +|integer +|False +a|Number of systems created over this tenant + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-users-add-user.adoc b/cvo/post-users-add-user.adoc new file mode 100644 index 00000000..e007fa18 --- /dev/null +++ b/cvo/post-users-add-user.adoc @@ -0,0 +1,260 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-users-add-user.html' +summary: 'Add a NetApp Cloud Central user to NetApp Console' +--- + += Add a NetApp Cloud Central user to NetApp Console + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/users/add-user`# + + + +Adds an existing NetApp Cloud Central user to the NetApp Console. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|email +|string +|False +a|User email address + + +|roleId +|string +|True +a|Role ID of the user + + +|tenantId +|string +|False +a|Tenant ID of the user + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "email": "string", + "roleId": "string", + "tenantId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|User public ID + + +|assignedWorkingEnvironments +|array[string] +|True +a|List of public IDs for all of the systems visible to the user + + +|firstName +|string +|True +a|The first name of the user + + +|lastName +|string +|True +a|The last name of the user + + +|email +|string +|True +a|The email address of the user + + +|roleId +|string +|True +a|Role ID of the user + + +|tenantId +|string +|True +a|Tenant ID of the user + + +|createdWorkingEnvironments +|array[link:#UserWorkingEnvironmentResponse[UserWorkingEnvironmentResponse]] +|True +a|List of all systems created by the user + + +|azureCredentials +|link:#AzureCredentials[AzureCredentials] +|False +a| + +|cloudSyncLicenseInformation +|link:#CloudSyncLicenseInformation[CloudSyncLicenseInformation] +|False +a| + +|isLdap +|boolean +|True +a|Indicates whether the user is an LDAP user + + +|ldapUserName +|string +|True +a|The LDAP user name + + +|notificationsOptIn +|boolean +|True +a|Notification Opt-In + + +|permissions +|array[string] +|True +a|Permissions + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#UserWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +UserWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|System public ID + + +|name +|string +|True +a|System name + + +|workingEnvironmentType +|string +|True +a|System type + + +|=== + + +[#AzureCredentials] +[.api-collapsible-fifth-title] +AzureCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|False +a| + +|tenantId +|string +|False +a| + +|applicationId +|string +|False +a| + +|applicationKey +|string +|False +a| + +|=== + + +[#CloudSyncLicenseInformation] +[.api-collapsible-fifth-title] +CloudSyncLicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudSyncLicenseTypes +|array[string] +|False +a|Cloud sync license types + + +|licenseExpirationDate +|integer +|False +a|Cloud sync license expiration date + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-users-working-environments-grant-revoke.adoc b/cvo/post-users-working-environments-grant-revoke.adoc new file mode 100644 index 00000000..c0e1777f --- /dev/null +++ b/cvo/post-users-working-environments-grant-revoke.adoc @@ -0,0 +1,81 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-users-working-environments-grant-revoke.html' +summary: 'Grant or revoke permissions to a user' +--- + += Grant or revoke permissions to a user + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/users/{userId}/working-environments-grant-revoke`# + + + +Grants or revokes permissions to the specified user for performing operations over the specified systems. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|userId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|addWorkingEnvironments +|array[string] +|True +a|List of system public IDs for which permissions should be added + + +|removeWorkingEnvironments +|array[string] +|True +a|List of system public IDs for which permissions should be removed + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "addWorkingEnvironments": [ + "string" + ], + "removeWorkingEnvironments": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-users.adoc b/cvo/post-users.adoc new file mode 100644 index 00000000..ec625bb2 --- /dev/null +++ b/cvo/post-users.adoc @@ -0,0 +1,346 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-users.html' +summary: 'Create a new user' +--- + += Create a new user + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/users`# + + + +Creates a new user. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|firstName +|string +|False +a|The first name of the user + + +|lastName +|string +|False +a|The last name of the user + + +|email +|string +|False +a|The email address of the user + + +|roleId +|string +|True +a|Role ID of the user + + +|tenantId +|string +|False +a|Tenant ID of the user + + +|password +|string +|False +a|User password + + +|accessKey +|string +|False +a|The AWS access key of the user + + +|secretKey +|string +|False +a|The AWS secret key of the user + + +|s3Bucket +|string +|False +a|The AWS S3 bucket of the user + + +|azureCredentials +|link:#AzureCredentialsRequest[AzureCredentialsRequest] +|False +a| + +|isLdap +|boolean +|True +a|Indicates whether the user is an LDAP user + + +|ldapUserName +|string +|False +a|The LDAP user name + + +|notificationsOptIn +|boolean +|False +a|Email notifications opt-in + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|User public ID + + +|assignedWorkingEnvironments +|array[string] +|True +a|List of public IDs for all of the systems visible to the user + + +|firstName +|string +|True +a|The first name of the user + + +|lastName +|string +|True +a|The last name of the user + + +|email +|string +|True +a|The email address of the user + + +|roleId +|string +|True +a|Role ID of the user + + +|tenantId +|string +|True +a|Tenant ID of the user + + +|createdWorkingEnvironments +|array[link:#UserWorkingEnvironmentResponse[UserWorkingEnvironmentResponse]] +|True +a|List of all systems created by the user + + +|azureCredentials +|link:#AzureCredentials[AzureCredentials] +|False +a| + +|cloudSyncLicenseInformation +|link:#CloudSyncLicenseInformation[CloudSyncLicenseInformation] +|False +a| + +|isLdap +|boolean +|True +a|Indicates whether the user is an LDAP user + + +|ldapUserName +|string +|True +a|The LDAP user name + + +|notificationsOptIn +|boolean +|True +a|Notification Opt-In + + +|permissions +|array[string] +|True +a|Permissions + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AzureCredentialsRequest] +[.api-collapsible-fifth-title] +AzureCredentialsRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|False +a|The subscription ID + + +|tenantId +|string +|False +a|The tenant ID + + +|applicationId +|string +|False +a|The application ID + + +|applicationKey +|string +|False +a|The application key + + +|=== + + +[#UserWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +UserWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|System public ID + + +|name +|string +|True +a|System name + + +|workingEnvironmentType +|string +|True +a|System type + + +|=== + + +[#AzureCredentials] +[.api-collapsible-fifth-title] +AzureCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|False +a| + +|tenantId +|string +|False +a| + +|applicationId +|string +|False +a| + +|applicationKey +|string +|False +a| + +|=== + + +[#CloudSyncLicenseInformation] +[.api-collapsible-fifth-title] +CloudSyncLicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudSyncLicenseTypes +|array[string] +|False +a|Cloud sync license types + + +|licenseExpirationDate +|integer +|False +a|Cloud sync license expiration date + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-vsa-aggregates--add-capacity.adoc b/cvo/post-vsa-aggregates--add-capacity.adoc new file mode 100644 index 00000000..aed65058 --- /dev/null +++ b/cvo/post-vsa-aggregates--add-capacity.adoc @@ -0,0 +1,101 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-aggregates--add-capacity.html' +summary: 'Add the capacity to an existing elastic volume aggregate' +--- + += Add the capacity to an existing elastic volume aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/add-capacity`# + + + +Adds capacity to an existing elastic volume aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityToAdd +|link:#Capacity[Capacity] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-vsa-aggregates--disks.adoc b/cvo/post-vsa-aggregates--disks.adoc new file mode 100644 index 00000000..e49a4aae --- /dev/null +++ b/cvo/post-vsa-aggregates--disks.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-aggregates--disks.html' +summary: 'Add disks to an existing aggregate' +--- + += Add disks to an existing aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks`# + + + +Adds disks to an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|True +a|Number of disks + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-aggregates.adoc b/cvo/post-vsa-aggregates.adoc new file mode 100644 index 00000000..0e951daf --- /dev/null +++ b/cvo/post-vsa-aggregates.adoc @@ -0,0 +1,137 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-aggregates.html' +summary: 'Create a new aggregate' +--- + += Create a new aggregate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/aggregates`# + + + +Creates a new aggregate. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|workingEnvironmentId +|string +|True +a| + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|initialEvAggregateSize +|link:#Capacity[Capacity] +|False +a| + +|homeNode +|string +|False +a| + +|providerVolumeType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "workingEnvironmentId": "string", + "homeNode": "string", + "providerVolumeType": "string", + "capacityTier": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-vsa-encryption-key-managers-.adoc b/cvo/post-vsa-encryption-key-managers-.adoc new file mode 100644 index 00000000..fc4dcd3a --- /dev/null +++ b/cvo/post-vsa-encryption-key-managers-.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-encryption-key-managers-.html' +summary: 'Add a key manager' +--- + += Add a key manager + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}`# + + + +Adds a key manager to the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|keyManagerIp +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-encryption-update-client-certificate.adoc b/cvo/post-vsa-encryption-update-client-certificate.adoc new file mode 100644 index 00000000..ac542df4 --- /dev/null +++ b/cvo/post-vsa-encryption-update-client-certificate.adoc @@ -0,0 +1,92 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-encryption-update-client-certificate.html' +summary: 'Update the client certificate' +--- + += Update the client certificate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/encryption/{workingEnvironmentId}/update-client-certificate`# + + + +Updates the client certificate on the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + diff --git a/cvo/post-vsa-encryption-update-key-manager-ca-certificate.adoc b/cvo/post-vsa-encryption-update-key-manager-ca-certificate.adoc new file mode 100644 index 00000000..a1cae0f4 --- /dev/null +++ b/cvo/post-vsa-encryption-update-key-manager-ca-certificate.adoc @@ -0,0 +1,120 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-encryption-update-key-manager-ca-certificate.html' +summary: 'Update the key manager CA certificate' +--- + += Update the key manager CA certificate + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/encryption/{workingEnvironmentId}/update-key-manager-ca-certificate`# + + + +Updates the key manager certificate authority (CA) certificate on the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|keyManagerCaCertificateId +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "keyManagerCaCertificateId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + diff --git a/cvo/post-vsa-metadata-create-bucket.adoc b/cvo/post-vsa-metadata-create-bucket.adoc new file mode 100644 index 00000000..803e961a --- /dev/null +++ b/cvo/post-vsa-metadata-create-bucket.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-metadata-create-bucket.html' +summary: 'Create a new S3 bucket' +--- + += Create a new S3 bucket + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/metadata/create-bucket`# + + + +Creates a new S3 bucket. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|region +|string +|query +|False +a| + +|bucketName +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-metadata-get-buckets-application-info.adoc b/cvo/post-vsa-metadata-get-buckets-application-info.adoc new file mode 100644 index 00000000..a9c09c31 --- /dev/null +++ b/cvo/post-vsa-metadata-get-buckets-application-info.adoc @@ -0,0 +1,90 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-metadata-get-buckets-application-info.html' +summary: 'Retrieve S3 buckets policy status and tiering level' +--- + += Retrieve S3 buckets policy status and tiering level + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/metadata/get-buckets-application-info`# + + + +Retrieves the S3 buckets policy status and tiering level. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|buckets +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "buckets": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|bucketName +|string +|True +a| + +|tieringLevel +|string +|False +a| + +|accessData +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "bucketName": "string", + "tieringLevel": "string", + "accessData": "string" +} +==== + diff --git a/cvo/post-vsa-metadata-validate-subscribed-to-ontap-cloud.adoc b/cvo/post-vsa-metadata-validate-subscribed-to-ontap-cloud.adoc new file mode 100644 index 00000000..d9b22db7 --- /dev/null +++ b/cvo/post-vsa-metadata-validate-subscribed-to-ontap-cloud.adoc @@ -0,0 +1,181 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-metadata-validate-subscribed-to-ontap-cloud.html' +summary: 'Comfirm that the current user is subscribed' +--- + += Comfirm that the current user is subscribed + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/metadata/validate-subscribed-to-ontap-cloud`# + + + +Validates that the current user is subscribed to the Cloud Volumes ONTAP product in Amazon marketplace. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|True +a| + +|subnetId +|string +|False +a| + +|vsaMetadata +|link:#VsaMetadataRequest[VsaMetadataRequest] +|True +a| + +|roleArn +|string +|False +a| + +|cloudProviderAccount +|string +|False +a| + +|securityGroupId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": "string", + "subnetId": "string", + "vsaMetadata": { + "ontapVersion": "string", + "licenseType": "string", + "instanceType": "string", + "platformSerialNumber": "string", + "providedLicense": "string", + "capacityPackageName": "string", + "keyStoneSubscription": "string" + }, + "roleArn": "string", + "cloudProviderAccount": "string", + "securityGroupId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|failureInfo +|string +|False +a| + +|isSubscribed +|boolean +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#VsaMetadataRequest] +[.api-collapsible-fifth-title] +VsaMetadataRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a|ONTAP version + + +|licenseType +|string +|True +a|License type + + +|instanceType +|string +|True +a|Instance type + + +|platformSerialNumber +|string +|False +a|Optional platform serial number + + +|providedLicense +|string +|False +a|Optional provided license + + +|capacityPackageName +|string +|False +a|Optional capacity-based package + + +|keyStoneSubscription +|string +|False +a|Keystone subscription ID + + +|useLatestVersion +|boolean +|False +a|Use the latest version + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-vsa-recover.adoc b/cvo/post-vsa-recover.adoc new file mode 100644 index 00000000..8c527cc4 --- /dev/null +++ b/cvo/post-vsa-recover.adoc @@ -0,0 +1,3281 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-recover.html' +summary: 'Save a previously discovered Cloud Volumes ONTAP system' +--- + += Save a previously discovered Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/recover`# + + + +Saves a previously discovered Cloud Volumes ONTAP system to the NetApp Console database. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|region +|string +|True +a| + +|stackId +|string +|False +a| + +|clusterCredentials +|link:#ClusterCredentialsRequest[ClusterCredentialsRequest] +|True +a| + +|tenantId +|string +|False +a| + +|providerAccount +|string +|False +a|Role ARN to assume + + +|cloudProviderAccount +|string +|False +a|Cloud provider account + + +|nssAccountId +|string +|False +a|NetApp Support Site (NSS) account + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "region": "string", + "stackId": "string", + "clusterCredentials": { + "userName": "string", + "password": "string" + }, + "tenantId": "string", + "providerAccount": "string", + "cloudProviderAccount": "string", + "nssAccountId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|awsProperties +|link:#AwsProperties[AwsProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|interClusterLifs +|array[link:#InterClusterLif[InterClusterLif]] +|True +a| + +|cronJobSchedules +|array[link:#CronJobSchedule[CronJobSchedule]] +|True +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|cloudProviderName +|string +|False +a| + +|isHA +|boolean +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|haProperties +|link:#AwsHaProperties[AwsHaProperties] +|False +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|cloudSyncProperties +|link:#CloudSyncProperties[CloudSyncProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#ClusterCredentialsRequest] +[.api-collapsible-fifth-title] +ClusterCredentialsRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|userName +|string +|True +a| + +|password +|string +|False +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags + +Instance tags + +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#InstanceResponse] +[.api-collapsible-fifth-title] +InstanceResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Instance ID + + +|name +|string +|True +a|Instance name + + +|instanceType +|string +|True +a|Instance type + + +|state +|string +|True +a|Instance state + + +|publicIpAddress +|string +|True +a|Public IP address that is assigned to the instance + + +|privateIpAddress +|string +|True +a|Private IP address that is assigned to the instance + + +|publicDnsName +|string +|True +a|Public DNS + + +|privateDnsName +|string +|True +a|Private DNS name + + +|imageId +|string +|True +a|Image ID + + +|subnetId +|string +|True +a|Subnet ID + + +|availabilityZone +|string +|True +a|Availability zone + + +|isVsaInstance +|boolean +|True +a|Indicates if the instance is a Cloud Volumes ONTAP instance + + +|isOCCMInstance +|boolean +|True +a|Indicates if the instance is a NetApp Console instance + + +|tags +|link:#tags[tags] +|True +a|Instance tags + + +|productCode +|string +|True +a|Product code + + +|tenancy +|string +|True +a|Instance Tenancy + + +|placementGroup +|string +|True +a|Placement group + + +|keyPairName +|string +|True +a|Key pair + + +|instanceProfileId +|string +|False +a|Instance profile ID + + +|=== + + +[#VpcTagResponse] +[.api-collapsible-fifth-title] +VpcTagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|VPC tag key + + +|value +|string +|True +a|VPC tag value + + +|=== + + +[#VpcBasicResponse] +[.api-collapsible-fifth-title] +VpcBasicResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|True +a|The VPC identifier + + +|state +|string +|True +a|The state of the VPC + + +|cidrBlock +|string +|True +a|VPC Classless Inter-Domain Routing (CIDR) block + + +|tags +|array[link:#VpcTagResponse[VpcTagResponse]] +|True +a|VPC tags + + +|default +|boolean +|True +a|Indicates whether the VPC is the default + + +|=== + + +[#bootDiskSize] +[.api-collapsible-fifth-title] +bootDiskSize + + +[#coreDiskExists] +[.api-collapsible-fifth-title] +coreDiskExists + + +[#AwsProperties] +[.api-collapsible-fifth-title] +AwsProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|availabilityZones +|array[string] +|False +a| + +|instances +|array[link:#InstanceResponse[InstanceResponse]] +|False +a| + +|vpc +|link:#VpcBasicResponse[VpcBasicResponse] +|False +a| + +|accountId +|string +|False +a| + +|roleArn +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|bootDiskSize +|link:#bootDiskSize[bootDiskSize] +|False +a| + +|outpostArn +|string +|False +a| + +|coreDiskExists +|link:#coreDiskExists[coreDiskExists] +|False +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#InterClusterLif] +[.api-collapsible-fifth-title] +InterClusterLif + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|port +|string +|False +a| + +|node +|string +|False +a| + +|status +|string +|False +a| + +|isPeered +|boolean +|False +a| + +|=== + + +[#CronJobSchedule] +[.api-collapsible-fifth-title] +CronJobSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|description +|string +|False +a| + +|months +|array[string] +|True +a| + +|days +|array[string] +|False +a| + +|weekDays +|array[string] +|False +a| + +|hours +|array[string] +|False +a| + +|minutes +|array[string] +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MediatorVersionInfo] +[.api-collapsible-fifth-title] +MediatorVersionInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|version +|string +|False +a| + +|description +|string +|False +a| + +|state +|string +|True +a| + +|bootVolumeId +|string +|False +a| + +|=== + + +[#MediatorStatus] +[.api-collapsible-fifth-title] +MediatorStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|statusCode +|integer +|False +a| + +|statusMessage +|string +|False +a| + +|=== + + +[#MediatorUpdateVersionMetadata] +[.api-collapsible-fifth-title] +MediatorUpdateVersionMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersion +|string +|False +a| + +|timeStamp +|integer +|False +a| + +|metadataFileName +|string +|False +a| + +|major +|boolean +|False +a| + +|manifestFileName +|string +|False +a| + +|=== + + +[#AwsHaProperties] +[.api-collapsible-fifth-title] +AwsHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersionInfo +|link:#MediatorVersionInfo[MediatorVersionInfo] +|False +a| + +|mediatorStatus +|link:#MediatorStatus[MediatorStatus] +|False +a| + +|routeTables +|array[string] +|False +a| + +|mediatorVersionsToUpdate +|array[link:#MediatorUpdateVersionMetadata[MediatorUpdateVersionMetadata]] +|False +a| + +|failoverMode +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#CloudSyncStatus] +[.api-collapsible-fifth-title] +CloudSyncStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#DataBrokerPlacement] +[.api-collapsible-fifth-title] +DataBrokerPlacement + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|False +a| + +|subnetId +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|keyPair +|string +|False +a| + +|=== + + +[#DataBrokerProperties] +[.api-collapsible-fifth-title] +DataBrokerProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|dataBrokerPlacement +|link:#DataBrokerPlacement[DataBrokerPlacement] +|False +a| + +|=== + + +[#CloudSyncRelationship] +[.api-collapsible-fifth-title] +CloudSyncRelationship + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|relationshipStatus +|string +|False +a| + +|s3Location +|string +|False +a| + +|id +|string +|False +a| + +|progress +|integer +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#CloudSyncProperties] +[.api-collapsible-fifth-title] +CloudSyncProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSynced +|boolean +|False +a| + +|status +|link:#CloudSyncStatus[CloudSyncStatus] +|False +a| + +|dataBrokerProperties +|link:#DataBrokerProperties[DataBrokerProperties] +|False +a| + +|s3Location +|string +|False +a| + +|relationships +|array[link:#CloudSyncRelationship[CloudSyncRelationship]] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-vsa-volumes--change-tier.adoc b/cvo/post-vsa-volumes--change-tier.adoc new file mode 100644 index 00000000..c9f67b8c --- /dev/null +++ b/cvo/post-vsa-volumes--change-tier.adoc @@ -0,0 +1,229 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-volumes--change-tier.html' +summary: 'Update the underlying volume tier' +--- + += Update the underlying volume tier + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier`# + + + +Updates the underlying volume tier. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Target aggregate name + + +|numOfDisks +|integer +|True +a|Number of new disks needed + + +|newAggregate +|boolean +|True +a|Indicates if it is a newly created aggregate + + +|newDiskTypeName +|string +|True +a|New disk type name + + +|newCapacityTier +|string +|False +a|New capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|newTieringPolicy +|string +|False +a|New tiering policy + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-vsa-volumes--clone.adoc b/cvo/post-vsa-volumes--clone.adoc new file mode 100644 index 00000000..b057cda3 --- /dev/null +++ b/cvo/post-vsa-volumes--clone.adoc @@ -0,0 +1,89 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-volumes--clone.html' +summary: 'Clone an existing volume' +--- + += Clone an existing volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone`# + + + +Clones an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newVolumeName +|string +|True +a|New volume name + + +|parentSnapshot +|string +|False +a|Snapshot name to use for the clone + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "newVolumeName": "string", + "parentSnapshot": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-volumes--move.adoc b/cvo/post-vsa-volumes--move.adoc new file mode 100644 index 00000000..75f05c74 --- /dev/null +++ b/cvo/post-vsa-volumes--move.adoc @@ -0,0 +1,203 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-volumes--move.html' +summary: 'Move an existing volume' +--- + += Move an existing volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move`# + + + +Moves an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|targetAggregateName +|string +|True +a|Target aggregate name + + +|numOfDisksToAdd +|integer +|True +a|Target aggregate number of disks to add + + +|createTargetAggregate +|boolean +|True +a|Specifies if the aggregate is a new target aggregate + + +|newDiskTypeName +|string +|False +a|New disk type for the volume + + +|newCapacityTier +|string +|False +a|New capacity tier + + +|newTieringPolicy +|string +|False +a|New tiering policy + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-vsa-volumes--snapshot.adoc b/cvo/post-vsa-volumes--snapshot.adoc new file mode 100644 index 00000000..ee01628c --- /dev/null +++ b/cvo/post-vsa-volumes--snapshot.adoc @@ -0,0 +1,82 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-volumes--snapshot.html' +summary: 'Create a snapshot' +--- + += Create a snapshot + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot`# + + + +Creates a snapshot manually. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotName +|string +|False +a|Snapshot name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-volumes-initiator.adoc b/cvo/post-vsa-volumes-initiator.adoc new file mode 100644 index 00000000..f65363b7 --- /dev/null +++ b/cvo/post-vsa-volumes-initiator.adoc @@ -0,0 +1,59 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-volumes-initiator.html' +summary: 'Add an iSCSI initiator' +--- + += Add an iSCSI initiator + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/volumes/initiator`# + + + +Adds an iSCSI initiator. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aliasName +|string +|True +a|Initiator alias + + +|iqn +|string +|True +a|Initiator IQN + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aliasName": "string", + "iqn": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-volumes-quote.adoc b/cvo/post-vsa-volumes-quote.adoc new file mode 100644 index 00000000..05d59880 --- /dev/null +++ b/cvo/post-vsa-volumes-quote.adoc @@ -0,0 +1,285 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-volumes-quote.html' +summary: 'Retrieve quotes for a new volume' +--- + += Retrieve quotes for a new volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/volumes/quote`# + + + +Retrieves quotes for a new volume. Returns the resource quote required for the requested volume. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|True +a|Cloud Volumes ONTAP system ID + + +|svmName +|string +|True +a|SVM name + + +|aggregateName +|string +|False +a|Optionally choose in which aggregate to create the volume + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|enableThinProvisioning +|boolean +|True +a|Enable thin provisioning on the volume + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|verifyNameUniqueness +|boolean +|True +a|Verify volume name uniqueness within the SVM + + +|capacityTier +|string +|False +a|Capacity tier + + +|isReplicationFlow +|boolean +|True +a|Is replication flow + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|aggregateName +|string +|True +a|The aggregate on which the requested volume will be created + + +|newAggregate +|boolean +|True +a|Is it a newly created aggregate + + +|autoVsaCapacityManagement +|boolean +|True +a|Indicates if automatic Cloud Volumes ONTAP capacity management is enabled + + +|elasticVolumeQuoteResponse +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-vsa-volumes.adoc b/cvo/post-vsa-volumes.adoc new file mode 100644 index 00000000..11470724 --- /dev/null +++ b/cvo/post-vsa-volumes.adoc @@ -0,0 +1,610 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-volumes.html' +summary: 'Create a new volume' +--- + += Create a new volume + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/volumes`# + + + +Creates a new volume. If the aggregateName and maxNumOfDisksApprovedToAdd properties are not populated, the response fails with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|createAggregateIfNotFound +|boolean +|query +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workingEnvironmentId +|string +|True +a|Cloud Volumes ONTAP system ID + + +|svmName +|string +|True +a|SVM name + + +|aggregateName +|string +|True +a|Aggregate in which the volume will be created + + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|True +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|True +a|Snapshot policy name + + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|iscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableThinProvisioning +|boolean +|True +a|Enable thin provisioning on the volume + + +|enableCompression +|boolean +|True +a|Enable compression on the volume + + +|enableDeduplication +|boolean +|True +a|Enable deduplication on the volume + + +|maxNumOfDisksApprovedToAdd +|integer +|True +a|Maximum number of disks approved to allocate + + +|evCapacityApprovedToAdd +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|providerVolumeType +|string +|False +a|Provider volume type + + +|syncToS3 +|boolean +|True +a|Add a cloud sync relationship + + +|capacityTier +|string +|False +a|Capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|junctionPath +|string +|False +a|Junction path + + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|minimumCoolingDays +|link:#minimumCoolingDays[minimumCoolingDays] +|False +a|Cooling Days + + +|volumeTags +|array[link:#VolumeTags[VolumeTags]] +|True +a|Optionally, provide key-value pairs with which to tag the ONTAP volume using the App Template service. + + +|comment +|string +|False +a|Volume Comment + + +|flexGroupVolumeInfo +|link:#FlexGroupVolumeInfo[FlexGroupVolumeInfo] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#minimumCoolingDays] +[.api-collapsible-fifth-title] +minimumCoolingDays + +Cooling Days + + + +[#VolumeTags] +[.api-collapsible-fifth-title] +VolumeTags + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|False +a| + +|tagValue +|string +|False +a| + +|=== + + +[#FlexGroupVolumeInfo] +[.api-collapsible-fifth-title] +FlexGroupVolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateList +|array[string] +|False +a|Names of aggregates for the FlexGroup volume + + +|numberOfConstituents +|integer +|False +a|Number of constituents for the FlexGroup volume + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-vsa-working-environments-change-serial.adoc b/cvo/post-vsa-working-environments-change-serial.adoc new file mode 100644 index 00000000..78295ba7 --- /dev/null +++ b/cvo/post-vsa-working-environments-change-serial.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-change-serial.html' +summary: 'Update the serial number of Cloud Volumes ONTAP' +--- + += Update the serial number of Cloud Volumes ONTAP + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/change-serial`# + + + +Updates the serial number of a Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodeOne +|string +|True +a| + +|nodeTwo +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nodeOne": "string", + "nodeTwo": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-working-environments-change-tier-level.adoc b/cvo/post-vsa-working-environments-change-tier-level.adoc new file mode 100644 index 00000000..0dbe5eaf --- /dev/null +++ b/cvo/post-vsa-working-environments-change-tier-level.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-change-tier-level.html' +summary: 'Modify the tier level' +--- + += Modify the tier level + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/change-tier-level`# + + + +Updates the tier level. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|level +|string +|True +a|Update tier level + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "level": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-working-environments-cifs.adoc b/cvo/post-vsa-working-environments-cifs.adoc new file mode 100644 index 00000000..46139639 --- /dev/null +++ b/cvo/post-vsa-working-environments-cifs.adoc @@ -0,0 +1,121 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-cifs.html' +summary: 'Set up a new CIFS configuration' +--- + += Set up a new CIFS configuration + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/cifs`# + + + +Sets up a new CIFS configuration for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|False +a|DNS domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|activeDirectoryUsername +|string +|True +a|Active Directory username + + +|activeDirectoryPassword +|string +|True +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "dnsDomain": "string", + "ipAddresses": [ + "string" + ], + "netBIOS": "string", + "organizationalUnit": "string", + "activeDirectoryDomain": "string", + "activeDirectoryUsername": "string", + "activeDirectoryPassword": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-working-environments-delete-cifs.adoc b/cvo/post-vsa-working-environments-delete-cifs.adoc new file mode 100644 index 00000000..7e49fd5f --- /dev/null +++ b/cvo/post-vsa-working-environments-delete-cifs.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-delete-cifs.html' +summary: 'Delete the CIFS configuration for a system' +--- + += Delete the CIFS configuration for a system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/delete-cifs`# + + + +Deletes the CIFS configuration of an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|activeDirectoryUsername +|string +|False +a|Active Directory username + + +|activeDirectoryPassword +|string +|False +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "activeDirectoryUsername": "string", + "activeDirectoryPassword": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-working-environments-enable-capacity-tiering.adoc b/cvo/post-vsa-working-environments-enable-capacity-tiering.adoc new file mode 100644 index 00000000..b4737172 --- /dev/null +++ b/cvo/post-vsa-working-environments-enable-capacity-tiering.adoc @@ -0,0 +1,81 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-enable-capacity-tiering.html' +summary: 'Enable capacity tiering' +--- + += Enable capacity tiering + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering`# + + + +Enables capacity tiering. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceProfileName +|string +|False +a| + +|gcpStorageAccountId +|string +|False +a| + +|storageAccountPrefix +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceProfileName": "string", + "gcpStorageAccountId": "string", + "storageAccountPrefix": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-working-environments-extra-capacity-licenses.adoc b/cvo/post-vsa-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..19f7ea1d --- /dev/null +++ b/cvo/post-vsa-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-extra-capacity-licenses.html' +summary: 'Register extra capacity licenses' +--- + += Register extra capacity licenses + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Registers an extra capacity license. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licences +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licences": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-working-environments-extra-capacity-serials.adoc b/cvo/post-vsa-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..1c88a343 --- /dev/null +++ b/cvo/post-vsa-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-extra-capacity-serials.html' +summary: 'Register extra capacity serial numbers' +--- + += Register extra capacity serial numbers + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Registers an extra capacity serial number. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-working-environments-ntp.adoc b/cvo/post-vsa-working-environments-ntp.adoc new file mode 100644 index 00000000..ebf8ffa8 --- /dev/null +++ b/cvo/post-vsa-working-environments-ntp.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-ntp.html' +summary: 'Set up an NTP server' +--- + += Set up an NTP server + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/ntp`# + + + +Sets up an NTP server. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ntpServer +|string +|True +a|NTPS server + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "ntpServer": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-working-environments-parse-license-file.adoc b/cvo/post-vsa-working-environments-parse-license-file.adoc new file mode 100644 index 00000000..4c72fdd4 --- /dev/null +++ b/cvo/post-vsa-working-environments-parse-license-file.adoc @@ -0,0 +1,232 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-parse-license-file.html' +summary: 'Parse an uploaded cloud license file' +--- + += Parse an uploaded cloud license file + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/parse-license-file`# + + + +Parses an uploaded cloud license file. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|license +|string +|True +a| + +|serialNumber +|string +|False +a| + +|contractEndDate +|link:#contractEndDate[contractEndDate] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "license": "string", + "serialNumber": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +[#contractEndDate] +[.api-collapsible-fifth-title] +contractEndDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-vsa-working-environments-snapshot-policy.adoc b/cvo/post-vsa-working-environments-snapshot-policy.adoc new file mode 100644 index 00000000..1029fb28 --- /dev/null +++ b/cvo/post-vsa-working-environments-snapshot-policy.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-snapshot-policy.html' +summary: 'Create a snapshot policy' +--- + += Create a snapshot policy + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/snapshot-policy`# + + + +Creates a snapshot policy. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|schedules +|array[link:#SnapshotPolicyScheduleRequest[SnapshotPolicyScheduleRequest]] +|True +a|Snapshot policy schedules + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "schedules": [ + {} + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#SnapshotPolicyScheduleRequest] +[.api-collapsible-fifth-title] +SnapshotPolicyScheduleRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scheduleType +|string +|True +a|Snapshot policy schedule type + + +|retention +|integer +|True +a|Snapshot policy retention + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-vsa-working-environments-start.adoc b/cvo/post-vsa-working-environments-start.adoc new file mode 100644 index 00000000..a5c2fa8a --- /dev/null +++ b/cvo/post-vsa-working-environments-start.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-start.html' +summary: 'Start a specific Cloud Volumes ONTAP instance' +--- + += Start a specific Cloud Volumes ONTAP instance + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/start`# + + + +Starts a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-working-environments-stop.adoc b/cvo/post-vsa-working-environments-stop.adoc new file mode 100644 index 00000000..1d26fb32 --- /dev/null +++ b/cvo/post-vsa-working-environments-stop.adoc @@ -0,0 +1,47 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-stop.html' +summary: 'Stop a specific Cloud Volumes ONTAP instance' +--- + += Stop a specific Cloud Volumes ONTAP instance + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/stop`# + + + +Stops a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|takeSnapshots +|boolean +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-working-environments-support-registration.adoc b/cvo/post-vsa-working-environments-support-registration.adoc new file mode 100644 index 00000000..28ecf7c8 --- /dev/null +++ b/cvo/post-vsa-working-environments-support-registration.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-support-registration.html' +summary: 'Register a Cloud Volumes ONTAP system' +--- + += Register a Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/support-registration`# + + + +Registers a Cloud Volumes ONTAP system with NetApp. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|nssAccountId +|string +|query +|False +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|True +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|licenseStartDate +|link:#licenseStartDate[licenseStartDate] +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "nssAccountId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#licenseStartDate] +[.api-collapsible-fifth-title] +licenseStartDate + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-vsa-working-environments-sync-subscription.adoc b/cvo/post-vsa-working-environments-sync-subscription.adoc new file mode 100644 index 00000000..cfb3111c --- /dev/null +++ b/cvo/post-vsa-working-environments-sync-subscription.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-sync-subscription.html' +summary: 'Trigger subscription synchronization' +--- + += Trigger subscription synchronization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/sync-subscription`# + + + +Manually triggers subscription synchronization for all Cloud Volumes ONTAP systems. + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-working-environments-update-image.adoc b/cvo/post-vsa-working-environments-update-image.adoc new file mode 100644 index 00000000..2dfe6267 --- /dev/null +++ b/cvo/post-vsa-working-environments-update-image.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-update-image.html' +summary: 'Perform a complete image update' +--- + += Perform a complete image update + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/update-image`# + + + +Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|updateType +|string +|True +a|System update type. System updates can be performed by providing either an external URL that ONTAP will use to download the image file or a name of an image provided by the NetApp Console. + + +|updateParameter +|string +|True +a|Parameter specific to the specified update type. External file URL or the NetApp Console provided image name. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "updateType": "string", + "updateParameter": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-working-environments-upload-license-file.adoc b/cvo/post-vsa-working-environments-upload-license-file.adoc new file mode 100644 index 00000000..311b743e --- /dev/null +++ b/cvo/post-vsa-working-environments-upload-license-file.adoc @@ -0,0 +1,197 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-upload-license-file.html' +summary: 'Upload a cloud license file' +--- + += Upload a cloud license file + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/upload-license-file`# + + + +Uploads a cloud license file on the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|filename +|string +|header +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|formData +|link:#formData[formData] +|True +a| + +|formDataMap +|link:#formDataMap[formDataMap] +|True +a| + +|preamble +|string +|False +a| + +|parts +|array[link:#InputPart[InputPart]] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#parameters] +[.api-collapsible-fifth-title] +parameters +Hash mapping strings to string + +[#mediaType] +[.api-collapsible-fifth-title] +mediaType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|subtype +|string +|False +a| + +|parameters +|link:#parameters[parameters] +|True +a| + +|wildcardSubtype +|boolean +|False +a| + +|wildcardType +|boolean +|False +a| + +|=== + + +[#headers] +[.api-collapsible-fifth-title] +headers +Hash mapping strings to array[string] +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|empty +|boolean +|False +a| + +|=== + + +[#InputPart] +[.api-collapsible-fifth-title] +InputPart + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contentTypeFromMessage +|boolean +|True +a| + +|mediaType +|link:#mediaType[mediaType] +|True +a| + +|bodyAsString +|string +|False +a| + +|headers +|link:#headers[headers] +|True +a| + +|=== + + +[#formData] +[.api-collapsible-fifth-title] +formData +Hash mapping strings to link:#InputPart[InputPart] + +[#formDataMap] +[.api-collapsible-fifth-title] +formDataMap +Hash mapping strings to array[link:#InputPart[InputPart]] + +//end collapsible .Definitions block +==== diff --git a/cvo/post-vsa-working-environments-upload-licenses.adoc b/cvo/post-vsa-working-environments-upload-licenses.adoc new file mode 100644 index 00000000..7a720812 --- /dev/null +++ b/cvo/post-vsa-working-environments-upload-licenses.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments-upload-licenses.html' +summary: 'Upload cloud license file content' +--- + += Upload cloud license file content + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/upload-licenses`# + + + +Uploads the content of a cloud license file on the specified Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licenseOne +|string +|True +a| + +|licenseTwo +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licenseOne": "string", + "licenseTwo": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/post-vsa-working-environments.adoc b/cvo/post-vsa-working-environments.adoc new file mode 100644 index 00000000..f7298239 --- /dev/null +++ b/cvo/post-vsa-working-environments.adoc @@ -0,0 +1,4120 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-vsa-working-environments.html' +summary: 'Create a new Cloud Volumes ONTAP system ' +--- + += Create a new Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/vsa/working-environments`# + + + +Creates a new Cloud Volumes ONTAP system. Refer to the API Developers Guide in order to understand how to populate the values for the region, licenseType, instanceType, and version. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|svmPassword +|string +|False +a| + +|username +|link:#AdminUsername[AdminUsername] +|False +a| + +|vpcId +|string +|True +a| + +|description +|string +|False +a| + +|volume +|link:#VsaVolumeOnNewVsaCreateRequest[VsaVolumeOnNewVsaCreateRequest] +|False +a| + +|region +|string +|False +a| + +|tenantId +|string +|False +a| + +|subnetId +|string +|True +a|Subnet ID for a single node cluster + + +|dataEncryptionType +|string +|True +a|Type of encryption to use for this system + + +|ontapEncryptionParameters +|link:#OntapEncryption[OntapEncryption] +|False +a| + +|awsEncryptionParameters +|link:#AwsEncryption[AwsEncryption] +|False +a| + +|securityGroupId +|string +|False +a| + +|openSecurityGroup +|link:#openSecurityGroup[openSecurityGroup] +|False +a|Open the security group to all IP ranges + + +|vsaMetadata +|link:#VsaMetadataRequest[VsaMetadataRequest] +|True +a| + +|cifsConfigurationRequest +|link:#CIFSConfigurationRequest[CIFSConfigurationRequest] +|False +a| + +|ebsVolumeSize +|link:#Capacity[Capacity] +|True +a| + +|ebsVolumeType +|string +|True +a|EBS volume type + + +|awsTags +|array[link:#AwsTag[AwsTag]] +|True +a|Optionally, provide up to four key-value pairs with which to tag all AWS entities created by the NetApp Console. + + +|writingSpeedState +|string +|False +a|Writing speed state + + +|optimizedNetworkUtilization +|boolean +|False +a|Use optimized network utilization + + +|clusterKeyPairName +|string +|False +a|Support SSH using a key-pair + + +|instanceTenancy +|string +|False +a|Instance tenancy configuration + + +|failedToCreateWorkingEnvironmentId +|string +|False +a|Public ID of the failed-to-create system + + +|capacityTier +|string +|False +a|Capacity tier + + +|iops +|integer +|False +a|Provisioned IOPS + + +|throughput +|integer +|False +a|Provisioned throughput + + +|packageName +|string +|False +a|Pre-configured package name + + +|instanceProfileName +|string +|False +a|Instance profile name + + +|roleArn +|string +|False +a|ARN of an optional role to assume + + +|svmName +|string +|False +a|SVM name + + +|wormRequest +|link:#WormRequest[WormRequest] +|False +a| + +|cloudProviderAccount +|string +|False +a|Cloud provider account + + +|nssAccount +|string +|False +a|NetApp Support Site (NSS) account + + +|saasSubscriptionId +|string +|False +a|SaaS subscription ID + + +|backupVolumesToCbs +|boolean +|False +a|Automatically back up all volumes to Amazon S3 + + +|disableEv +|boolean +|False +a|Disable Elastic Volume + + +|enableCompliance +|boolean +|True +a|Enable compliance + + +|tierLevel +|string +|False +a|Tier Level + + +|enableMonitoring +|boolean +|True +a|Enable monitoring + + +|enableServices +|array[string] +|False +a|Enable services + + +|ontapEncryptionDefined +|boolean +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|name +|string +|False +a| + +|tenantId +|string +|False +a| + +|svmName +|string +|False +a| + +|creatorUserEmail +|string +|False +a| + +|status +|link:#StatusProperties[StatusProperties] +|False +a| + +|awsProperties +|link:#AwsProperties[AwsProperties] +|False +a| + +|reservedSize +|link:#Capacity[Capacity] +|False +a| + +|encryptionProperties +|link:#EncryptionProperties[EncryptionProperties] +|False +a| + +|clusterProperties +|link:#VsaClusterProperties[VsaClusterProperties] +|False +a| + +|ontapClusterProperties +|link:#OntapClusterProperties[OntapClusterProperties] +|False +a| + +|actionsRequired +|array[link:#ActionRequired[ActionRequired]] +|True +a| + +|interClusterLifs +|array[link:#InterClusterLif[InterClusterLif]] +|True +a| + +|cronJobSchedules +|array[link:#CronJobSchedule[CronJobSchedule]] +|True +a| + +|snapshotPolicies +|array[link:#SnapshotPolicy[SnapshotPolicy]] +|True +a| + +|svms +|array[link:#Svm[Svm]] +|True +a| + +|activeActions +|array[string] +|False +a|Actions currently being performed on this system + + +|replicationProperties +|link:#ReplicationProperties[ReplicationProperties] +|False +a| + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|cloudProviderName +|string +|False +a| + +|isHA +|boolean +|True +a| + +|workingEnvironmentType +|string +|False +a| + +|supportRegistrationProperties +|link:#SupportRegistrationProperties[SupportRegistrationProperties] +|False +a| + +|supportRegistrationInformation +|array[link:#SupportRegistrationInformation[SupportRegistrationInformation]] +|True +a| + +|haProperties +|link:#AwsHaProperties[AwsHaProperties] +|False +a| + +|capacityFeatures +|link:#CapacityFeatures[CapacityFeatures] +|False +a| + +|cloudSyncProperties +|link:#CloudSyncProperties[CloudSyncProperties] +|False +a| + +|supportedFeatures +|link:#SupportedFeatures[SupportedFeatures] +|False +a| + +|fpolicyProperties +|link:#FpolicyProperties[FpolicyProperties] +|False +a| + +|saasProperties +|link:#CvoSaasProperties[CvoSaasProperties] +|False +a| + +|cbsProperties +|link:#CbsPropertiesWithReason[CbsPropertiesWithReason] +|False +a| + +|complianceProperties +|link:#CloudComplianceStatusResponse[CloudComplianceStatusResponse] +|False +a| + +|monitoringProperties +|link:#MonitoringStatusResponse[MonitoringStatusResponse] +|False +a| + +|licensesInformation +|array[link:#LicenseInformation[LicenseInformation]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#AdminUsername] +[.api-collapsible-fifth-title] +AdminUsername + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#PositiveCapacity] +[.api-collapsible-fifth-title] +PositiveCapacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#ExportPolicyInfo] +[.api-collapsible-fifth-title] +ExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|policyType +|string +|False +a|Export policy type + + +|ips +|array[string] +|False +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|False +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CreateCifsShareInfoRequest] +[.api-collapsible-fifth-title] +CreateCifsShareInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|False +a|Share name + + +|accessControl +|link:#CifsShareUserPermissions[CifsShareUserPermissions] +|False +a| + +|=== + + +[#IgroupCreationRequest] +[.api-collapsible-fifth-title] +IgroupCreationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|initiators +|array[string] +|False +a|Initiators + + +|igroupName +|string +|False +a|Igroup name + + +|=== + + +[#CreateIscsiInfoRequest] +[.api-collapsible-fifth-title] +CreateIscsiInfoRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|osName +|string +|False +a|Operating system + + +|igroupCreationRequest +|link:#IgroupCreationRequest[IgroupCreationRequest] +|False +a| + +|igroups +|array[string] +|False +a|Igroups + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#VsaVolumeOnNewVsaCreateRequest] +[.api-collapsible-fifth-title] +VsaVolumeOnNewVsaCreateRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Volume name, unique within the SVM + + +|size +|link:#PositiveCapacity[PositiveCapacity] +|False +a| + +|initialSize +|link:#Capacity[Capacity] +|False +a| + +|snapshotPolicyName +|string +|False +a| + +|exportPolicyInfo +|link:#ExportPolicyInfo[ExportPolicyInfo] +|False +a| + +|shareInfo +|link:#CreateCifsShareInfoRequest[CreateCifsShareInfoRequest] +|False +a| + +|iscsiInfo +|link:#CreateIscsiInfoRequest[CreateIscsiInfoRequest] +|False +a| + +|enableThinProvisioning +|boolean +|False +a|Enable thin provisioning on the volume + + +|enableCompression +|boolean +|False +a|Enable compression on the volume + + +|enableDeduplication +|boolean +|False +a|Enable deduplication on the volume + + +|tieringPolicy +|string +|False +a|Tiering policy + + +|junctionPath +|string +|False +a|Junction path + + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|=== + + +[#OntapEncryption] +[.api-collapsible-fifth-title] +OntapEncryption + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|keyManagerIds +|array[string] +|False +a| + +|keyManagerCaCertificateId +|string +|False +a| + +|=== + + +[#AwsEncryption] +[.api-collapsible-fifth-title] +AwsEncryption + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|kmsKeyId +|string +|False +a| + +|kmsKeyArn +|string +|False +a| + +|=== + + +[#openSecurityGroup] +[.api-collapsible-fifth-title] +openSecurityGroup + +Open the security group to all IP ranges + + + +[#VsaMetadataRequest] +[.api-collapsible-fifth-title] +VsaMetadataRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapVersion +|string +|True +a|ONTAP version + + +|licenseType +|string +|True +a|License type + + +|instanceType +|string +|True +a|Instance type + + +|platformSerialNumber +|string +|False +a|Optional platform serial number + + +|providedLicense +|string +|False +a|Optional provided license + + +|capacityPackageName +|string +|False +a|Optional capacity-based package + + +|keyStoneSubscription +|string +|False +a|Keystone subscription ID + + +|useLatestVersion +|boolean +|False +a|Use the latest version + + +|=== + + +[#CIFSConfigurationRequest] +[.api-collapsible-fifth-title] +CIFSConfigurationRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dnsDomain +|string +|False +a|DNS domain name + + +|ipAddresses +|array[string] +|True +a|DNS server IP addresses + + +|netBIOS +|string +|True +a|CIFS server NetBIOS name + + +|organizationalUnit +|string +|True +a|Organizational unit for registration + + +|activeDirectoryDomain +|string +|True +a|Active Directory domain name + + +|activeDirectoryUsername +|string +|True +a|Active Directory username + + +|activeDirectoryPassword +|string +|True +a|Active Directory password + + +|svmName +|string +|False +a|SVM name + + +|=== + + +[#AwsTag] +[.api-collapsible-fifth-title] +AwsTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|False +a| + +|tagValue +|string +|False +a| + +|=== + + +[#WormRetentionPeriod] +[.api-collapsible-fifth-title] +WormRetentionPeriod + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|True +a|Length + + +|unit +|string +|True +a|Unit + + +|=== + + +[#WormRequest] +[.api-collapsible-fifth-title] +WormRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|retentionPeriod +|link:#WormRetentionPeriod[WormRetentionPeriod] +|True +a| + +|=== + + +[#FailureCauses] +[.api-collapsible-fifth-title] +FailureCauses + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|invalidOntapCredentials +|boolean +|True +a| + +|noCloudProviderConnection +|boolean +|False +a| + +|invalidCloudProviderCredentials +|boolean +|False +a| + +|=== + + +[#StatusProperties] +[.api-collapsible-fifth-title] +StatusProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|message +|string +|False +a| + +|failureCauses +|link:#FailureCauses[FailureCauses] +|False +a| + +|extendedFailureReason +|string +|False +a| + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags + +Instance tags + +Hash mapping strings to string +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|traversableAgain +|boolean +|False +a| + +|empty +|boolean +|False +a| + +|=== + + +[#InstanceResponse] +[.api-collapsible-fifth-title] +InstanceResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a|Instance ID + + +|name +|string +|True +a|Instance name + + +|instanceType +|string +|True +a|Instance type + + +|state +|string +|True +a|Instance state + + +|publicIpAddress +|string +|True +a|Public IP address that is assigned to the instance + + +|privateIpAddress +|string +|True +a|Private IP address that is assigned to the instance + + +|publicDnsName +|string +|True +a|Public DNS + + +|privateDnsName +|string +|True +a|Private DNS name + + +|imageId +|string +|True +a|Image ID + + +|subnetId +|string +|True +a|Subnet ID + + +|availabilityZone +|string +|True +a|Availability zone + + +|isVsaInstance +|boolean +|True +a|Indicates if the instance is a Cloud Volumes ONTAP instance + + +|isOCCMInstance +|boolean +|True +a|Indicates if the instance is a NetApp Console instance + + +|tags +|link:#tags[tags] +|True +a|Instance tags + + +|productCode +|string +|True +a|Product code + + +|tenancy +|string +|True +a|Instance Tenancy + + +|placementGroup +|string +|True +a|Placement group + + +|keyPairName +|string +|True +a|Key pair + + +|instanceProfileId +|string +|False +a|Instance profile ID + + +|=== + + +[#VpcTagResponse] +[.api-collapsible-fifth-title] +VpcTagResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|key +|string +|True +a|VPC tag key + + +|value +|string +|True +a|VPC tag value + + +|=== + + +[#VpcBasicResponse] +[.api-collapsible-fifth-title] +VpcBasicResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|True +a|The VPC identifier + + +|state +|string +|True +a|The state of the VPC + + +|cidrBlock +|string +|True +a|VPC Classless Inter-Domain Routing (CIDR) block + + +|tags +|array[link:#VpcTagResponse[VpcTagResponse]] +|True +a|VPC tags + + +|default +|boolean +|True +a|Indicates whether the VPC is the default + + +|=== + + +[#bootDiskSize] +[.api-collapsible-fifth-title] +bootDiskSize + + +[#coreDiskExists] +[.api-collapsible-fifth-title] +coreDiskExists + + +[#AwsProperties] +[.api-collapsible-fifth-title] +AwsProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionName +|string +|False +a| + +|availabilityZones +|array[string] +|False +a| + +|instances +|array[link:#InstanceResponse[InstanceResponse]] +|False +a| + +|vpc +|link:#VpcBasicResponse[VpcBasicResponse] +|False +a| + +|accountId +|string +|False +a| + +|roleArn +|string +|False +a| + +|cloudProviderAccountId +|string +|False +a| + +|bootDiskSize +|link:#bootDiskSize[bootDiskSize] +|False +a| + +|outpostArn +|string +|False +a| + +|coreDiskExists +|link:#coreDiskExists[coreDiskExists] +|False +a| + +|=== + + +[#KeyManagerResponse] +[.api-collapsible-fifth-title] +KeyManagerResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +[#CertificateResponse] +[.api-collapsible-fifth-title] +CertificateResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|directIssuerName +|string +|False +a| + +|subjectName +|string +|False +a| + +|startDate +|integer +|True +a| + +|endDate +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|certificate +|string +|False +a| + +|certificateType +|string +|False +a| + +|=== + + +[#validTo] +[.api-collapsible-fifth-title] +validTo + + +[#AwsEncryptionKey] +[.api-collapsible-fifth-title] +AwsEncryptionKey + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|string +|False +a| + +|keyId +|string +|False +a| + +|status +|string +|False +a| + +|validTo +|link:#validTo[validTo] +|False +a| + +|origin +|string +|False +a| + +|default +|boolean +|False +a| + +|=== + + +[#EncryptionProperties] +[.api-collapsible-fifth-title] +EncryptionProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ontapEncryption +|boolean +|False +a| + +|awsVolumeEncryption +|boolean +|False +a| + +|azureVolumeEncryption +|boolean +|False +a| + +|gcpVolumeEncryption +|boolean +|False +a| + +|keyManagers +|array[link:#KeyManagerResponse[KeyManagerResponse]] +|False +a| + +|encryptionCertificates +|array[link:#CertificateResponse[CertificateResponse]] +|False +a| + +|awsEncryptionKey +|link:#AwsEncryptionKey[AwsEncryptionKey] +|False +a| + +|=== + + +[#LifResponse] +[.api-collapsible-fifth-title] +LifResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a|LIF IP address + + +|netmask +|string +|True +a|LIF netmask + + +|lifType +|string +|True +a|LIF type + + +|dataProtocols +|array[string] +|True +a|List of supported protocols + + +|nodeName +|string +|True +a|Node name + + +|privateIp +|boolean +|True +a|Specifies whether the LIF IP address is a private address + + +|=== + + +[#VsaLicense] +[.api-collapsible-fifth-title] +VsaLicense + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|License name + + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#lastModifiedOffbox] +[.api-collapsible-fifth-title] +lastModifiedOffbox + + +[#OntapUpdateImageMetadata] +[.api-collapsible-fifth-title] +OntapUpdateImageMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|imageVersion +|string +|True +a| + +|lastModified +|integer +|True +a| + +|autoUpdateAllowed +|boolean +|True +a| + +|=== + + +[#VsaClusterProperties] +[.api-collapsible-fifth-title] +VsaClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|clusterName +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|accountId +|string +|False +a| + +|productCode +|string +|False +a| + +|amiId +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|instanceId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|instanceType +|string +|False +a| + +|publicIp +|string +|False +a| + +|publicDnsName +|string +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|=== + + +[#OntapNodeProperties] +[.api-collapsible-fifth-title] +OntapNodeProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|lifs +|array[link:#LifResponse[LifResponse]] +|False +a| + +|serialNumber +|string +|False +a| + +|systemId +|string +|False +a| + +|platformLicense +|string +|False +a| + +|platformSerialNumber +|string +|False +a| + +|cloudProviderId +|string +|False +a| + +|healthy +|boolean +|False +a| + +|inTakeover +|boolean +|False +a| + +|=== + + +[#BroadcastDomainInfo] +[.api-collapsible-fifth-title] +BroadcastDomainInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|broadcastDomain +|string +|False +a| + +|ipSpace +|string +|False +a| + +|mtu +|integer +|True +a| + +|=== + + +[#CapacityTierInfo] +[.api-collapsible-fifth-title] +CapacityTierInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityTierUsedSize +|link:#Capacity[Capacity] +|False +a| + +|s3BucketName +|string +|False +a| + +|tierLevel +|string +|False +a| + +|=== + + +[#OntapClusterProperties] +[.api-collapsible-fifth-title] +OntapClusterProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nodes +|array[link:#OntapNodeProperties[OntapNodeProperties]] +|False +a| + +|clusterName +|string +|False +a| + +|clusterUuid +|string +|False +a| + +|ontapVersion +|string +|False +a| + +|systemManagerUrl +|string +|False +a| + +|creationTime +|integer +|False +a| + +|licenseType +|link:#VsaLicense[VsaLicense] +|False +a| + +|licensePackageName +|string +|False +a| + +|isKeystoneSubscription +|boolean +|False +a| + +|lastModifiedOffbox +|link:#lastModifiedOffbox[lastModifiedOffbox] +|False +a| + +|offboxTarget +|boolean +|False +a| + +|upgradeVersions +|array[link:#OntapUpdateImageMetadata[OntapUpdateImageMetadata]] +|False +a| + +|writingSpeedState +|string +|False +a| + +|broadcastDomainInfos +|array[link:#BroadcastDomainInfo[BroadcastDomainInfo]] +|False +a| + +|evaluation +|boolean +|False +a| + +|capacityTierInfo +|link:#CapacityTierInfo[CapacityTierInfo] +|False +a| + +|canConfigureCapacityTier +|boolean +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|userName +|string +|False +a| + +|wormEnabled +|boolean +|False +a| + +|isSpaceReportingLogical +|boolean +|False +a| + +|vscanFileOperationDefaultProfile +|string +|False +a| + +|aggregateCount +|integer +|False +a| + +|volumeCount +|integer +|False +a| + +|flashCache +|boolean +|False +a| + +|=== + + +[#RaidInfoForEvAggregate] +[.api-collapsible-fifth-title] +RaidInfoForEvAggregate + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|True +a|Number of new disks needed for the RAID group + + +|diskSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ElasticVolumeQuoteInfo] +[.api-collapsible-fifth-title] +ElasticVolumeQuoteInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalCapacityToAdd +|link:#Capacity[Capacity] +|False +a| + +|addedCapacityToExistingEvDisks +|link:#Capacity[Capacity] +|False +a| + +|newRaidForEvInfo +|array[link:#RaidInfoForEvAggregate[RaidInfoForEvAggregate]] +|False +a|New RAID information + + +|totalEvDisks +|integer +|False +a| + +|=== + + +[#VolumeMoveParameters] +[.api-collapsible-fifth-title] +VolumeMoveParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|targetAggregateName +|string +|False +a| + +|isNewTargetAggregate +|boolean +|False +a| + +|homeNode +|string +|False +a| + +|=== + + +[#OntapLicenseType] +[.api-collapsible-fifth-title] +OntapLicenseType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|name +|string +|False +a| + +|description +|string +|False +a| + +|subName +|string +|False +a| + +|subDescription +|string +|False +a| + +|capacity_limit +|string +|False +a| + +|platformLicenseRequired +|boolean +|False +a| + +|default +|boolean +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|True +a| + +|=== + + +[#ChangeLicenseParameters] +[.api-collapsible-fifth-title] +ChangeLicenseParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newLicenseType +|link:#OntapLicenseType[OntapLicenseType] +|False +a| + +|newInstanceType +|string +|False +a| + +|=== + + +[#InstanceNameIdAndType] +[.api-collapsible-fifth-title] +InstanceNameIdAndType + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceName +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|=== + + +[#DisksDetails] +[.api-collapsible-fifth-title] +DisksDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numberOfDisks +|integer +|False +a| + +|diskSize +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|=== + + +[#ResourcesToDelete] +[.api-collapsible-fifth-title] +ResourcesToDelete + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceNameAndType +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|False +a| + +|numberOfDisksAndDiskSize +|array[link:#DisksDetails[DisksDetails]] +|False +a| + +|=== + + +[#VolumeInfo] +[.api-collapsible-fifth-title] +VolumeInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|newCapacity +|link:#Capacity[Capacity] +|False +a| + +|=== + + +[#ActionRequiredParameters] +[.api-collapsible-fifth-title] +ActionRequiredParameters + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aggregateName +|string +|True +a|Aggregate name + + +|numOfDisks +|integer +|True +a|Number of disks relevant to the action + + +|totalCapacity +|link:#Capacity[Capacity] +|True +a| + +|evCapacityDetails +|link:#ElasticVolumeQuoteInfo[ElasticVolumeQuoteInfo] +|False +a| + +|volumeNames +|array[string] +|True +a|A limited list of volumes on the aggregate + + +|maxCapacity +|link:#Capacity[Capacity] +|True +a| + +|licenseExpiryDate +|integer +|True +a|License expiry date + + +|serialNumber +|string +|True +a|Platform serial number + + +|volumeMoveParameters +|link:#VolumeMoveParameters[VolumeMoveParameters] +|False +a| + +|workingEnvironmentId +|string +|True +a|System public ID + + +|licenseParameters +|link:#ChangeLicenseParameters[ChangeLicenseParameters] +|False +a| + +|resourcesToDelete +|link:#ResourcesToDelete[ResourcesToDelete] +|False +a| + +|instances +|array[link:#InstanceNameIdAndType[InstanceNameIdAndType]] +|True +a|Instances information + + +|moreInfo +|string +|False +a|More information + + +|providerVolumeType +|string +|False +a|Provider volume type + + +|volumeInfo +|link:#VolumeInfo[VolumeInfo] +|False +a| + +|currentInstanceType +|string +|False +a|Current instance type + + +|isComposite +|boolean +|True +a|Indicates if the aggregate is a composite aggregate + + +|isCapacityBased +|boolean +|True +a|Indicates if the license type is a capacity-based license type + + +|=== + + +[#ActionRequired] +[.api-collapsible-fifth-title] +ActionRequired + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|actionType +|string +|True +a|The type of the action + + +|parameters +|link:#ActionRequiredParameters[ActionRequiredParameters] +|True +a| + +|severity +|string +|True +a|Action Severity + + +|=== + + +[#InterClusterLif] +[.api-collapsible-fifth-title] +InterClusterLif + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|port +|string +|False +a| + +|node +|string +|False +a| + +|status +|string +|False +a| + +|isPeered +|boolean +|False +a| + +|=== + + +[#CronJobSchedule] +[.api-collapsible-fifth-title] +CronJobSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|description +|string +|False +a| + +|months +|array[string] +|True +a| + +|days +|array[string] +|False +a| + +|weekDays +|array[string] +|False +a| + +|hours +|array[string] +|False +a| + +|minutes +|array[string] +|False +a| + +|=== + + +[#PolicySchedule] +[.api-collapsible-fifth-title] +PolicySchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|frequency +|string +|True +a|Frequency + + +|retention +|integer +|True +a|Retention + + +|=== + + +[#SnapshotPolicy] +[.api-collapsible-fifth-title] +SnapshotPolicy + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name + + +|schedules +|array[link:#PolicySchedule[PolicySchedule]] +|True +a|Schedules + + +|description +|string +|True +a|Description + + +|=== + + +[#Value] +[.api-collapsible-fifth-title] +Value + + +[#Svm] +[.api-collapsible-fifth-title] +Svm + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|state +|string +|False +a| + +|allowedProtocols +|array[link:#Value[Value]] +|True +a| + +|language +|string +|False +a| + +|allowedAggregates +|array[string] +|False +a| + +|ver3Enabled +|boolean +|True +a|NFS Version 3 enabled + + +|ver4Enabled +|boolean +|True +a|NFS Version 4 enabled + + +|=== + + +[#ReplicationProperties] +[.api-collapsible-fifth-title] +ReplicationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|peers +|array[string] +|False +a| + +|replicationTargets +|array[string] +|False +a| + +|=== + + +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +[#SupportRegistrationProperties] +[.api-collapsible-fifth-title] +SupportRegistrationProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|licenseExpiryDate +|integer +|False +a| + +|=== + + +[#licenseExpiryDate] +[.api-collapsible-fifth-title] +licenseExpiryDate + + +[#SupportRegistrationInformation] +[.api-collapsible-fifth-title] +SupportRegistrationInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportRegistrationStatus +|string +|False +a| + +|serialNumber +|string +|False +a| + +|licenseExpiryDate +|link:#licenseExpiryDate[licenseExpiryDate] +|False +a| + +|cloudLicenseExists +|boolean +|False +a| + +|nssAccountId +|string +|False +a| + +|=== + + +[#MediatorVersionInfo] +[.api-collapsible-fifth-title] +MediatorVersionInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|version +|string +|False +a| + +|description +|string +|False +a| + +|state +|string +|True +a| + +|bootVolumeId +|string +|False +a| + +|=== + + +[#MediatorStatus] +[.api-collapsible-fifth-title] +MediatorStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|statusCode +|integer +|False +a| + +|statusMessage +|string +|False +a| + +|=== + + +[#MediatorUpdateVersionMetadata] +[.api-collapsible-fifth-title] +MediatorUpdateVersionMetadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersion +|string +|False +a| + +|timeStamp +|integer +|False +a| + +|metadataFileName +|string +|False +a| + +|major +|boolean +|False +a| + +|manifestFileName +|string +|False +a| + +|=== + + +[#AwsHaProperties] +[.api-collapsible-fifth-title] +AwsHaProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|mediatorVersionInfo +|link:#MediatorVersionInfo[MediatorVersionInfo] +|False +a| + +|mediatorStatus +|link:#MediatorStatus[MediatorStatus] +|False +a| + +|routeTables +|array[string] +|False +a| + +|mediatorVersionsToUpdate +|array[link:#MediatorUpdateVersionMetadata[MediatorUpdateVersionMetadata]] +|False +a| + +|failoverMode +|string +|False +a| + +|=== + + +[#MaxDisksAllow] +[.api-collapsible-fifth-title] +MaxDisksAllow + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|numOfDisks +|integer +|False +a| + +|reason +|string +|False +a| + +|=== + + +[#ProviderVolumeTypeResponse] +[.api-collapsible-fifth-title] +ProviderVolumeTypeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|supportedVolumeTypes +|array[string] +|False +a| + +|maxDisksAllow +|link:#MaxDisksAllow[MaxDisksAllow] +|True +a| + +|=== + + +[#iops] +[.api-collapsible-fifth-title] +iops + + +[#DefaultProviderVolume] +[.api-collapsible-fifth-title] +DefaultProviderVolume + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|link:#Capacity[Capacity] +|False +a| + +|diskType +|string +|False +a| + +|capacityTier +|string +|False +a| + +|iops +|link:#iops[iops] +|False +a| + +|=== + + +[#SupportedCapacityTiersResponse] +[.api-collapsible-fifth-title] +SupportedCapacityTiersResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeType +|string +|False +a| + +|supportedCapacityTiers +|array[string] +|False +a| + +|availableTieringPolicies +|array[string] +|False +a| + +|=== + + +[#SupportedCapacityTiers] +[.api-collapsible-fifth-title] +SupportedCapacityTiers + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportedCapacityTiersPerVolumeType +|array[link:#SupportedCapacityTiersResponse[SupportedCapacityTiersResponse]] +|True +a| + +|capacityTiersDisableReasons +|array[string] +|False +a| + +|compositeSupported +|boolean +|False +a| + +|forceCompositeVersion +|boolean +|False +a| + +|=== + + +[#existingIops] +[.api-collapsible-fifth-title] +existingIops + + +[#CapacityFeatures] +[.api-collapsible-fifth-title] +CapacityFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|providerVolumesType +|array[link:#ProviderVolumeTypeResponse[ProviderVolumeTypeResponse]] +|False +a| + +|defaultProviderVolumeType +|link:#DefaultProviderVolume[DefaultProviderVolume] +|False +a| + +|supportedCapacityTiers +|link:#SupportedCapacityTiers[SupportedCapacityTiers] +|False +a| + +|maxDisksPerAggregate +|integer +|False +a| + +|existingIops +|array[link:#existingIops[existingIops]] +|False +a| + +|=== + + +[#CloudSyncStatus] +[.api-collapsible-fifth-title] +CloudSyncStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#DataBrokerPlacement] +[.api-collapsible-fifth-title] +DataBrokerPlacement + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|False +a| + +|subnetId +|string +|False +a| + +|instanceType +|string +|False +a| + +|instanceId +|string +|False +a| + +|keyPair +|string +|False +a| + +|=== + + +[#DataBrokerProperties] +[.api-collapsible-fifth-title] +DataBrokerProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|dataBrokerPlacement +|link:#DataBrokerPlacement[DataBrokerPlacement] +|False +a| + +|=== + + +[#CloudSyncRelationship] +[.api-collapsible-fifth-title] +CloudSyncRelationship + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|volumeName +|string +|False +a| + +|svmName +|string +|False +a| + +|relationshipStatus +|string +|False +a| + +|s3Location +|string +|False +a| + +|id +|string +|False +a| + +|progress +|integer +|False +a| + +|failureMessage +|string +|False +a| + +|=== + + +[#CloudSyncProperties] +[.api-collapsible-fifth-title] +CloudSyncProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSynced +|boolean +|False +a| + +|status +|link:#CloudSyncStatus[CloudSyncStatus] +|False +a| + +|dataBrokerProperties +|link:#DataBrokerProperties[DataBrokerProperties] +|False +a| + +|s3Location +|string +|False +a| + +|relationships +|array[link:#CloudSyncRelationship[CloudSyncRelationship]] +|False +a| + +|=== + + +[#SupportedFeatures] +[.api-collapsible-fifth-title] +SupportedFeatures + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|supportsMixedAggregates +|boolean +|False +a| + +|supportsTieringWithServiceAccount +|boolean +|False +a| + +|supportsGp3Disk +|boolean +|False +a| + +|supportsElasticVolumes +|boolean +|False +a| + +|=== + + +[#FpolicyProtocolStatus] +[.api-collapsible-fifth-title] +FpolicyProtocolStatus + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nfsv3 +|integer +|False +a| + +|nfsv4 +|integer +|False +a| + +|cifs +|integer +|False +a| + +|=== + + +[#FpolicyProperties] +[.api-collapsible-fifth-title] +FpolicyProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|integer +|False +a| + +|fPolicyProtocolStatus +|link:#FpolicyProtocolStatus[FpolicyProtocolStatus] +|False +a| + +|fileExtensions +|array[string] +|False +a| + +|=== + + +[#SaasSubscription] +[.api-collapsible-fifth-title] +SaasSubscription + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|name +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +[#freeTrialExpiry] +[.api-collapsible-fifth-title] +freeTrialExpiry + + +[#saasEnabled] +[.api-collapsible-fifth-title] +saasEnabled + + +[#CvoSaasProperties] +[.api-collapsible-fifth-title] +CvoSaasProperties + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscription +|link:#SaasSubscription[SaasSubscription] +|False +a| + +|freeTrialExpiry +|link:#freeTrialExpiry[freeTrialExpiry] +|False +a| + +|saasEnabled +|link:#saasEnabled[saasEnabled] +|False +a| + +|capacityLicensePackage +|string +|False +a| + +|=== + + +[#CbsSchedule] +[.api-collapsible-fifth-title] +CbsSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapmirrorLabel +|string +|False +a| + +|snapshotsToKeep +|integer +|False +a| + +|=== + + +[#ProviderSpecific] +[.api-collapsible-fifth-title] +ProviderSpecific + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|azureRgName +|string +|False +a| + +|gcpProjectId +|string +|False +a| + +|gcpRegion +|string +|False +a| + +|=== + + +[#CbsPropertiesWithReason] +[.api-collapsible-fifth-title] +CbsPropertiesWithReason + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cbsBackupStatus +|string +|False +a| + +|cbsRules +|array[link:#CbsSchedule[CbsSchedule]] +|False +a| + +|numberOfBackedUpVolumes +|integer +|False +a| + +|objectStoreName +|string +|False +a| + +|providerSpecific +|link:#ProviderSpecific[ProviderSpecific] +|False +a| + +|cbsPolicyName +|string +|False +a| + +|usedCapacity +|link:#Capacity[Capacity] +|False +a| + +|ipSpace +|string +|False +a| + +|region +|string +|False +a| + +|providerAccountName +|string +|False +a| + +|exclusionReason +|string +|False +a| + +|=== + + +[#scopeId] +[.api-collapsible-fifth-title] +scopeId + + +[#ComplianceScanStatusVolumeResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusVolumeResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|status +|string +|False +a| + +|error +|string +|False +a| + +|scopeId +|link:#scopeId[scopeId] +|False +a| + +|=== + + +[#ComplianceScanStatusResponse] +[.api-collapsible-fifth-title] +ComplianceScanStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanned +|integer +|False +a| + +|notScanned +|integer +|False +a| + +|volumes +|array[link:#ComplianceScanStatusVolumeResponse[ComplianceScanStatusVolumeResponse]] +|False +a| + +|=== + + +[#ComplianceExtendedStatusResponse] +[.api-collapsible-fifth-title] +ComplianceExtendedStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|sensitivePersonalHits +|integer +|False +a| + +|personalHits +|integer +|False +a| + +|nonSensitiveHits +|integer +|False +a| + +|scanStatus +|link:#ComplianceScanStatusResponse[ComplianceScanStatusResponse] +|False +a| + +|=== + + +[#CloudComplianceStatusResponse] +[.api-collapsible-fifth-title] +CloudComplianceStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|scanStatus +|string +|False +a| + +|complianceStatus +|link:#ComplianceExtendedStatusResponse[ComplianceExtendedStatusResponse] +|False +a| + +|lastDeploymentError +|string +|False +a| + +|complianceBackupStatus +|string +|False +a| + +|=== + + +[#KpiUnitValue] +[.api-collapsible-fifth-title] +KpiUnitValue + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|value +|number +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#MonitoringInfo] +[.api-collapsible-fifth-title] +MonitoringInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|averageIops +|number +|False +a| + +|averageLatency +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|storageAverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node1AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|node2AverageThroughput +|link:#KpiUnitValue[KpiUnitValue] +|False +a| + +|=== + + +[#MonitoringStatusResponse] +[.api-collapsible-fifth-title] +MonitoringStatusResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|monitoringStatus +|string +|False +a| + +|monitoringInfo +|link:#MonitoringInfo[MonitoringInfo] +|False +a| + +|tenantUrl +|string +|False +a| + +|=== + + +[#expirations] +[.api-collapsible-fifth-title] +expirations + + +[#LicenseInformation] +[.api-collapsible-fifth-title] +LicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a| + +|useType +|string +|True +a| + +|package +|string +|True +a| + +|serialNumbers +|array[string] +|False +a| + +|capacityLimit +|link:#Capacity[Capacity] +|False +a| + +|expirations +|array[link:#expirations[expirations]] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/post-working-environments-metering-report.adoc b/cvo/post-working-environments-metering-report.adoc new file mode 100644 index 00000000..04cd0d92 --- /dev/null +++ b/cvo/post-working-environments-metering-report.adoc @@ -0,0 +1,136 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/post-working-environments-metering-report.html' +summary: 'Trigger NetApp Console dark site capacity metering report generation' +--- + += Trigger NetApp Console dark site capacity metering report generation + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/working-environments/metering-report`# + + + +Triggers darksite capacity metering report generation and returns the full report output. + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|calculationTimeUtc +|string +|True +a| + +|capacityCvoCount +|integer +|True +a| + +|capacityVolumeCount +|integer +|False +a| + +|minimumCapacityGb +|integer +|True +a| + +|chargeThresholdGb +|integer +|False +a| + +|bucketsGenerated +|array[link:#BucketEntry[BucketEntry]] +|True +a| + +|uploadedReports +|array[link:#UploadedReportEntry[UploadedReportEntry]] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#BucketEntry] +[.api-collapsible-fifth-title] +BucketEntry + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|False +a| + +|dimension +|string +|False +a| + +|consumptionGb +|integer +|False +a| + +|=== + + +[#UploadedReportEntry] +[.api-collapsible-fifth-title] +UploadedReportEntry + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|False +a| + +|dimension +|string +|False +a| + +|usedCapacityTb +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-accounts-aws-.adoc b/cvo/put-accounts-aws-.adoc new file mode 100644 index 00000000..3a02028c --- /dev/null +++ b/cvo/put-accounts-aws-.adoc @@ -0,0 +1,287 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-accounts-aws-.html' +summary: 'Update an existing AWS account' +--- + += Update an existing AWS account + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/accounts/aws/{cloudProviderAccountId}`# + + + +Updates an existing AWS account. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudProviderAccountId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountName +|string +|False +a| + +|providerKeys +|link:#AwsKeysRequest[AwsKeysRequest] +|True +a| + +|subscriptionId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountName": "string", + "providerKeys": { + "awsAccessKeys": { + "accessKey": "string", + "secretKey": "string" + }, + "assumeRoleArn": "string" + }, + "subscriptionId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|accountId +|string +|False +a| + +|accessKey +|string +|False +a| + +|assumeRole +|link:#AssumeRole[AssumeRole] +|False +a| + +|occmRole +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|subscriptionId +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "accountName": "string", + "accountType": "string", + "accountId": "string", + "accessKey": "string", + "assumeRole": { + "roleName": "string", + "accountId": "string" + }, + "occmRole": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ], + "subscriptionId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AwsAccessKeys] +[.api-collapsible-fifth-title] +AwsAccessKeys + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accessKey +|string +|True +a| + +|secretKey +|string +|False +a| + +|=== + + +[#AwsKeysRequest] +[.api-collapsible-fifth-title] +AwsKeysRequest + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|awsAccessKeys +|link:#AwsAccessKeys[AwsAccessKeys] +|False +a| + +|assumeRoleArn +|string +|False +a| + +|=== + + +[#AssumeRole] +[.api-collapsible-fifth-title] +AssumeRole + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|roleName +|string +|False +a| + +|accountId +|string +|False +a| + +|isGov +|boolean +|False +a| + +|=== + + +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-accounts-azure-.adoc b/cvo/put-accounts-azure-.adoc new file mode 100644 index 00000000..85cfa91a --- /dev/null +++ b/cvo/put-accounts-azure-.adoc @@ -0,0 +1,223 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-accounts-azure-.html' +summary: 'Update an Azure account' +--- + += Update an Azure account + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/accounts/azure/{cloudProviderAccountId}`# + + + +Updates an existing Azure account. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudProviderAccountId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountName +|string +|False +a| + +|providerKeys +|link:#AzureKeys[AzureKeys] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountName": "string", + "providerKeys": { + "tenantId": "string", + "applicationId": "string", + "applicationKey": "string", + "subscription": "string" + } +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|tenantId +|string +|False +a| + +|applicationId +|string +|False +a| + +|occmRole +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "accountName": "string", + "accountType": "string", + "tenantId": "string", + "applicationId": "string", + "occmRole": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AzureKeys] +[.api-collapsible-fifth-title] +AzureKeys + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tenantId +|string +|True +a| + +|applicationId +|string +|False +a| + +|applicationKey +|string +|False +a| + +|subscription +|string +|False +a|Subscription + + +|=== + + +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-accounts-gcp-.adoc b/cvo/put-accounts-gcp-.adoc new file mode 100644 index 00000000..19926f15 --- /dev/null +++ b/cvo/put-accounts-gcp-.adoc @@ -0,0 +1,204 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-accounts-gcp-.html' +summary: 'Update a Google Cloud storage account' +--- + += Update a Google Cloud storage account + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/accounts/gcp/{cloudProviderAccountId}`# + + + +Updates an existing Google Cloud storage account. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudProviderAccountId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountName +|string +|False +a| + +|providerKeys +|link:#GcpKeysForCloudStorageWithValidation[GcpKeysForCloudStorageWithValidation] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountName": "string", + "providerKeys": { + "accessKey": "string", + "secretKey": "string" + } +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|accessKey +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|occmRole +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "accountName": "string", + "accountType": "string", + "accessKey": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ], + "occmRole": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#GcpKeysForCloudStorageWithValidation] +[.api-collapsible-fifth-title] +GcpKeysForCloudStorageWithValidation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accessKey +|string +|False +a| + +|secretKey +|string +|False +a| + +|=== + + +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-accounts-nss-.adoc b/cvo/put-accounts-nss-.adoc new file mode 100644 index 00000000..2d7ee8ce --- /dev/null +++ b/cvo/put-accounts-nss-.adoc @@ -0,0 +1,203 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-accounts-nss-.html' +summary: 'Update an NSS account' +--- + += Update an NSS account + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/accounts/nss/{cloudProviderAccountId}`# + + + +Updates an existing NetApp Support Site account. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudProviderAccountId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountName +|string +|False +a| + +|providerKeys +|link:#NssAccountCredentials[NssAccountCredentials] +|True +a| + +|vsaList +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountName": "string", + "providerKeys": { + "nssUserName": "string", + "nssPassword": "string" + }, + "vsaList": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a| + +|accountName +|string +|False +a| + +|accountType +|string +|False +a| + +|nssUserName +|string +|False +a| + +|vsaList +|array[link:#AccountWorkingEnvironmentResponse[AccountWorkingEnvironmentResponse]] +|True +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "accountName": "string", + "accountType": "string", + "nssUserName": "string", + "vsaList": [ + { + "publicId": "string", + "name": "string", + "workingEnvironmentType": "string" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#NssAccountCredentials] +[.api-collapsible-fifth-title] +NssAccountCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nssUserName +|string +|True +a| + +|nssPassword +|string +|False +a| + +|=== + + +[#AccountWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +AccountWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|workingEnvironmentType +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-accounts-nss-set-vsa-list-.adoc b/cvo/put-accounts-nss-set-vsa-list-.adoc new file mode 100644 index 00000000..a5ed942e --- /dev/null +++ b/cvo/put-accounts-nss-set-vsa-list-.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-accounts-nss-set-vsa-list-.html' +summary: 'Update the VSA list of an NSS account' +--- + += Update the VSA list of an NSS account + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/accounts/nss/set-vsa-list/{cloudProviderAccountId}`# + + + +Updates the system list of an existing NetApp Support Site account. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudProviderAccountId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vsaList +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "vsaList": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-auth-current-user-change-password.adoc b/cvo/put-auth-current-user-change-password.adoc new file mode 100644 index 00000000..48d14a43 --- /dev/null +++ b/cvo/put-auth-current-user-change-password.adoc @@ -0,0 +1,59 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-auth-current-user-change-password.html' +summary: 'Update the user password' +--- + += Update the user password + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/auth/current-user/change-password`# + + + +Updates the password for the current user. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|oldPassword +|string +|True +a|User's current password + + +|newPassword +|string +|False +a|User's new password + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "oldPassword": "string", + "newPassword": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-volumes--.adoc b/cvo/put-aws-ha-volumes--.adoc new file mode 100644 index 00000000..73560af8 --- /dev/null +++ b/cvo/put-aws-ha-volumes--.adoc @@ -0,0 +1,474 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-volumes--.html' +summary: 'Modify an existing volume' +--- + += Modify an existing volume + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Modifies an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|comment +|string +|False +a|Comment + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + }, + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string", + "comment": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-aws-ha-volumes--exportpolicy.adoc b/cvo/put-aws-ha-volumes--exportpolicy.adoc new file mode 100644 index 00000000..63b1085f --- /dev/null +++ b/cvo/put-aws-ha-volumes--exportpolicy.adoc @@ -0,0 +1,474 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-volumes--exportpolicy.html' +summary: 'Add an export policy rule' +--- + += Add an export policy rule + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy`# + + + +Adds an export policy rule. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|comment +|string +|False +a|Comment + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + }, + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string", + "comment": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-aws-ha-working-environments-activate-fpolicy.adoc b/cvo/put-aws-ha-working-environments-activate-fpolicy.adoc new file mode 100644 index 00000000..de6838c7 --- /dev/null +++ b/cvo/put-aws-ha-working-environments-activate-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-activate-fpolicy.html' +summary: 'Activate FPolicy for ransomware files' +--- + += Activate FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/activate-fpolicy`# + + + +Activates the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-working-environments-activate-snapshot-policy.adoc b/cvo/put-aws-ha-working-environments-activate-snapshot-policy.adoc new file mode 100644 index 00000000..6177dfbf --- /dev/null +++ b/cvo/put-aws-ha-working-environments-activate-snapshot-policy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-activate-snapshot-policy.html' +summary: 'Activate snapshot policy assignment for all unprotected read/write volumes' +--- + += Activate snapshot policy assignment for all unprotected read/write volumes + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy`# + + + +Activates snapshot policy assignment for all unprotected read/write volumes. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-working-environments-byol-to-capacity.adoc b/cvo/put-aws-ha-working-environments-byol-to-capacity.adoc new file mode 100644 index 00000000..bf2b7b7f --- /dev/null +++ b/cvo/put-aws-ha-working-environments-byol-to-capacity.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-byol-to-capacity.html' +summary: 'Update a BYOL license to a capacity-based license' +--- + += Update a BYOL license to a capacity-based license + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/byol-to-capacity`# + + + +Updates a bring-your-own-license (BYOL) license to a capacity-based license for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityPackageName +|string +|True +a|Capacity based package + + +|sendAsup +|boolean +|True +a| + +|deleteByNodeByolLicense +|boolean +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serial1 +|string +|True +a| + +|serial2 +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serial1": "string", + "serial2": "string" +} +==== + diff --git a/cvo/put-aws-ha-working-environments-disable-fpolicy.adoc b/cvo/put-aws-ha-working-environments-disable-fpolicy.adoc new file mode 100644 index 00000000..45ce078a --- /dev/null +++ b/cvo/put-aws-ha-working-environments-disable-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-disable-fpolicy.html' +summary: 'Disable FPolicy for ransomware files' +--- + += Disable FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/disable-fpolicy`# + + + +Disables the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-working-environments-enable-worm.adoc b/cvo/put-aws-ha-working-environments-enable-worm.adoc new file mode 100644 index 00000000..e3f19032 --- /dev/null +++ b/cvo/put-aws-ha-working-environments-enable-worm.adoc @@ -0,0 +1,95 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-enable-worm.html' +summary: 'Enable SnapLock for a system' +--- + += Enable SnapLock for a system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/enable-worm`# + + + +Enables SnapLock for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|retentionPeriod +|link:#WormRetentionPeriod[WormRetentionPeriod] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#WormRetentionPeriod] +[.api-collapsible-fifth-title] +WormRetentionPeriod + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|True +a|Length + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-aws-ha-working-environments-extra-capacity-licenses.adoc b/cvo/put-aws-ha-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..375baa9c --- /dev/null +++ b/cvo/put-aws-ha-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-extra-capacity-licenses.html' +summary: 'Update an extra capacity license' +--- + += Update an extra capacity license + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Updates an extra capacity license. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licences +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licences": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-working-environments-extra-capacity-serials.adoc b/cvo/put-aws-ha-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..0935b2a7 --- /dev/null +++ b/cvo/put-aws-ha-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-extra-capacity-serials.html' +summary: 'Update extra capacity license serial numbers' +--- + += Update extra capacity license serial numbers + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Updates an extra capacity license serial number. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-working-environments-license-instance-type.adoc b/cvo/put-aws-ha-working-environments-license-instance-type.adoc new file mode 100644 index 00000000..a944a498 --- /dev/null +++ b/cvo/put-aws-ha-working-environments-license-instance-type.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-license-instance-type.html' +summary: 'Set the instance type' +--- + += Set the instance type + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/license-instance-type`# + + + +Sets the instance type of a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|True +a|New instance type + + +|licenseType +|string +|True +a|New license type + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceType": "string", + "licenseType": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-working-environments-networkoptimization.adoc b/cvo/put-aws-ha-working-environments-networkoptimization.adoc new file mode 100644 index 00000000..48a70550 --- /dev/null +++ b/cvo/put-aws-ha-working-environments-networkoptimization.adoc @@ -0,0 +1,60 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-networkoptimization.html' +summary: 'Modify the network port broadcast domain MTU' +--- + += Modify the network port broadcast domain MTU + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/networkOptimization`# + + + +Modifies the network port broadcast domain MTU of the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|optimize +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-working-environments-offbox.adoc b/cvo/put-aws-ha-working-environments-offbox.adoc new file mode 100644 index 00000000..aee4f483 --- /dev/null +++ b/cvo/put-aws-ha-working-environments-offbox.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-offbox.html' +summary: 'Activate an off-box configuration' +--- + += Activate an off-box configuration + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/offbox`# + + + +Activates an off-box configuration. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-working-environments-route-tables.adoc b/cvo/put-aws-ha-working-environments-route-tables.adoc new file mode 100644 index 00000000..caada308 --- /dev/null +++ b/cvo/put-aws-ha-working-environments-route-tables.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-route-tables.html' +summary: 'Update the route tables for an HA system' +--- + += Update the route tables for an HA system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/route-tables`# + + + +Updates the route tables of an HA Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|routeTableIds +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "routeTableIds": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-working-environments-schedules.adoc b/cvo/put-aws-ha-working-environments-schedules.adoc new file mode 100644 index 00000000..cc1b892c --- /dev/null +++ b/cvo/put-aws-ha-working-environments-schedules.adoc @@ -0,0 +1,167 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-schedules.html' +summary: 'Set the schedules for a system' +--- + += Set the schedules for a system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/schedules`# + + + +Sets schedules for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-aws-ha-working-environments-set-password.adoc b/cvo/put-aws-ha-working-environments-set-password.adoc new file mode 100644 index 00000000..24b75e65 --- /dev/null +++ b/cvo/put-aws-ha-working-environments-set-password.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-set-password.html' +summary: 'Set the cluster password for a system' +--- + += Set the cluster password for a system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/set-password`# + + + +Sets the cluster password for a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|occmOnly +|boolean +|query +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|password +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-working-environments-svm.adoc b/cvo/put-aws-ha-working-environments-svm.adoc new file mode 100644 index 00000000..fde64df3 --- /dev/null +++ b/cvo/put-aws-ha-working-environments-svm.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-svm.html' +summary: 'Modify the SVM name of a system' +--- + += Modify the SVM name of a system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/svm`# + + + +Modifies the SVM name of the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|svmNewName +|string +|False +a| + +|svmName +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "svmNewName": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-working-environments-update-credentials.adoc b/cvo/put-aws-ha-working-environments-update-credentials.adoc new file mode 100644 index 00000000..a999de0b --- /dev/null +++ b/cvo/put-aws-ha-working-environments-update-credentials.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-update-credentials.html' +summary: 'Update the NetApp Console password' +--- + += Update the NetApp Console password + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/update-credentials`# + + + +Updates the NetApp Console password for a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|False +a|Username + + +|password +|string +|True +a|Password + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "username": "string", + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-working-environments-user-tags.adoc b/cvo/put-aws-ha-working-environments-user-tags.adoc new file mode 100644 index 00000000..001e6452 --- /dev/null +++ b/cvo/put-aws-ha-working-environments-user-tags.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-user-tags.html' +summary: 'Modify user tags for cloud resources' +--- + += Modify user tags for cloud resources + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/user-tags`# + + + +Modifies the user tags for cloud resources in a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tags +|array[link:#CloudResourceTag[CloudResourceTag]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tags": [ + { + "tagKey": "string", + "tagValue": "string" + } + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudResourceTag] +[.api-collapsible-fifth-title] +CloudResourceTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|True +a| + +|tagValue +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-aws-ha-working-environments-vscan-file-op.adoc b/cvo/put-aws-ha-working-environments-vscan-file-op.adoc new file mode 100644 index 00000000..2e9a19d5 --- /dev/null +++ b/cvo/put-aws-ha-working-environments-vscan-file-op.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-vscan-file-op.html' +summary: 'Update the default Vscan file operation profile' +--- + += Update the default Vscan file operation profile + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/vscan-file-op`# + + + +Updates the default Vscan file operation profile. Profiles on existing CIFS shares will change only on writes-only mode. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vscanFileOp +|string +|False +a|Vscan file-operation + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "vscanFileOp": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-aws-ha-working-environments-writing-speed.adoc b/cvo/put-aws-ha-working-environments-writing-speed.adoc new file mode 100644 index 00000000..8d91d975 --- /dev/null +++ b/cvo/put-aws-ha-working-environments-writing-speed.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-aws-ha-working-environments-writing-speed.html' +summary: 'Set the writing speed for a system' +--- + += Set the writing speed for a system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/aws/ha/working-environments/{workingEnvironmentId}/writing-speed`# + + + +Sets the writing speed for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|writingSpeedState +|string +|False +a|Writing speed state + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "writingSpeedState": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-aggregates-.adoc b/cvo/put-azure-ha-aggregates-.adoc new file mode 100644 index 00000000..400ba7ad --- /dev/null +++ b/cvo/put-azure-ha-aggregates-.adoc @@ -0,0 +1,73 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-aggregates-.html' +summary: 'Update IOPS and throughput for disks in an existing aggregate' +--- + += Update IOPS and throughput for disks in an existing aggregate + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}`# + + + +Updates IOPS and throughput for the disks in an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|iops +|integer +|True +a|New IOPS + + +|throughput +|integer +|True +a|New throughput + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-volumes--.adoc b/cvo/put-azure-ha-volumes--.adoc new file mode 100644 index 00000000..c2012d5d --- /dev/null +++ b/cvo/put-azure-ha-volumes--.adoc @@ -0,0 +1,474 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-volumes--.html' +summary: 'Modify an existing volume' +--- + += Modify an existing volume + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Modifies an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|comment +|string +|False +a|Comment + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + }, + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string", + "comment": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-azure-ha-volumes--exportpolicy.adoc b/cvo/put-azure-ha-volumes--exportpolicy.adoc new file mode 100644 index 00000000..36c58805 --- /dev/null +++ b/cvo/put-azure-ha-volumes--exportpolicy.adoc @@ -0,0 +1,474 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-volumes--exportpolicy.html' +summary: 'Add an export policy rule' +--- + += Add an export policy rule + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy`# + + + +Adds an export policy rule. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|comment +|string +|False +a|Comment + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + }, + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string", + "comment": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-azure-ha-volumes-storage-vms-volumes-resize-avs-ds.adoc b/cvo/put-azure-ha-volumes-storage-vms-volumes-resize-avs-ds.adoc new file mode 100644 index 00000000..277749ac --- /dev/null +++ b/cvo/put-azure-ha-volumes-storage-vms-volumes-resize-avs-ds.adoc @@ -0,0 +1,235 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-volumes-storage-vms-volumes-resize-avs-ds.html' +summary: 'Resize an Azure volume and the respective AVS DataStore with Cloud Volumes ONTAP' +--- + += Resize an Azure volume and the respective AVS DataStore with Cloud Volumes ONTAP + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/resize-avs-ds`# + + + +Resizes the volume and the respective Azure VMware Solution (AVS) DataStore. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a|The public ID of the system + + +|svmName +|string +|path +|True +a|The SVM name + + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a|The volume name + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|privateCloudName +|string +|True +a|Azure VMware Solution (AVS) private cloud name + + +|clusterName +|string +|True +a|Private cloud cluster name + + +|resourceGroup +|string +|True +a|Private cloud resourceGroup name + + +|dataStoreName +|string +|True +a|Private cloud DataStore name + + +|dataStoreSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-azure-ha-volumes-storage-vms-volumes-setup-avs.adoc b/cvo/put-azure-ha-volumes-storage-vms-volumes-setup-avs.adoc new file mode 100644 index 00000000..62c2a6b4 --- /dev/null +++ b/cvo/put-azure-ha-volumes-storage-vms-volumes-setup-avs.adoc @@ -0,0 +1,232 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-volumes-storage-vms-volumes-setup-avs.html' +summary: 'Set up Azure VMware Solution on a volume' +--- + += Set up Azure VMware Solution on a volume + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/setup-avs`# + + + +Sets up Azure VMware Solution on a volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|privateCloudName +|string +|True +a|Azure VMware Solution (AVS) private cloud name + + +|clusterName +|string +|True +a|Private cloud cluster name + + +|resourceGroup +|string +|True +a|Private cloud resourceGroup name + + +|dataStoreName +|string +|True +a|Private cloud DataStore name + + +|dataStoreSize +|link:#Capacity[Capacity] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-azure-ha-volumes-storage-vms-volumes-sync-avs-host.adoc b/cvo/put-azure-ha-volumes-storage-vms-volumes-sync-avs-host.adoc new file mode 100644 index 00000000..f6253f13 --- /dev/null +++ b/cvo/put-azure-ha-volumes-storage-vms-volumes-sync-avs-host.adoc @@ -0,0 +1,206 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-volumes-storage-vms-volumes-sync-avs-host.html' +summary: 'Synchronize Azure VMware Solution (AVS) hosts' +--- + += Synchronize Azure VMware Solution (AVS) hosts + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/sync-avs-host`# + + + +Synchronizes Azure VMware Solution hosts on a volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|privateCloudName +|string +|True +a|Azure VMware Solution (AVS) private cloud name + + +|clusterName +|string +|True +a|Private cloud cluster name + + +|resourceGroup +|string +|True +a|Private cloud resourceGroup name + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "privateCloudName": "string", + "clusterName": "string", + "resourceGroup": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-azure-ha-working-environments-activate-fpolicy.adoc b/cvo/put-azure-ha-working-environments-activate-fpolicy.adoc new file mode 100644 index 00000000..98d3edc9 --- /dev/null +++ b/cvo/put-azure-ha-working-environments-activate-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-activate-fpolicy.html' +summary: 'Activate FPolicy for ransomware files' +--- + += Activate FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/activate-fpolicy`# + + + +Activates the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-working-environments-activate-snapshot-policy.adoc b/cvo/put-azure-ha-working-environments-activate-snapshot-policy.adoc new file mode 100644 index 00000000..1243f5d2 --- /dev/null +++ b/cvo/put-azure-ha-working-environments-activate-snapshot-policy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-activate-snapshot-policy.html' +summary: 'Activate snapshot policy assignment' +--- + += Activate snapshot policy assignment + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy`# + + + +Activates snapshot policy assignment for all unprotected read/write volumes. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-working-environments-byol-to-capacity.adoc b/cvo/put-azure-ha-working-environments-byol-to-capacity.adoc new file mode 100644 index 00000000..2ea5f649 --- /dev/null +++ b/cvo/put-azure-ha-working-environments-byol-to-capacity.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-byol-to-capacity.html' +summary: 'Update a BYOL license to a capacity-based license' +--- + += Update a BYOL license to a capacity-based license + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/byol-to-capacity`# + + + +Updates a bring-your-own-license (BYOL) license to a capacity-based license for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityPackageName +|string +|True +a|Capacity based package + + +|sendAsup +|boolean +|True +a| + +|deleteByNodeByolLicense +|boolean +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serial1 +|string +|True +a| + +|serial2 +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serial1": "string", + "serial2": "string" +} +==== + diff --git a/cvo/put-azure-ha-working-environments-disable-fpolicy.adoc b/cvo/put-azure-ha-working-environments-disable-fpolicy.adoc new file mode 100644 index 00000000..f36d8471 --- /dev/null +++ b/cvo/put-azure-ha-working-environments-disable-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-disable-fpolicy.html' +summary: 'Disable FPolicy for ransomware files' +--- + += Disable FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/disable-fpolicy`# + + + +Disables the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-working-environments-enable-worm.adoc b/cvo/put-azure-ha-working-environments-enable-worm.adoc new file mode 100644 index 00000000..a797a534 --- /dev/null +++ b/cvo/put-azure-ha-working-environments-enable-worm.adoc @@ -0,0 +1,95 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-enable-worm.html' +summary: 'Enable SnapLock for a system' +--- + += Enable SnapLock for a system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/enable-worm`# + + + +Enables SnapLock for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|retentionPeriod +|link:#WormRetentionPeriod[WormRetentionPeriod] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#WormRetentionPeriod] +[.api-collapsible-fifth-title] +WormRetentionPeriod + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|True +a|Length + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-azure-ha-working-environments-extra-capacity-licenses.adoc b/cvo/put-azure-ha-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..c0f0a22a --- /dev/null +++ b/cvo/put-azure-ha-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-extra-capacity-licenses.html' +summary: 'Update an extra capacity license' +--- + += Update an extra capacity license + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Updates an extra capacity license. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licences +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licences": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-working-environments-extra-capacity-serials.adoc b/cvo/put-azure-ha-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..debe55e2 --- /dev/null +++ b/cvo/put-azure-ha-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-extra-capacity-serials.html' +summary: 'Update extra capacity serial numbers' +--- + += Update extra capacity serial numbers + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Updates an extra capacity license serial number. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-working-environments-license-instance-type.adoc b/cvo/put-azure-ha-working-environments-license-instance-type.adoc new file mode 100644 index 00000000..199662ac --- /dev/null +++ b/cvo/put-azure-ha-working-environments-license-instance-type.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-license-instance-type.html' +summary: 'Set the instance type' +--- + += Set the instance type + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/license-instance-type`# + + + +Sets the instance type of a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|True +a|New instance type + + +|licenseType +|string +|True +a|New license type + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceType": "string", + "licenseType": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-working-environments-networkoptimization.adoc b/cvo/put-azure-ha-working-environments-networkoptimization.adoc new file mode 100644 index 00000000..3bc70768 --- /dev/null +++ b/cvo/put-azure-ha-working-environments-networkoptimization.adoc @@ -0,0 +1,60 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-networkoptimization.html' +summary: 'Modify the network port broadcast domain MTU' +--- + += Modify the network port broadcast domain MTU + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/networkOptimization`# + + + +Modifies the network port broadcast domain MTU of the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|optimize +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-working-environments-offbox.adoc b/cvo/put-azure-ha-working-environments-offbox.adoc new file mode 100644 index 00000000..81de1eba --- /dev/null +++ b/cvo/put-azure-ha-working-environments-offbox.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-offbox.html' +summary: 'Activate the off-box configuration' +--- + += Activate the off-box configuration + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/offbox`# + + + +Activates an off-box configuration. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-working-environments-schedules.adoc b/cvo/put-azure-ha-working-environments-schedules.adoc new file mode 100644 index 00000000..0030e2b0 --- /dev/null +++ b/cvo/put-azure-ha-working-environments-schedules.adoc @@ -0,0 +1,167 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-schedules.html' +summary: 'Set schedules for Cloud Volumes ONTAP' +--- + += Set schedules for Cloud Volumes ONTAP + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/schedules`# + + + +Sets schedules for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-azure-ha-working-environments-set-password.adoc b/cvo/put-azure-ha-working-environments-set-password.adoc new file mode 100644 index 00000000..e528d5b2 --- /dev/null +++ b/cvo/put-azure-ha-working-environments-set-password.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-set-password.html' +summary: 'Set the cluster password for a system' +--- + += Set the cluster password for a system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/set-password`# + + + +Sets the cluster password for a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|occmOnly +|boolean +|query +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|password +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-working-environments-svm.adoc b/cvo/put-azure-ha-working-environments-svm.adoc new file mode 100644 index 00000000..be1c5816 --- /dev/null +++ b/cvo/put-azure-ha-working-environments-svm.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-svm.html' +summary: 'Modify the SVM name of the system' +--- + += Modify the SVM name of the system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/svm`# + + + +Modifies the SVM name of the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|svmNewName +|string +|False +a| + +|svmName +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "svmNewName": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-working-environments-update-credentials.adoc b/cvo/put-azure-ha-working-environments-update-credentials.adoc new file mode 100644 index 00000000..42081f5b --- /dev/null +++ b/cvo/put-azure-ha-working-environments-update-credentials.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-update-credentials.html' +summary: 'Update the NetApp Console password' +--- + += Update the NetApp Console password + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/update-credentials`# + + + +Updates the NetApp Console password for a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|False +a|Username + + +|password +|string +|True +a|Password + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "username": "string", + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-working-environments-user-tags.adoc b/cvo/put-azure-ha-working-environments-user-tags.adoc new file mode 100644 index 00000000..71bb5839 --- /dev/null +++ b/cvo/put-azure-ha-working-environments-user-tags.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-user-tags.html' +summary: 'Modify the user tags for cloud resources' +--- + += Modify the user tags for cloud resources + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/user-tags`# + + + +Modifies the user tags for cloud resources in a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tags +|array[link:#CloudResourceTag[CloudResourceTag]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tags": [ + { + "tagKey": "string", + "tagValue": "string" + } + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudResourceTag] +[.api-collapsible-fifth-title] +CloudResourceTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|True +a| + +|tagValue +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-azure-ha-working-environments-vscan-file-op.adoc b/cvo/put-azure-ha-working-environments-vscan-file-op.adoc new file mode 100644 index 00000000..2ce1ed4a --- /dev/null +++ b/cvo/put-azure-ha-working-environments-vscan-file-op.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-vscan-file-op.html' +summary: 'Update the default Vscan file operation profile' +--- + += Update the default Vscan file operation profile + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/vscan-file-op`# + + + +Updates the default Vscan file operation profile. Profiles on existing CIFS shares will change only on writes-only mode. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vscanFileOp +|string +|False +a|Vscan file-operation + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "vscanFileOp": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-ha-working-environments-writing-speed.adoc b/cvo/put-azure-ha-working-environments-writing-speed.adoc new file mode 100644 index 00000000..27134b79 --- /dev/null +++ b/cvo/put-azure-ha-working-environments-writing-speed.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-ha-working-environments-writing-speed.html' +summary: 'Set the writing speed' +--- + += Set the writing speed + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/ha/working-environments/{workingEnvironmentId}/writing-speed`# + + + +Sets the writing speed for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|writingSpeedState +|string +|False +a|Writing speed state + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "writingSpeedState": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-aggregates-.adoc b/cvo/put-azure-vsa-aggregates-.adoc new file mode 100644 index 00000000..4bfa4364 --- /dev/null +++ b/cvo/put-azure-vsa-aggregates-.adoc @@ -0,0 +1,73 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-aggregates-.html' +summary: 'Update IOPS and throughput for disks in an existing aggregate (single-node)' +--- + += Update IOPS and throughput for disks in an existing aggregate (single-node) + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}`# + + + +Updates IOPS and throughput for the disks in an existing aggregate. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|aggregateName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|iops +|integer +|True +a|New IOPS + + +|throughput +|integer +|True +a|New throughput + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-volumes--.adoc b/cvo/put-azure-vsa-volumes--.adoc new file mode 100644 index 00000000..d652f1bf --- /dev/null +++ b/cvo/put-azure-vsa-volumes--.adoc @@ -0,0 +1,474 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-volumes--.html' +summary: 'Modify an existing volume' +--- + += Modify an existing volume + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Modifies an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|comment +|string +|False +a|Comment + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + }, + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string", + "comment": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-azure-vsa-volumes--exportpolicy.adoc b/cvo/put-azure-vsa-volumes--exportpolicy.adoc new file mode 100644 index 00000000..b98f318b --- /dev/null +++ b/cvo/put-azure-vsa-volumes--exportpolicy.adoc @@ -0,0 +1,474 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-volumes--exportpolicy.html' +summary: 'Add an export policy rule' +--- + += Add an export policy rule + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy`# + + + +Adds an export policy rule. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|comment +|string +|False +a|Comment + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + }, + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string", + "comment": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-azure-vsa-working-environments-activate-fpolicy.adoc b/cvo/put-azure-vsa-working-environments-activate-fpolicy.adoc new file mode 100644 index 00000000..252c7e93 --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-activate-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-activate-fpolicy.html' +summary: 'Activate the FPolicy for ransomware files' +--- + += Activate the FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy`# + + + +Activates the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-working-environments-activate-snapshot-policy.adoc b/cvo/put-azure-vsa-working-environments-activate-snapshot-policy.adoc new file mode 100644 index 00000000..5747912d --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-activate-snapshot-policy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-activate-snapshot-policy.html' +summary: 'Activate snapshot policy assignment' +--- + += Activate snapshot policy assignment + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy`# + + + +Activates snapshot policy assignment for all unprotected read/write volumes. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-working-environments-byol-to-capacity.adoc b/cvo/put-azure-vsa-working-environments-byol-to-capacity.adoc new file mode 100644 index 00000000..d08853bf --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-byol-to-capacity.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-byol-to-capacity.html' +summary: 'Update the BYOL licence to a capacity-based license' +--- + += Update the BYOL licence to a capacity-based license + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity`# + + + +Updates a bring-your-own-license (BYOL) license to a capacity-based license for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityPackageName +|string +|True +a|Capacity based package + + +|sendAsup +|boolean +|True +a| + +|deleteByNodeByolLicense +|boolean +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serial1 +|string +|True +a| + +|serial2 +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serial1": "string", + "serial2": "string" +} +==== + diff --git a/cvo/put-azure-vsa-working-environments-disable-fpolicy.adoc b/cvo/put-azure-vsa-working-environments-disable-fpolicy.adoc new file mode 100644 index 00000000..bb9183d9 --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-disable-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-disable-fpolicy.html' +summary: 'Disable the FPolicy for ransomware files' +--- + += Disable the FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy`# + + + +Disables the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-working-environments-enable-worm.adoc b/cvo/put-azure-vsa-working-environments-enable-worm.adoc new file mode 100644 index 00000000..1e7e4b21 --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-enable-worm.adoc @@ -0,0 +1,95 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-enable-worm.html' +summary: 'Enable SnapLock for an existing system' +--- + += Enable SnapLock for an existing system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/enable-worm`# + + + +Enables SnapLock for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|retentionPeriod +|link:#WormRetentionPeriod[WormRetentionPeriod] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#WormRetentionPeriod] +[.api-collapsible-fifth-title] +WormRetentionPeriod + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|True +a|Length + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-azure-vsa-working-environments-extra-capacity-licenses.adoc b/cvo/put-azure-vsa-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..71a6791f --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-extra-capacity-licenses.html' +summary: 'Update extra capacity licenses' +--- + += Update extra capacity licenses + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Updates an extra capacity license. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licences +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licences": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-working-environments-extra-capacity-serials.adoc b/cvo/put-azure-vsa-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..a6802305 --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-extra-capacity-serials.html' +summary: 'Update extra capacity serial numbers' +--- + += Update extra capacity serial numbers + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Updates an extra capacity license serial number. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-working-environments-license-instance-type.adoc b/cvo/put-azure-vsa-working-environments-license-instance-type.adoc new file mode 100644 index 00000000..0ff8527d --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-license-instance-type.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-license-instance-type.html' +summary: 'Set the instance type' +--- + += Set the instance type + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/license-instance-type`# + + + +Sets the instance type of a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|True +a|New instance type + + +|licenseType +|string +|True +a|New license type + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceType": "string", + "licenseType": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-working-environments-networkoptimization.adoc b/cvo/put-azure-vsa-working-environments-networkoptimization.adoc new file mode 100644 index 00000000..73f658b2 --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-networkoptimization.adoc @@ -0,0 +1,60 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-networkoptimization.html' +summary: 'Modify the network port broadcast domain MTU' +--- + += Modify the network port broadcast domain MTU + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/networkOptimization`# + + + +Modifies the network port broadcast domain MTU of the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|optimize +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-working-environments-offbox.adoc b/cvo/put-azure-vsa-working-environments-offbox.adoc new file mode 100644 index 00000000..0b3fa13a --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-offbox.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-offbox.html' +summary: 'Activate an off-box configuration' +--- + += Activate an off-box configuration + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/offbox`# + + + +Activates an off-box configuration. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-working-environments-schedules.adoc b/cvo/put-azure-vsa-working-environments-schedules.adoc new file mode 100644 index 00000000..5006fbe2 --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-schedules.adoc @@ -0,0 +1,167 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-schedules.html' +summary: 'Set the schedules for Cloud Volumes ONTAP' +--- + += Set the schedules for Cloud Volumes ONTAP + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/schedules`# + + + +Sets schedules for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-azure-vsa-working-environments-set-password.adoc b/cvo/put-azure-vsa-working-environments-set-password.adoc new file mode 100644 index 00000000..67313c8f --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-set-password.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-set-password.html' +summary: 'Set the cluster password for a Cloud Volumes ONTAP system' +--- + += Set the cluster password for a Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/set-password`# + + + +Sets the cluster password for a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|occmOnly +|boolean +|query +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|password +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-working-environments-svm.adoc b/cvo/put-azure-vsa-working-environments-svm.adoc new file mode 100644 index 00000000..e811a9ea --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-svm.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-svm.html' +summary: 'Modify the SVM name' +--- + += Modify the SVM name + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/svm`# + + + +Modifies the SVM name of the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|svmNewName +|string +|False +a| + +|svmName +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "svmNewName": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-working-environments-update-credentials.adoc b/cvo/put-azure-vsa-working-environments-update-credentials.adoc new file mode 100644 index 00000000..d9f61df1 --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-update-credentials.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-update-credentials.html' +summary: 'Update the NetApp Console password' +--- + += Update the NetApp Console password + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/update-credentials`# + + + +Updates the NetApp Console password for a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|False +a|Username + + +|password +|string +|True +a|Password + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "username": "string", + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-working-environments-user-tags.adoc b/cvo/put-azure-vsa-working-environments-user-tags.adoc new file mode 100644 index 00000000..389a5853 --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-user-tags.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-user-tags.html' +summary: 'Modify user tags for cloud resources' +--- + += Modify user tags for cloud resources + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/user-tags`# + + + +Modifies the user tags for cloud resources in a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tags +|array[link:#CloudResourceTag[CloudResourceTag]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tags": [ + { + "tagKey": "string", + "tagValue": "string" + } + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudResourceTag] +[.api-collapsible-fifth-title] +CloudResourceTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|True +a| + +|tagValue +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-azure-vsa-working-environments-vscan-file-op.adoc b/cvo/put-azure-vsa-working-environments-vscan-file-op.adoc new file mode 100644 index 00000000..c2aca16c --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-vscan-file-op.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-vscan-file-op.html' +summary: 'Update the default Vscan file operation profile' +--- + += Update the default Vscan file operation profile + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/vscan-file-op`# + + + +Updates the default Vscan file operation profile. Profiles on existing CIFS shares will change only on writes-only mode. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vscanFileOp +|string +|False +a|Vscan file-operation + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "vscanFileOp": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-azure-vsa-working-environments-writing-speed.adoc b/cvo/put-azure-vsa-working-environments-writing-speed.adoc new file mode 100644 index 00000000..3cd06bb3 --- /dev/null +++ b/cvo/put-azure-vsa-working-environments-writing-speed.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-azure-vsa-working-environments-writing-speed.html' +summary: 'Modify the writing speed' +--- + += Modify the writing speed + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/azure/vsa/working-environments/{workingEnvironmentId}/writing-speed`# + + + +Sets the writing speed for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|writingSpeedState +|string +|False +a|Writing speed state + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "writingSpeedState": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-flexcache-caches-.adoc b/cvo/put-flexcache-caches-.adoc new file mode 100644 index 00000000..c40294a3 --- /dev/null +++ b/cvo/put-flexcache-caches-.adoc @@ -0,0 +1,113 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-flexcache-caches-.html' +summary: 'Modify a FlexCache volume' +--- + += Modify a FlexCache volume + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/flexcache/{workingEnvironmentId}/caches/{cacheId}`# + + + +Modifies a FlexCache volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|cacheId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|FlexCache volume name + + +|cacheVolumeSize +|link:#cacheVolumeSize[cacheVolumeSize] +|False +a|FlexCache size + + +|junctionPath +|string +|False +a|FlexCache volume junction path + + +|exportPolicy +|string +|False +a|FlexCache NFS export policy + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "junctionPath": "string", + "exportPolicy": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#cacheVolumeSize] +[.api-collapsible-fifth-title] +cacheVolumeSize + +FlexCache size + + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-fsx-volumes--.adoc b/cvo/put-fsx-volumes--.adoc new file mode 100644 index 00000000..a15e581b --- /dev/null +++ b/cvo/put-fsx-volumes--.adoc @@ -0,0 +1,406 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-fsx-volumes--.html' +summary: 'Modify an existing volume' +--- + += Modify an existing volume + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}`# + + + +Modifies an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|fileSystemId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|fileSystemId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + } +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-gcp-ha-aggregates-.adoc b/cvo/put-gcp-ha-aggregates-.adoc new file mode 100644 index 00000000..69ae64b6 --- /dev/null +++ b/cvo/put-gcp-ha-aggregates-.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-aggregates-.html' +summary: 'Update IOPS and throughput for the disks in an existing Cloud Volumes ONTAP aggregate' +--- + += Update IOPS and throughput for the disks in an existing Cloud Volumes ONTAP aggregate + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/aggregates/{workingEnvironmentId}/{aggregateName}`# + + + +Updates IOPS and throughput for the disks in an existing aggregate. At least one of the parameters is required. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a|The public ID of the system + + +|aggregateName +|string +|path +|True +a|The aggregate to update + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|iops +|integer +|False +a|New IOPS + + +|throughput +|integer +|False +a|New Throughput + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-ha-volumes--.adoc b/cvo/put-gcp-ha-volumes--.adoc new file mode 100644 index 00000000..141fcba3 --- /dev/null +++ b/cvo/put-gcp-ha-volumes--.adoc @@ -0,0 +1,474 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-volumes--.html' +summary: 'Modify a volume' +--- + += Modify a volume + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Modifies an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|comment +|string +|False +a|Comment + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + }, + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string", + "comment": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-gcp-ha-volumes--exportpolicy.adoc b/cvo/put-gcp-ha-volumes--exportpolicy.adoc new file mode 100644 index 00000000..6495a13e --- /dev/null +++ b/cvo/put-gcp-ha-volumes--exportpolicy.adoc @@ -0,0 +1,474 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-volumes--exportpolicy.html' +summary: 'Add an export policy rule' +--- + += Add an export policy rule + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy`# + + + +Adds an export policy rule. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|comment +|string +|False +a|Comment + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + }, + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string", + "comment": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-gcp-ha-working-environments-activate-fpolicy.adoc b/cvo/put-gcp-ha-working-environments-activate-fpolicy.adoc new file mode 100644 index 00000000..7e50af77 --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-activate-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-activate-fpolicy.html' +summary: 'Activate FPolicy for ransomware files' +--- + += Activate FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/activate-fpolicy`# + + + +Activates the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-ha-working-environments-activate-snapshot-policy.adoc b/cvo/put-gcp-ha-working-environments-activate-snapshot-policy.adoc new file mode 100644 index 00000000..785163fe --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-activate-snapshot-policy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-activate-snapshot-policy.html' +summary: 'Activate snapshot policy assignment for unprotected read/write volumes' +--- + += Activate snapshot policy assignment for unprotected read/write volumes + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy`# + + + +Activates snapshot policy assignment for all unprotected read/write volumes. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-ha-working-environments-byol-to-capacity.adoc b/cvo/put-gcp-ha-working-environments-byol-to-capacity.adoc new file mode 100644 index 00000000..40d856a4 --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-byol-to-capacity.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-byol-to-capacity.html' +summary: 'Update a BYOL license to a capacity-based license' +--- + += Update a BYOL license to a capacity-based license + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/byol-to-capacity`# + + + +Updates a bring-your-own-license (BYOL) license to a capacity-based license for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityPackageName +|string +|True +a|Capacity based package + + +|sendAsup +|boolean +|True +a| + +|deleteByNodeByolLicense +|boolean +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serial1 +|string +|True +a| + +|serial2 +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serial1": "string", + "serial2": "string" +} +==== + diff --git a/cvo/put-gcp-ha-working-environments-disable-fpolicy.adoc b/cvo/put-gcp-ha-working-environments-disable-fpolicy.adoc new file mode 100644 index 00000000..2dd2185f --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-disable-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-disable-fpolicy.html' +summary: 'Disable FPolicy for ransomware files' +--- + += Disable FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/disable-fpolicy`# + + + +Disables the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-ha-working-environments-enable-worm.adoc b/cvo/put-gcp-ha-working-environments-enable-worm.adoc new file mode 100644 index 00000000..aced09d0 --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-enable-worm.adoc @@ -0,0 +1,95 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-enable-worm.html' +summary: 'Enable SnapLock on a system' +--- + += Enable SnapLock on a system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/enable-worm`# + + + +Enables SnapLock for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|retentionPeriod +|link:#WormRetentionPeriod[WormRetentionPeriod] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#WormRetentionPeriod] +[.api-collapsible-fifth-title] +WormRetentionPeriod + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|True +a|Length + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-gcp-ha-working-environments-extra-capacity-licenses.adoc b/cvo/put-gcp-ha-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..0ccc1466 --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-extra-capacity-licenses.html' +summary: 'Update extra capacity licenses' +--- + += Update extra capacity licenses + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Updates an extra capacity license. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licences +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licences": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-ha-working-environments-extra-capacity-serials.adoc b/cvo/put-gcp-ha-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..0c6fc0d1 --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-extra-capacity-serials.html' +summary: 'Update extra capacity license serial numbers' +--- + += Update extra capacity license serial numbers + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Updates an extra capacity license serial number. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-ha-working-environments-license-instance-type.adoc b/cvo/put-gcp-ha-working-environments-license-instance-type.adoc new file mode 100644 index 00000000..8613fa5f --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-license-instance-type.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-license-instance-type.html' +summary: 'Set the instance type' +--- + += Set the instance type + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/license-instance-type`# + + + +Sets the instance type of a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|True +a|New instance type + + +|licenseType +|string +|True +a|New license type + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceType": "string", + "licenseType": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-ha-working-environments-networkoptimization.adoc b/cvo/put-gcp-ha-working-environments-networkoptimization.adoc new file mode 100644 index 00000000..394b722a --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-networkoptimization.adoc @@ -0,0 +1,60 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-networkoptimization.html' +summary: 'Modify the network port broadcast domain MTU' +--- + += Modify the network port broadcast domain MTU + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/networkOptimization`# + + + +Modifies the network port broadcast domain MTU of the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|optimize +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-ha-working-environments-offbox.adoc b/cvo/put-gcp-ha-working-environments-offbox.adoc new file mode 100644 index 00000000..f9b2e2dc --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-offbox.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-offbox.html' +summary: 'Activate an off-box configuration' +--- + += Activate an off-box configuration + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/offbox`# + + + +Activates an off-box configuration. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-ha-working-environments-schedules.adoc b/cvo/put-gcp-ha-working-environments-schedules.adoc new file mode 100644 index 00000000..6acceff0 --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-schedules.adoc @@ -0,0 +1,167 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-schedules.html' +summary: 'Set the schedules for Cloud Volumes ONTAP' +--- + += Set the schedules for Cloud Volumes ONTAP + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/schedules`# + + + +Sets schedules for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-gcp-ha-working-environments-set-password.adoc b/cvo/put-gcp-ha-working-environments-set-password.adoc new file mode 100644 index 00000000..960669aa --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-set-password.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-set-password.html' +summary: 'Set the cluster password for a system' +--- + += Set the cluster password for a system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/set-password`# + + + +Sets the cluster password for a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|occmOnly +|boolean +|query +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|password +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-ha-working-environments-svm.adoc b/cvo/put-gcp-ha-working-environments-svm.adoc new file mode 100644 index 00000000..5da40edb --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-svm.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-svm.html' +summary: 'Modify the SVM name of the Cloud Volumes ONTAP system' +--- + += Modify the SVM name of the Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/svm`# + + + +Modifies the SVM name of the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|svmNewName +|string +|False +a| + +|svmName +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "svmNewName": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-ha-working-environments-update-credentials.adoc b/cvo/put-gcp-ha-working-environments-update-credentials.adoc new file mode 100644 index 00000000..82bf02dc --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-update-credentials.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-update-credentials.html' +summary: 'Update the NetApp Console password' +--- + += Update the NetApp Console password + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/update-credentials`# + + + +Updates the NetApp Console password for a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|False +a|Username + + +|password +|string +|True +a|Password + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "username": "string", + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-ha-working-environments-user-tags.adoc b/cvo/put-gcp-ha-working-environments-user-tags.adoc new file mode 100644 index 00000000..5443cb16 --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-user-tags.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-user-tags.html' +summary: 'Modify user tags for cloud resources' +--- + += Modify user tags for cloud resources + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/user-tags`# + + + +Modifies the user tags for cloud resources in a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tags +|array[link:#CloudResourceTag[CloudResourceTag]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tags": [ + { + "tagKey": "string", + "tagValue": "string" + } + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudResourceTag] +[.api-collapsible-fifth-title] +CloudResourceTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|True +a| + +|tagValue +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-gcp-ha-working-environments-vscan-file-op.adoc b/cvo/put-gcp-ha-working-environments-vscan-file-op.adoc new file mode 100644 index 00000000..dbff3618 --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-vscan-file-op.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-vscan-file-op.html' +summary: 'Update the default Vscan file operation profile' +--- + += Update the default Vscan file operation profile + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/vscan-file-op`# + + + +Updates the default Vscan file operation profile. Profiles on existing CIFS shares will change only on writes-only mode. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vscanFileOp +|string +|False +a|Vscan file-operation + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "vscanFileOp": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-ha-working-environments-writing-speed.adoc b/cvo/put-gcp-ha-working-environments-writing-speed.adoc new file mode 100644 index 00000000..6a4a547f --- /dev/null +++ b/cvo/put-gcp-ha-working-environments-writing-speed.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-ha-working-environments-writing-speed.html' +summary: 'Modify the writing speed for a system' +--- + += Modify the writing speed for a system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/ha/working-environments/{workingEnvironmentId}/writing-speed`# + + + +Sets the writing speed for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|writingSpeedState +|string +|False +a|Writing speed state + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "writingSpeedState": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-aggregates-.adoc b/cvo/put-gcp-vsa-aggregates-.adoc new file mode 100644 index 00000000..f98a657d --- /dev/null +++ b/cvo/put-gcp-vsa-aggregates-.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-aggregates-.html' +summary: 'Update IOPS and throughput for the disks in an existing Cloud Volumes ONTAP aggregate' +--- + += Update IOPS and throughput for the disks in an existing Cloud Volumes ONTAP aggregate + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName}`# + + + +Updates IOPS and throughput for the disks in an existing aggregate. At least one of the parameters is required. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a|The public ID of the system + + +|aggregateName +|string +|path +|True +a|The name of the aggregate to update + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|iops +|integer +|False +a|New IOPS + + +|throughput +|integer +|False +a|New Throughput + + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-volumes--.adoc b/cvo/put-gcp-vsa-volumes--.adoc new file mode 100644 index 00000000..2b82f07b --- /dev/null +++ b/cvo/put-gcp-vsa-volumes--.adoc @@ -0,0 +1,474 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-volumes--.html' +summary: 'Modify a volume' +--- + += Modify a volume + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Modifies an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|comment +|string +|False +a|Comment + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + }, + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string", + "comment": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-gcp-vsa-volumes--exportpolicy.adoc b/cvo/put-gcp-vsa-volumes--exportpolicy.adoc new file mode 100644 index 00000000..659e6f2e --- /dev/null +++ b/cvo/put-gcp-vsa-volumes--exportpolicy.adoc @@ -0,0 +1,474 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-volumes--exportpolicy.html' +summary: 'Add an export policy rule' +--- + += Add an export policy rule + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy`# + + + +Adds an export policy rule. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|comment +|string +|False +a|Comment + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + }, + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string", + "comment": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-gcp-vsa-working-environments-activate-fpolicy.adoc b/cvo/put-gcp-vsa-working-environments-activate-fpolicy.adoc new file mode 100644 index 00000000..ac879afc --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-activate-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-activate-fpolicy.html' +summary: 'Activate the FPolicy for ransomware files' +--- + += Activate the FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy`# + + + +Activates the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-working-environments-activate-snapshot-policy.adoc b/cvo/put-gcp-vsa-working-environments-activate-snapshot-policy.adoc new file mode 100644 index 00000000..59d783f6 --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-activate-snapshot-policy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-activate-snapshot-policy.html' +summary: 'Activate snapshot policy assignment' +--- + += Activate snapshot policy assignment + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy`# + + + +Activates snapshot policy assignment for all unprotected read/write volumes. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-working-environments-byol-to-capacity.adoc b/cvo/put-gcp-vsa-working-environments-byol-to-capacity.adoc new file mode 100644 index 00000000..5b4a6069 --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-byol-to-capacity.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-byol-to-capacity.html' +summary: 'Update a BYOL licence to a capacity-based license' +--- + += Update a BYOL licence to a capacity-based license + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity`# + + + +Updates a bring-your-own-license (BYOL) license to a capacity-based license for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityPackageName +|string +|True +a|Capacity based package + + +|sendAsup +|boolean +|True +a| + +|deleteByNodeByolLicense +|boolean +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serial1 +|string +|True +a| + +|serial2 +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serial1": "string", + "serial2": "string" +} +==== + diff --git a/cvo/put-gcp-vsa-working-environments-disable-fpolicy.adoc b/cvo/put-gcp-vsa-working-environments-disable-fpolicy.adoc new file mode 100644 index 00000000..f73b4512 --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-disable-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-disable-fpolicy.html' +summary: 'Disable the FPolicy for ransomware files' +--- + += Disable the FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy`# + + + +Disables the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-working-environments-enable-worm.adoc b/cvo/put-gcp-vsa-working-environments-enable-worm.adoc new file mode 100644 index 00000000..c7d8a14c --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-enable-worm.adoc @@ -0,0 +1,95 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-enable-worm.html' +summary: 'Enable SnapLock for a system' +--- + += Enable SnapLock for a system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/enable-worm`# + + + +Enables SnapLock for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|retentionPeriod +|link:#WormRetentionPeriod[WormRetentionPeriod] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#WormRetentionPeriod] +[.api-collapsible-fifth-title] +WormRetentionPeriod + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|True +a|Length + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-gcp-vsa-working-environments-extra-capacity-licenses.adoc b/cvo/put-gcp-vsa-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..5a1fe8a8 --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-extra-capacity-licenses.html' +summary: 'Update extra capacity licenses' +--- + += Update extra capacity licenses + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Updates an extra capacity license. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licences +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licences": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-working-environments-extra-capacity-serials.adoc b/cvo/put-gcp-vsa-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..59533c5e --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-extra-capacity-serials.html' +summary: 'Update extra capacity serial numbers' +--- + += Update extra capacity serial numbers + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Updates an extra capacity license serial number. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-working-environments-license-instance-type.adoc b/cvo/put-gcp-vsa-working-environments-license-instance-type.adoc new file mode 100644 index 00000000..d3d27c42 --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-license-instance-type.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-license-instance-type.html' +summary: 'Set the instance type' +--- + += Set the instance type + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/license-instance-type`# + + + +Sets the instance type of a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|True +a|New instance type + + +|licenseType +|string +|True +a|New license type + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceType": "string", + "licenseType": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-working-environments-networkoptimization.adoc b/cvo/put-gcp-vsa-working-environments-networkoptimization.adoc new file mode 100644 index 00000000..b9ee8684 --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-networkoptimization.adoc @@ -0,0 +1,60 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-networkoptimization.html' +summary: 'Modify the network port broadcast domain MTU' +--- + += Modify the network port broadcast domain MTU + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/networkOptimization`# + + + +Modifies the network port broadcast domain MTU of the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|optimize +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-working-environments-offbox.adoc b/cvo/put-gcp-vsa-working-environments-offbox.adoc new file mode 100644 index 00000000..2a43698f --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-offbox.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-offbox.html' +summary: 'Activate an offbox configuration' +--- + += Activate an offbox configuration + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/offbox`# + + + +Activates an off-box configuration. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-working-environments-schedules.adoc b/cvo/put-gcp-vsa-working-environments-schedules.adoc new file mode 100644 index 00000000..c2824d14 --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-schedules.adoc @@ -0,0 +1,167 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-schedules.html' +summary: 'Set the schedules for Cloud Volumes ONTAP' +--- + += Set the schedules for Cloud Volumes ONTAP + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/schedules`# + + + +Sets schedules for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-gcp-vsa-working-environments-set-password.adoc b/cvo/put-gcp-vsa-working-environments-set-password.adoc new file mode 100644 index 00000000..06242d66 --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-set-password.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-set-password.html' +summary: 'Set the cluster password' +--- + += Set the cluster password + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/set-password`# + + + +Sets the cluster password for a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|occmOnly +|boolean +|query +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|password +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-working-environments-svm.adoc b/cvo/put-gcp-vsa-working-environments-svm.adoc new file mode 100644 index 00000000..10465e18 --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-svm.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-svm.html' +summary: 'Modify the SVM name' +--- + += Modify the SVM name + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/svm`# + + + +Modifies the SVM name of the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|svmNewName +|string +|False +a| + +|svmName +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "svmNewName": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-working-environments-update-credentials.adoc b/cvo/put-gcp-vsa-working-environments-update-credentials.adoc new file mode 100644 index 00000000..79c73a14 --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-update-credentials.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-update-credentials.html' +summary: 'Update the NetApp Console password' +--- + += Update the NetApp Console password + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/update-credentials`# + + + +Updates the NetApp Console password for a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|False +a|Username + + +|password +|string +|True +a|Password + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "username": "string", + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-working-environments-user-tags.adoc b/cvo/put-gcp-vsa-working-environments-user-tags.adoc new file mode 100644 index 00000000..ca00dbd0 --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-user-tags.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-user-tags.html' +summary: 'Modify user tags for cloud resources' +--- + += Modify user tags for cloud resources + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/user-tags`# + + + +Modifies the user tags for cloud resources in a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tags +|array[link:#CloudResourceTag[CloudResourceTag]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tags": [ + { + "tagKey": "string", + "tagValue": "string" + } + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudResourceTag] +[.api-collapsible-fifth-title] +CloudResourceTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|True +a| + +|tagValue +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-gcp-vsa-working-environments-vscan-file-op.adoc b/cvo/put-gcp-vsa-working-environments-vscan-file-op.adoc new file mode 100644 index 00000000..4bff6d3c --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-vscan-file-op.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-vscan-file-op.html' +summary: 'Update the default Vscan file operation profile' +--- + += Update the default Vscan file operation profile + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/vscan-file-op`# + + + +Updates the default Vscan file operation profile. Profiles on existing CIFS shares will change only on writes-only mode. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vscanFileOp +|string +|False +a|Vscan file-operation + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "vscanFileOp": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-gcp-vsa-working-environments-writing-speed.adoc b/cvo/put-gcp-vsa-working-environments-writing-speed.adoc new file mode 100644 index 00000000..ee7c95c0 --- /dev/null +++ b/cvo/put-gcp-vsa-working-environments-writing-speed.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-gcp-vsa-working-environments-writing-speed.html' +summary: 'Set the writing speed' +--- + += Set the writing speed + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/gcp/vsa/working-environments/{workingEnvironmentId}/writing-speed`# + + + +Sets the writing speed for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|writingSpeedState +|string +|False +a|Writing speed state + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "writingSpeedState": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-occm-asup.adoc b/cvo/put-occm-asup.adoc new file mode 100644 index 00000000..d0cd9d06 --- /dev/null +++ b/cvo/put-occm-asup.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-occm-asup.html' +summary: 'Update the AutoSupport configuration' +--- + += Update the AutoSupport configuration + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/occm/asup`# + + + +Updates the AutoSupport configuration. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|enabled +|boolean +|True +a| + +|schedule +|link:#AsupSchedule[AsupSchedule] +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#AsupInterval] +[.api-collapsible-fifth-title] +AsupInterval + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|False +a| + +|unit +|string +|False +a| + +|=== + + +[#AsupSchedule] +[.api-collapsible-fifth-title] +AsupSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|dayOfWeek +|integer +|True +a| + +|hourOfDay +|integer +|False +a| + +|interval +|link:#AsupInterval[AsupInterval] +|True +a| + +|minuteOfHour +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-occm-config.adoc b/cvo/put-occm-config.adoc new file mode 100644 index 00000000..b6b7762e --- /dev/null +++ b/cvo/put-occm-config.adoc @@ -0,0 +1,532 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-occm-config.html' +summary: 'Configure modifiable NetApp Console parameters' +--- + += Configure modifiable NetApp Console parameters + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/occm/config`# + + + +Configures modifiable NetApp Console parameters. + + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|simplicatorUri +|link:#Uri[Uri] +|False +a| + +|proxyUri +|string +|False +a| + +|debugLogLevel +|link:#NonEmptyOptionalString[NonEmptyOptionalString] +|False +a| + +|cacheConfig +|string +|False +a| + +|pollingIntervalSeconds +|integer +|True +a| + +|startInstanceDelaySeconds +|integer +|False +a| + +|assignDisksDelaySeconds +|integer +|False +a| + +|modifyInstanceTypeDelaySeconds +|integer +|False +a| + +|keyManagerPort +|integer +|False +a| + +|maxAggregateFreeSpacePercentage +|integer +|False +a| + +|ontapSpaceOverheadPercentage +|integer +|False +a| + +|maxVolumeGrowSizePercentage +|integer +|False +a| + +|autoVsaCapacityManagement +|boolean +|False +a| + +|proxyUserName +|string +|False +a| + +|proxyPassword +|string +|False +a| + +|proxyDomain +|string +|False +a| + +|autoUpgrade +|boolean +|False +a| + +|cotRollback +|boolean +|False +a| + +|s3EbsRatio +|integer +|False +a| + +|autoOntapUpgrade +|boolean +|False +a| + +|sysMgrUserCred +|boolean +|False +a| + +|gcpInfrastructureManager +|boolean +|False +a| + +|overrideCifsLocks +|boolean +|False +a| + +|usePrivateLink +|boolean +|False +a| + +|directApiTraffic +|boolean +|False +a| + +|useAccelerationForImageDownload +|boolean +|False +a| + +|maxDownloadSessions +|integer +|False +a| + +|rollbackOnAzurePrivateLinkFailure +|boolean +|False +a| + +|gcpBlockProjectSshKeys +|boolean +|False +a| + +|gcpSerialPortEnable +|boolean +|False +a| + +|gcpEnableOsLogin +|boolean +|False +a| + +|gcpEnableOsLoginSk +|boolean +|False +a| + +|enableColdDataReportingOnStartup +|boolean +|False +a| + +|proxyMode +|string +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|simplicatorUri +|string +|True +a| + +|proxyUri +|string +|False +a| + +|debugLogLevel +|string +|False +a| + +|cacheConfig +|string +|False +a| + +|keyManagerPort +|integer +|True +a| + +|ipaManualUrl +|string +|False +a| + +|certificateValidityPeriod +|integer +|False +a| + +|maxAggregateFreeSpacePercentage +|integer +|False +a| + +|maxEvAggregateFreeSpacePercentage +|integer +|False +a| + +|asupSite +|string +|False +a| + +|asupCompany +|string +|False +a| + +|maxVolumeGrowSizePercentage +|integer +|False +a| + +|autoVsaCapacityManagement +|boolean +|True +a| + +|enableColdDataReportingOnStartup +|boolean +|False +a| + +|useVolumeViewAsDefault +|boolean +|False +a| + +|proxyUserName +|string +|False +a| + +|proxyPassword +|string +|False +a| + +|proxyDomain +|string +|False +a| + +|autoUpgrade +|boolean +|False +a| + +|cotRollback +|boolean +|False +a| + +|cloudSyncConstants +|link:#CloudSyncConstants[CloudSyncConstants] +|True +a| + +|licenseMaxCapacityUsedPercentage +|integer +|False +a| + +|s3EbsRatio +|integer +|False +a| + +|ebsSizeToPiopsRatio +|integer +|False +a| + +|autoOntapUpgrade +|boolean +|False +a| + +|sysMgrUserCred +|boolean +|False +a| + +|gcpInfrastructureManager +|boolean +|False +a| + +|overrideCifsLocks +|boolean +|False +a| + +|usePrivateLink +|boolean +|False +a| + +|directApiTraffic +|boolean +|False +a| + +|useAccelerationForImageDownload +|boolean +|False +a| + +|maxDownloadSessions +|integer +|False +a| + +|rollbackOnAzurePrivateLinkFailure +|boolean +|False +a| + +|gcpInstanceMetadataItems +|link:#GcpInstanceMetadataItems[GcpInstanceMetadataItems] +|False +a| + +|userPrivateDnsZoneSettings +|link:#UserPrivateDnsZoneSettings[UserPrivateDnsZoneSettings] +|False +a| + +|proxyMode +|string +|False +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Uri] +[.api-collapsible-fifth-title] +Uri + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|=== + + +[#NonEmptyOptionalString] +[.api-collapsible-fifth-title] +NonEmptyOptionalString + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|False +a| + +|=== + + +[#CloudSyncConstants] +[.api-collapsible-fifth-title] +CloudSyncConstants + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|reminderPeriod +|integer +|False +a| + +|warningPeriod +|integer +|False +a| + +|=== + + +[#GcpInstanceMetadataItems] +[.api-collapsible-fifth-title] +GcpInstanceMetadataItems + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|blockProjectSshKeys +|boolean +|False +a| + +|serialPortEnable +|boolean +|False +a| + +|enableOsLogin +|boolean +|False +a| + +|enableOsLoginSk +|boolean +|False +a| + +|=== + + +[#UserPrivateDnsZoneSettings] +[.api-collapsible-fifth-title] +UserPrivateDnsZoneSettings + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|useExisting +|boolean +|False +a| + +|resourceGroup +|string +|False +a| + +|subscription +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-occm-encryption-key-managers-.adoc b/cvo/put-occm-encryption-key-managers-.adoc new file mode 100644 index 00000000..9441f96d --- /dev/null +++ b/cvo/put-occm-encryption-key-managers-.adoc @@ -0,0 +1,174 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-occm-encryption-key-managers-.html' +summary: 'Update an existing key manager' +--- + += Update an existing key manager + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/occm/encryption/key-managers/{keyManagerId}`# + + + +Updates an existing key manager. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|keyManagerId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|link:#NonEmptyOptionalString[NonEmptyOptionalString] +|False +a| + +|usernameValue +|link:#NonEmptyOptionalString[NonEmptyOptionalString] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "address": "string", + "usernameField": { + "_1": "string" + }, + "usernameValue": { + "_1": "string" + } +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|False +a| + +|name +|string +|False +a| + +|address +|string +|False +a| + +|usernameField +|string +|False +a| + +|usernameValue +|string +|False +a| + +|status +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "publicId": "string", + "name": "string", + "address": "string", + "usernameField": "string", + "usernameValue": "string", + "status": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#NonEmptyOptionalString] +[.api-collapsible-fifth-title] +NonEmptyOptionalString + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-occm-saas-mp-service-attach-subscription-.adoc b/cvo/put-occm-saas-mp-service-attach-subscription-.adoc new file mode 100644 index 00000000..f6d5b37d --- /dev/null +++ b/cvo/put-occm-saas-mp-service-attach-subscription-.adoc @@ -0,0 +1,76 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-occm-saas-mp-service-attach-subscription-.html' +summary: 'Attach a SaaS subscription' +--- + += Attach a SaaS subscription + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/occm/saas-mp-service/attach-subscription/{provider}/{cloudAccountId}`# + + + +Attaches a SaaS subscription to a cloud provider account. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudAccountId +|string +|path +|True +a| + +|provider +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|True +a|SaaS marketplace subscription ID + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "subscriptionId": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-onprem-volumes--.adoc b/cvo/put-onprem-volumes--.adoc new file mode 100644 index 00000000..243517d5 --- /dev/null +++ b/cvo/put-onprem-volumes--.adoc @@ -0,0 +1,412 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-onprem-volumes--.html' +summary: 'Modify an existing volume' +--- + += Modify an existing volume + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Modifies an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + }, + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-onprem-working-environments-update-credentials.adoc b/cvo/put-onprem-working-environments-update-credentials.adoc new file mode 100644 index 00000000..292fe8c9 --- /dev/null +++ b/cvo/put-onprem-working-environments-update-credentials.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-onprem-working-environments-update-credentials.html' +summary: 'Modify the NetApp Console password' +--- + += Modify the NetApp Console password + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/onprem/working-environments/{workingEnvironmentId}/update-credentials`# + + + +Updates the NetApp Console password for an on-premises system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|False +a|Username + + +|password +|string +|True +a|Password + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "username": "string", + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-replication--.adoc b/cvo/put-replication--.adoc new file mode 100644 index 00000000..4abd862b --- /dev/null +++ b/cvo/put-replication--.adoc @@ -0,0 +1,88 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-replication--.html' +summary: 'Modify a SnapMirror replication relationship' +--- + += Modify a SnapMirror replication relationship + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/replication/{workingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}`# + + + +Updates a SnapMirror replication relationship. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|destinationSvmName +|string +|path +|True +a| + +|destinationVolumeName +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|schedule +|string +|False +a|New replication schedule name + + +|maxTransferRate +|integer +|False +a|New maximum transfer rate limit (KB/s). Use 0 for no limit, otherwise use a number between 1024 and 2,147,482,624. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "schedule": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-tenants-.adoc b/cvo/put-tenants-.adoc new file mode 100644 index 00000000..5e6eb484 --- /dev/null +++ b/cvo/put-tenants-.adoc @@ -0,0 +1,186 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-tenants-.html' +summary: 'Update an existing tenant' +--- + += Update an existing tenant + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/tenants/{tenantId}`# + + + +Updates an existing tenant. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|tenantId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Tenant name + + +|description +|string +|False +a|Tenant description + + +|costCenter +|string +|False +a|Tenant cost center + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "description": "string", + "costCenter": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|publicId +|string +|False +a| + +|workingEnvironmentsInformation +|link:#WorkingEnvironmentsInformation[WorkingEnvironmentsInformation] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "publicId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#WorkingEnvironmentsInformation] +[.api-collapsible-fifth-title] +WorkingEnvironmentsInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionsCount +|integer +|False +a|Number of regions for which systems exist over this tenant + + +|totalReservedSize +|link:#Capacity[Capacity] +|False +a| + +|workingEnvironmentsCount +|integer +|False +a|Number of systems created over this tenant + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-tenants-nss-keys.adoc b/cvo/put-tenants-nss-keys.adoc new file mode 100644 index 00000000..73845586 --- /dev/null +++ b/cvo/put-tenants-nss-keys.adoc @@ -0,0 +1,179 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-tenants-nss-keys.html' +summary: 'Link a tenant to a NetApp support site account' +--- + += Link a tenant to a NetApp support site account + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/tenants/{tenantId}/nss-keys`# + + + +Links an existing tenant to a NetApp Support Site account. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|tenantId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nssUserName +|string +|False +a|NetApp Support Site user name + + +|nssPassword +|string +|False +a|NetApp Support Site password + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nssUserName": "string", + "nssPassword": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|publicId +|string +|False +a| + +|workingEnvironmentsInformation +|link:#WorkingEnvironmentsInformation[WorkingEnvironmentsInformation] +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string", + "publicId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#WorkingEnvironmentsInformation] +[.api-collapsible-fifth-title] +WorkingEnvironmentsInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regionsCount +|integer +|False +a|Number of regions for which systems exist over this tenant + + +|totalReservedSize +|link:#Capacity[Capacity] +|False +a| + +|workingEnvironmentsCount +|integer +|False +a|Number of systems created over this tenant + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-users-.adoc b/cvo/put-users-.adoc new file mode 100644 index 00000000..f3b30630 --- /dev/null +++ b/cvo/put-users-.adoc @@ -0,0 +1,291 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-users-.html' +summary: 'Update an existing user' +--- + += Update an existing user + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/users/{userId}`# + + + +Updates an existing user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|userId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|firstName +|string +|False +a|The first name of the user + + +|lastName +|string +|False +a|The last name of the user + + +|email +|string +|False +a|The email address of the user + + +|ldapUserName +|string +|False +a|Active Directory user name + + +|notificationsOptIn +|boolean +|False +a|Email notifications opt-in + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "firstName": "string", + "lastName": "string", + "email": "string", + "ldapUserName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|User public ID + + +|assignedWorkingEnvironments +|array[string] +|True +a|List of public IDs for all of the systems visible to the user + + +|firstName +|string +|True +a|The first name of the user + + +|lastName +|string +|True +a|The last name of the user + + +|email +|string +|True +a|The email address of the user + + +|roleId +|string +|True +a|Role ID of the user + + +|tenantId +|string +|True +a|Tenant ID of the user + + +|createdWorkingEnvironments +|array[link:#UserWorkingEnvironmentResponse[UserWorkingEnvironmentResponse]] +|True +a|List of all systems created by the user + + +|azureCredentials +|link:#AzureCredentials[AzureCredentials] +|False +a| + +|cloudSyncLicenseInformation +|link:#CloudSyncLicenseInformation[CloudSyncLicenseInformation] +|False +a| + +|isLdap +|boolean +|True +a|Indicates whether the user is an LDAP user + + +|ldapUserName +|string +|True +a|The LDAP user name + + +|notificationsOptIn +|boolean +|True +a|Notification Opt-In + + +|permissions +|array[string] +|True +a|Permissions + + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#UserWorkingEnvironmentResponse] +[.api-collapsible-fifth-title] +UserWorkingEnvironmentResponse + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|publicId +|string +|True +a|System public ID + + +|name +|string +|True +a|System name + + +|workingEnvironmentType +|string +|True +a|System type + + +|=== + + +[#AzureCredentials] +[.api-collapsible-fifth-title] +AzureCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|False +a| + +|tenantId +|string +|False +a| + +|applicationId +|string +|False +a| + +|applicationKey +|string +|False +a| + +|=== + + +[#CloudSyncLicenseInformation] +[.api-collapsible-fifth-title] +CloudSyncLicenseInformation + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudSyncLicenseTypes +|array[string] +|False +a|Cloud sync license types + + +|licenseExpirationDate +|integer +|False +a|Cloud sync license expiration date + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-users-reset-password.adoc b/cvo/put-users-reset-password.adoc new file mode 100644 index 00000000..ab701011 --- /dev/null +++ b/cvo/put-users-reset-password.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-users-reset-password.html' +summary: 'Reset the password' +--- + += Reset the password + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/users/{userId}/reset-password`# + + + +Resets the password for the specified user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|userId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|password +|string +|False +a|New password + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-vsa-volumes--.adoc b/cvo/put-vsa-volumes--.adoc new file mode 100644 index 00000000..74daeecc --- /dev/null +++ b/cvo/put-vsa-volumes--.adoc @@ -0,0 +1,474 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-volumes--.html' +summary: 'Modify an existing volume' +--- + += Modify an existing volume + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}`# + + + +Modifies an existing volume. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|comment +|string +|False +a|Comment + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + }, + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string", + "comment": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-vsa-volumes--exportpolicy.adoc b/cvo/put-vsa-volumes--exportpolicy.adoc new file mode 100644 index 00000000..80bf97a2 --- /dev/null +++ b/cvo/put-vsa-volumes--exportpolicy.adoc @@ -0,0 +1,474 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-volumes--exportpolicy.html' +summary: 'Add an export policy rule' +--- + += Add an export policy rule + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy`# + + + +Adds an export policy rule. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|svmName +|string +|path +|True +a| + +|volumeName +|link:#VolumeName[VolumeName] +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snapshotPolicyName +|string +|False +a|Snapshot policy name + + +|shareInfo +|link:#CifsShareInfo[CifsShareInfo] +|False +a| + +|exportPolicyInfo +|link:#NamedExportPolicyInfo[NamedExportPolicyInfo] +|False +a| + +|qualityOfService +|link:#VolumeQualityOfService[VolumeQualityOfService] +|False +a| + +|tieringPolicy +|string +|False +a|Tiering policy + + +|minimumCoolingDays +|integer +|False +a|Tiering minimum cooling days + + +|comment +|string +|False +a|Comment + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snapshotPolicyName": "string", + "shareInfo": { + "shareName": "string", + "accessControlList": [ + { + "permission": "string", + "users": [ + "string" + ] + } + ], + "vscanFileOpPolicy": "string" + }, + "exportPolicyInfo": { + "name": "string", + "policyType": "string", + "ips": [ + "string" + ], + "nfsVersion": [ + "string" + ], + "rules": [ + {} + ] + }, + "tieringPolicy": "string", + "comment": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#pattern] +[.api-collapsible-fifth-title] +pattern + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|string +|False +a| + +|flags +|integer +|True +a| + +|cursor +|integer +|False +a| + +|=== + + +[#Regex] +[.api-collapsible-fifth-title] +Regex + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|pattern +|link:#pattern[pattern] +|True +a| + +|groupNames +|array[string] +|True +a| + +|=== + + +[#PatternMessage] +[.api-collapsible-fifth-title] +PatternMessage + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|regex +|link:#Regex[Regex] +|True +a| + +|message +|string +|False +a| + +|=== + + +[#VolumeName] +[.api-collapsible-fifth-title] +VolumeName + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|_1 +|string +|True +a| + +|validatesWith +|link:#PatternMessage[PatternMessage] +|True +a| + +|=== + + +[#CifsShareUserPermissions] +[.api-collapsible-fifth-title] +CifsShareUserPermissions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|permission +|string +|False +a|CIFS share permission type + + +|users +|array[string] +|True +a|List of users with the permission + + +|=== + + +[#CifsShareInfo] +[.api-collapsible-fifth-title] +CifsShareInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|shareName +|string +|True +a|Share name + + +|accessControlList +|array[link:#CifsShareUserPermissions[CifsShareUserPermissions]] +|True +a|List of CIFS share permissions + + +|vscanFileOpPolicy +|string +|False +a|Vscan file operations profile + + +|=== + + +[#index] +[.api-collapsible-fifth-title] +index + +Export policy rule index + + + +[#ExportPolicyRule] +[.api-collapsible-fifth-title] +ExportPolicyRule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|index +|link:#index[index] +|False +a|Export policy rule index + + +|ruleAccessControl +|string +|True +a|Export policy rule access control + + +|ips +|array[string] +|True +a|Export policy rule list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy rule protocol + + +|superUser +|boolean +|True +a|Export policy rule super user access + + +|=== + + +[#NamedExportPolicyInfo] +[.api-collapsible-fifth-title] +NamedExportPolicyInfo + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|False +a|Export policy name + + +|policyType +|string +|True +a|Export policy type + + +|ips +|array[string] +|True +a|Custom export policy list of IPs + + +|nfsVersion +|array[string] +|False +a|Export policy protocol + + +|rules +|array[link:#ExportPolicyRule[ExportPolicyRule]] +|True +a|Export policy rules + + +|=== + + +[#Capacity] +[.api-collapsible-fifth-title] +Capacity + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|size +|number +|True +a|Size + + +|unit +|string +|True +a|Unit + + +|=== + + +[#VolumeQualityOfService] +[.api-collapsible-fifth-title] +VolumeQualityOfService + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|maxIops +|integer +|False +a| + +|maxDataRate +|link:#Capacity[Capacity] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-vsa-working-environments-activate-fpolicy.adoc b/cvo/put-vsa-working-environments-activate-fpolicy.adoc new file mode 100644 index 00000000..a2b0b4a7 --- /dev/null +++ b/cvo/put-vsa-working-environments-activate-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-activate-fpolicy.html' +summary: 'Activate the FPolicy for ransomware files' +--- + += Activate the FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy`# + + + +Activates the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-vsa-working-environments-activate-snapshot-policy.adoc b/cvo/put-vsa-working-environments-activate-snapshot-policy.adoc new file mode 100644 index 00000000..8431914d --- /dev/null +++ b/cvo/put-vsa-working-environments-activate-snapshot-policy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-activate-snapshot-policy.html' +summary: 'Activate snapshot policy assignments' +--- + += Activate snapshot policy assignments + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy`# + + + +Activates snapshot policy assignment for all unprotected read/write volumes. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-vsa-working-environments-byol-to-capacity.adoc b/cvo/put-vsa-working-environments-byol-to-capacity.adoc new file mode 100644 index 00000000..deb025e2 --- /dev/null +++ b/cvo/put-vsa-working-environments-byol-to-capacity.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-byol-to-capacity.html' +summary: 'Update the BYOL licence to a capacity-based license' +--- + += Update the BYOL licence to a capacity-based license + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity`# + + + +Updates a bring-your-own-license (BYOL) license to a capacity-based license for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|capacityPackageName +|string +|True +a|Capacity based package + + +|sendAsup +|boolean +|True +a| + +|deleteByNodeByolLicense +|boolean +|False +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serial1 +|string +|True +a| + +|serial2 +|string +|False +a| + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serial1": "string", + "serial2": "string" +} +==== + diff --git a/cvo/put-vsa-working-environments-disable-fpolicy.adoc b/cvo/put-vsa-working-environments-disable-fpolicy.adoc new file mode 100644 index 00000000..41ee16eb --- /dev/null +++ b/cvo/put-vsa-working-environments-disable-fpolicy.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-disable-fpolicy.html' +summary: 'Disable the FPolicy for ransomware files' +--- + += Disable the FPolicy for ransomware files + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy`# + + + +Disables the FPolicy for ransomware files. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-vsa-working-environments-enable-worm.adoc b/cvo/put-vsa-working-environments-enable-worm.adoc new file mode 100644 index 00000000..1569e9fe --- /dev/null +++ b/cvo/put-vsa-working-environments-enable-worm.adoc @@ -0,0 +1,95 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-enable-worm.html' +summary: 'Enable SnapLock for an existing system' +--- + += Enable SnapLock for an existing system + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/enable-worm`# + + + +Enables SnapLock for an existing Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|retentionPeriod +|link:#WormRetentionPeriod[WormRetentionPeriod] +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#WormRetentionPeriod] +[.api-collapsible-fifth-title] +WormRetentionPeriod + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|length +|integer +|True +a|Length + + +|unit +|string +|True +a|Unit + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-vsa-working-environments-extra-capacity-licenses.adoc b/cvo/put-vsa-working-environments-extra-capacity-licenses.adoc new file mode 100644 index 00000000..afed8035 --- /dev/null +++ b/cvo/put-vsa-working-environments-extra-capacity-licenses.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-extra-capacity-licenses.html' +summary: 'Update extra capacity licenses' +--- + += Update extra capacity licenses + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses`# + + + +Updates an extra capacity license. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|licences +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "licences": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-vsa-working-environments-extra-capacity-serials.adoc b/cvo/put-vsa-working-environments-extra-capacity-serials.adoc new file mode 100644 index 00000000..7bfb4376 --- /dev/null +++ b/cvo/put-vsa-working-environments-extra-capacity-serials.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-extra-capacity-serials.html' +summary: 'Update extra capacity serial numbers' +--- + += Update extra capacity serial numbers + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials`# + + + +Updates an extra capacity license serial number. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serials +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serials": [ + "string" + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-vsa-working-environments-license-instance-type.adoc b/cvo/put-vsa-working-environments-license-instance-type.adoc new file mode 100644 index 00000000..060e00f3 --- /dev/null +++ b/cvo/put-vsa-working-environments-license-instance-type.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-license-instance-type.html' +summary: 'Set the instance type' +--- + += Set the instance type + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/license-instance-type`# + + + +Sets the instance type of a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|instanceType +|string +|True +a|New instance type + + +|licenseType +|string +|True +a|New license type + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "instanceType": "string", + "licenseType": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-vsa-working-environments-networkoptimization.adoc b/cvo/put-vsa-working-environments-networkoptimization.adoc new file mode 100644 index 00000000..528577ee --- /dev/null +++ b/cvo/put-vsa-working-environments-networkoptimization.adoc @@ -0,0 +1,60 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-networkoptimization.html' +summary: 'Modify the network port broadcast domain MTU' +--- + += Modify the network port broadcast domain MTU + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/networkOptimization`# + + + +Modifies the network port broadcast domain MTU of the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|optimize +|boolean +|True +a| + +|=== + + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-vsa-working-environments-offbox.adoc b/cvo/put-vsa-working-environments-offbox.adoc new file mode 100644 index 00000000..f92d1f04 --- /dev/null +++ b/cvo/put-vsa-working-environments-offbox.adoc @@ -0,0 +1,41 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-offbox.html' +summary: 'Activate an off-box configuration' +--- + += Activate an off-box configuration + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/offbox`# + + + +Activates an off-box configuration. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-vsa-working-environments-schedules.adoc b/cvo/put-vsa-working-environments-schedules.adoc new file mode 100644 index 00000000..7bcf0ec4 --- /dev/null +++ b/cvo/put-vsa-working-environments-schedules.adoc @@ -0,0 +1,167 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-schedules.html' +summary: 'Set the schedules' +--- + += Set the schedules + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/schedules`# + + + +Sets schedules for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|schedules +|array[link:#VsaSchedule[VsaSchedule]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "schedules": [ + { + "name": "string", + "schedule": [ + {} + ] + } + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#TimePoint] +[.api-collapsible-fifth-title] +TimePoint + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|day +|integer +|True +a| + +|hour +|integer +|False +a| + +|minute +|integer +|False +a| + +|=== + + +[#StartStopRange] +[.api-collapsible-fifth-title] +StartStopRange + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stop +|link:#TimePoint[TimePoint] +|True +a| + +|start +|link:#TimePoint[TimePoint] +|False +a| + +|=== + + +[#VsaSchedule] +[.api-collapsible-fifth-title] +VsaSchedule + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|schedule +|array[link:#StartStopRange[StartStopRange]] +|True +a| + +|enabled +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-vsa-working-environments-set-password.adoc b/cvo/put-vsa-working-environments-set-password.adoc new file mode 100644 index 00000000..ddac8fce --- /dev/null +++ b/cvo/put-vsa-working-environments-set-password.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-set-password.html' +summary: 'Set the cluster password' +--- + += Set the cluster password + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/set-password`# + + + +Sets the cluster password for a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|occmOnly +|boolean +|query +|False +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|password +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-vsa-working-environments-svm.adoc b/cvo/put-vsa-working-environments-svm.adoc new file mode 100644 index 00000000..d378a403 --- /dev/null +++ b/cvo/put-vsa-working-environments-svm.adoc @@ -0,0 +1,75 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-svm.html' +summary: 'Modify the SVM name' +--- + += Modify the SVM name + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/svm`# + + + +Modifies the SVM name of the Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|svmNewName +|string +|False +a| + +|svmName +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "svmNewName": "string", + "svmName": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-vsa-working-environments-update-credentials.adoc b/cvo/put-vsa-working-environments-update-credentials.adoc new file mode 100644 index 00000000..4aaf776c --- /dev/null +++ b/cvo/put-vsa-working-environments-update-credentials.adoc @@ -0,0 +1,77 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-update-credentials.html' +summary: 'Update the NetApp Console password ' +--- + += Update the NetApp Console password + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/update-credentials`# + + + +Updates the NetApp Console password for a specific Cloud Volumes ONTAP system. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|False +a|Username + + +|password +|string +|True +a|Password + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "username": "string", + "password": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-vsa-working-environments-user-tags.adoc b/cvo/put-vsa-working-environments-user-tags.adoc new file mode 100644 index 00000000..aad3c235 --- /dev/null +++ b/cvo/put-vsa-working-environments-user-tags.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-user-tags.html' +summary: 'Modify user tags for cloud resources' +--- + += Modify user tags for cloud resources + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/user-tags`# + + + +Modifies the user tags for cloud resources in a specific Cloud Volumes ONTAP instance. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tags +|array[link:#CloudResourceTag[CloudResourceTag]] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "tags": [ + { + "tagKey": "string", + "tagValue": "string" + } + ] +} +==== + +== Error + +``` +Status: Default, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#CloudResourceTag] +[.api-collapsible-fifth-title] +CloudResourceTag + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|tagKey +|string +|True +a| + +|tagValue +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/cvo/put-vsa-working-environments-vscan-file-op.adoc b/cvo/put-vsa-working-environments-vscan-file-op.adoc new file mode 100644 index 00000000..05bf2100 --- /dev/null +++ b/cvo/put-vsa-working-environments-vscan-file-op.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-vscan-file-op.html' +summary: 'Update the default Vscan file operation profile' +--- + += Update the default Vscan file operation profile + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/vscan-file-op`# + + + +Updates the default Vscan file operation profile. Profiles on existing CIFS shares will change only on writes-only mode. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vscanFileOp +|string +|False +a|Vscan file-operation + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "vscanFileOp": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/put-vsa-working-environments-writing-speed.adoc b/cvo/put-vsa-working-environments-writing-speed.adoc new file mode 100644 index 00000000..07d5ddea --- /dev/null +++ b/cvo/put-vsa-working-environments-writing-speed.adoc @@ -0,0 +1,70 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'cvo/put-vsa-working-environments-writing-speed.html' +summary: 'Set the writing speed for Cloud Volumes ONTAP' +--- + += Set the writing speed for Cloud Volumes ONTAP + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/vsa/working-environments/{workingEnvironmentId}/writing-speed`# + + + +Sets the writing speed for Cloud Volumes ONTAP. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|writingSpeedState +|string +|False +a|Writing speed state + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "writingSpeedState": "string" +} +==== + +== Error + +``` +Status: Default, Default response +``` + diff --git a/cvo/sidebar.yml b/cvo/sidebar.yml deleted file mode 100644 index c76cf8ab..00000000 --- a/cvo/sidebar.yml +++ /dev/null @@ -1,3 +0,0 @@ -section: cvo -title: ONTAP management API reference -generate: cvo \ No newline at end of file diff --git a/dw/data_services_overview.adoc b/dw/data_services_overview.adoc new file mode 100644 index 00000000..42d91a6a --- /dev/null +++ b/dw/data_services_overview.adoc @@ -0,0 +1,19 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/data_services_overview.html' +summary: 'Data services endpoints in the License and subscriptions REST API for the NetApp Console' +--- + += Data services endpoints in the License and subscriptions REST API for the NetApp Console + + + +The data services endpoints retrieve data service information that is managed in the NetApp Console. + +You can perform the following actions with the data services endpoints: + +* Read eligibility details of an account for a data service + + diff --git a/dw/delete-license-account-licenseresource-.adoc b/dw/delete-license-account-licenseresource-.adoc new file mode 100644 index 00000000..acd4c9a2 --- /dev/null +++ b/dw/delete-license-account-licenseresource-.adoc @@ -0,0 +1,104 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/delete-license-account-licenseresource-.html' +summary: 'Delete a license by resource ID' +--- + += Delete a license by resource ID + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/license/account/{accountId}/licenseResource/{resourceIdentifier}`# + + + +Deletes a specified license by resource ID. + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|resourceIdentifier +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/delete-license-account-subscription-.adoc b/dw/delete-license-account-subscription-.adoc new file mode 100644 index 00000000..3c72201d --- /dev/null +++ b/dw/delete-license-account-subscription-.adoc @@ -0,0 +1,120 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/delete-license-account-subscription-.html' +summary: 'Delete a subscription using the subscription ID' +--- + += Delete a subscription using the subscription ID + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/license/account/{accountId}/subscription/{subscriptionId}`# + + + +Deletes or disassociates a subscription that contains the specified subscription ID from an account. + +The specified subscription must exist and not be associated with a Cloud Volumes ONTAP instance. + +This endpoint deletes the subscription if no other account is associated with the subscription. + +If more than one account is associated with the subscription, this endpoint disassociates the account provided in the `accountId` field and the subscription. + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|dwAudit +|boolean +|query +|False +a|The NetApp Console audits, by default, all API calls. + +**Note:** + +* To stop the NetApp Console from auditing a request, you can set the calling service to `false`. +* `dwAudit` is an optional parameter, the default value is `true`. + + +|accountId +|string +|path +|True +a| + +|subscriptionId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/delete-license-serial-number-.adoc b/dw/delete-license-serial-number-.adoc new file mode 100644 index 00000000..6ddc2fd7 --- /dev/null +++ b/dw/delete-license-serial-number-.adoc @@ -0,0 +1,131 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/delete-license-serial-number-.html' +summary: 'Delete a license' +--- + += Delete a license + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/license/serial-number/{serialNumber}`# + + + +Deletes a license by using a specified serial number. + +**Note:** + +* If you use a NetApp Console service token, accountId is not a required field. +* If you use a NetApp Console user token, `accountId` is a required field. +* `serialNumber` is a required parameter. +*Token usage:* Either a NetApp Console user token or service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|serialNumber +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountId": "string" +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/delete-license-subscriptions-account-.adoc b/dw/delete-license-subscriptions-account-.adoc new file mode 100644 index 00000000..bf87404c --- /dev/null +++ b/dw/delete-license-subscriptions-account-.adoc @@ -0,0 +1,131 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/delete-license-subscriptions-account-.html' +summary: 'Delete a subscription using the account ID' +--- + += Delete a subscription using the account ID + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/license/subscriptions/account/{accountId}`# + + + +Deletes or disassociates a subscription that contains the specified subscription ID from an account. + +The specified subscription must exist and not be associated with a Cloud Volumes ONTAP instance. + +This endpoint deletes the subscription if no other account is associated with the subscription. + +If more than one account is associated with the subscription, this endpoint disassociates the account provided in the `accountId` field and the subscription. + +{blank} + +*Token usage:* Either a NetApp Console user token or service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "subscriptionId": "string" +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/delete-license-subscriptions-account-subscription-.adoc b/dw/delete-license-subscriptions-account-subscription-.adoc new file mode 100644 index 00000000..6d9f6fe5 --- /dev/null +++ b/dw/delete-license-subscriptions-account-subscription-.adoc @@ -0,0 +1,112 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/delete-license-subscriptions-account-subscription-.html' +summary: 'Delete a subscription using the subscription ID (deprecated)' +--- + += Delete a subscription using the subscription ID (deprecated) + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/license/subscriptions/account/{accountId}/subscription/{subscriptionId}`# + + + +Deletes or disassociates a subscription that contains the specified subscription ID from an account. A newer version of this deprecated endpoint is available https://docs.netapp.com/us-en/console-automation/dw/delete-license-account-subscription-.html[here.] + +The specified subscription must exist and not be associated with a Cloud Volumes ONTAP instance. + +This endpoint deletes the subscription if no other account is associated with the subscription. + +If more than one account is associated with the subscription, this endpoint disassociates the account provided in the `accountId` field and the subscription. + +{blank} + +*Token usage:* Either a NetApp Console user token or service token. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|subscriptionId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/dw-x-doc.json b/dw/dw-x-doc.json deleted file mode 100644 index 615b5667..00000000 --- a/dw/dw-x-doc.json +++ /dev/null @@ -1,373 +0,0 @@ -{ - "overview": "Licenses and subscriptions REST API for the NetApp Console", - "permalink": "overview.html", - "paths": { - "/license/serial-number/{serialNumber}": { - "post": { - "x-doc": { - "title": "Associate a license", - "category": "License", - "filename": "post-license-serial-number-.html", - "subcategory": null, - "explorer": false - } - }, - "patch": { - "x-doc": { - "title": "Update a license by serial number", - "category": "License", - "filename": "patch-license-serial-number-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a license", - "category": "License", - "filename": "delete-license-serial-number-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/licenses": { - "get": { - "x-doc": { - "title": "Retrieve a license by type", - "category": "License", - "filename": "get-license-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/account/{accountId}/licenseResource/{resourceIdentifier}": { - "patch": { - "x-doc": { - "title": "Update a license by resource ID", - "category": "License", - "filename": "patch-license-account-licenseresource-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a license by resource ID", - "category": "License", - "filename": "delete-license-account-licenseresource-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/exchange": { - "post": { - "x-doc": { - "title": "Exchange a Cloud Volumes ONTAP license", - "category": "License", - "filename": "post-license-exchange.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/data-service-eligibility/account/{accountId}/provider/{cloudProvider}": { - "get": { - "x-doc": { - "title": "Retrieve data service eligibility details", - "category": "Data Services", - "filename": "get-license-data-service-eligibility-account-provider-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/account/{accountId}/subscriptions/{subscriptionId}": { - "post": { - "x-doc": { - "title": "Register a subscription", - "category": "Subscription", - "filename": "post-license-account-subscriptions-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/account/{accountId}/subscriptions": { - "get": { - "x-doc": { - "title": "Retrieve all subscriptions for an account", - "category": "Subscription", - "filename": "get-license-account-subscriptions.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/subscriptions/{subscriptionId}": { - "patch": { - "x-doc": { - "title": "Update a subscription expiration date using the subscription ID", - "category": "Subscription", - "filename": "patch-license-subscriptions-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/account/{accountId}/subscription/{subscriptionId}": { - "delete": { - "x-doc": { - "title": "Delete a subscription using the subscription ID", - "category": "Subscription", - "filename": "delete-license-account-subscription-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/onPrem/account/{accountId}/clusters": { - "get": { - "x-doc": { - "title": "Retrieve on-prem ONTAP data", - "category": "External Services", - "filename": "get-license-onprem-account-clusters.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/subscriptions/entitlements": { - "get": { - "x-doc": { - "title": "Retrieve the subscription entitlements", - "category": "Subscription", - "filename": "get-license-subscriptions-entitlements.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/subscriptions/account/{accountId}": { - "get": { - "x-doc": { - "title": "Retrieve subscription information for an account", - "category": "Subscription", - "filename": "get-license-subscriptions-account-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete a subscription using the account ID", - "category": "Subscription", - "filename": "delete-license-subscriptions-account-.html", - "subcategory": null, - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Associate a subscription", - "category": "Subscription", - "filename": "post-license-subscriptions-account-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/subscriptions/subscription/{subscriptionId}": { - "get": { - "x-doc": { - "title": "Retrieve subscription information using the subscription ID (deprecated)", - "category": "Subscription", - "filename": "get-license-subscriptions-subscription-.html", - "subcategory": null, - "explorer": false - } - }, - "patch": { - "x-doc": { - "title": "Update a subscription expiration date (deprecated)", - "category": "Subscription", - "filename": "patch-license-subscriptions-subscription-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/subscriptions/account/{accountId}/subscription/{subscriptionId}": { - "delete": { - "x-doc": { - "title": "Delete a subscription using the subscription ID (deprecated)", - "category": "Subscription", - "filename": "delete-license-subscriptions-account-subscription-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/subscriptions/subscription/{subscriptionId}/account/{accountId}": { - "post": { - "x-doc": { - "title": "Associate a subscription (deprecated)", - "category": "Subscription", - "filename": "post-license-subscriptions-subscription-account-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/subscriptions/subscription": { - "get": { - "x-doc": { - "title": "Retrieve subscription information using the subscription ID", - "category": "Subscription", - "filename": "get-license-subscriptions-subscription.html", - "subcategory": null, - "explorer": false - } - }, - "patch": { - "x-doc": { - "title": "Update a subscription expiration date", - "category": "Subscription", - "filename": "patch-license-subscriptions-subscription.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/extra-capacity-licenses/cvoId/{cvoId}": { - "post": { - "x-doc": { - "title": "Associate extra-capacity per-node licenses with a Cloud Volumes ONTAP system", - "category": "License", - "filename": "post-license-extra-capacity-licenses-cvoid-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/associate-resource/serial-number/{serialNumber}": { - "post": { - "x-doc": { - "title": "Associate a resource ID with a specified license", - "category": "License", - "filename": "post-license-associate-resource-serial-number-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/disassociate-resource/{associatedResourceId}": { - "post": { - "x-doc": { - "title": "Disassociate a resource ID from a license", - "category": "License", - "filename": "post-license-disassociate-resource-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/account/{accountId}/licenses": { - "patch": { - "x-doc": { - "title": "Update all licenses under an organization ID", - "category": "License", - "filename": "patch-license-account-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/node-based-eval-licenses": { - "post": { - "x-doc": { - "title": "Create an evaluation license", - "category": "Evaluation licenses", - "filename": "post-license-node-based-eval-licenses.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/account/{accountId}/subscriptions/preferred": { - "get": { - "x-doc": { - "title": "Retrieve the preferred subscription ID for an account", - "category": "Subscription", - "filename": "get-license-account-subscriptions-preferred.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update the preferred subscription ID for an account", - "category": "Subscription", - "filename": "put-license-account-subscriptions-preferred.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/subscriptions/configuration": { - "get": { - "x-doc": { - "title": "Retrieve subscription configuration information", - "category": "Subscription", - "filename": "get-license-subscriptions-configuration.html", - "subcategory": null, - "explorer": false - } - }, - "patch": { - "x-doc": { - "title": "Set the subscription configuration", - "category": "Subscription", - "filename": "patch-license-subscriptions-configuration.html", - "subcategory": null, - "explorer": false - } - } - }, - "/license/subscriptions/cloud-account/association": { - "get": { - "x-doc": { - "title": "Retrieve the associated subscription ID for cloud accounts", - "category": "Subscription", - "filename": "get-license-subscriptions-cloud-account-association.html", - "subcategory": null, - "explorer": false - } - } - } - }, - "categories": [ - { - "id": "license", - "title": "License endpoints in the License and subscriptions REST API for the NetApp Console", - "permalink": "license_overview.html" - }, - { - "id": "subscription", - "title": "Subscription endpoints in the License and subscriptions REST API for the NetApp Console", - "permalink": "subscription_overview.html" - }, - { - "id": "external services", - "title": "External services endpoints in the License and subscriptions REST API for the NetApp Console", - "permalink": "external_services_overview.html" - }, - { - "id": "data services", - "title": "Data services endpoints in the License and subscriptions REST API for the NetApp Console", - "permalink": "data_services_overview.html" - } - ] -} \ No newline at end of file diff --git a/dw/dw.json b/dw/dw.json deleted file mode 100644 index 0104904d..00000000 --- a/dw/dw.json +++ /dev/null @@ -1,3474 +0,0 @@ -{ - "openapi": "3.0.3", - "info": { - "title": "NetApp Console licenses and subscriptions REST API reference", - "description": "
\nOverview\n

NetApp Console manages licenses for Cloud Volumes ONTAP and subscriptions to other Console services.

\n

Every license and subscription managed by the Console is assigned a unique resource identifier in the identity and access management service. The ID associates it with a specific account.

\n

You can view and manage procured licenses and subscriptions by using the Licenses and subscriptions menu in the Console UI and through the licenses and subscriptions REST API endpoints.

\n

You can manage the following types of licenses in the Console:

\n
    \n
  • Node: Each node has a unique serial number
    • \n
  • Capacity: Comes with multiple packages (Professional, Essential, Freemium (500 GB))
    • \n
  • Data services: Used for data management services (Backup & Restore, Compliance (Data Sense), and Tiering)
    • \n
\n

Each license contains the following information to monitor the expiration and capacity usage of licenses in an account:

\n
    \n
  • License serial number (such as 481000485)
    • \n
  • License type/service (such as BACKUP)
    • \n
  • Permitted/Entitled capacity (TB)
    • \n
  • Expiration date
    • \n
\n

Each subscription contains the following information to monitor the expiration and capacity subscriptions in an account
\n(a subscription can be associated with more than one account):

\n
    \n
  • Subscription number (subscription ID)
    • \n
  • Permitted/entitled capacity (TiB)
    • \n
  • Currently used (or consumed) capacity (TiB)
    • \n
  • Expiration date
    • \n
\n

The following components are defined in the licenses and subscriptions REST API:

\n
    \n
  • Data services
    • \n
  • External services
    • \n
  • License
    • \n
  • Subscription
    • \n
\n

All licenses and subscriptions API calls are short-lived and run synchronously. Asynchronous processing and internal process tracking are not supported.

\n

Note: Before using the API reference documentation, review the Get started section for the NetApp Console APIs. For more information about the security tokens and identifiers you’ll need when using the API, review the Common workflows and tasks section.

\n
\n
\n
\nREST implementation\n

HTTP methods

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MethodDescription
POSTCreate an object instance
GETRetrieve an object instance or collection
PATCHUpdate an existing object
DELETERemove an existing object
\n

Request headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Request HeaderDescription
AuthorizationContains the JWT access token and is required
X-Service-Request-IdUsed to tag a request with application-specific keys for improved supportability
\n

Query parameters

\n

You can use query parameters with endpoints in the following components:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ComponentQuery Parameter
LicenseaccountId
serialNumber
resourceId
licenseType
service
group
includeSummaryInfo (boolean)
SubscriptionsubscriptionId
subscriptionType
\n

Response headers

\n

This API uses the standard HTTP response headers common with all NetApp Console APIs.
\nSee REST implementation for more information.

\n

HTTP status codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP Status CodeDescription
200OK: Returned for successful operation completion
400Bad Request: Returned if the input is malformed and could not be parsed
401Unauthorized: Returned if user authentication failed or the token has expired
403Forbidden: Returned for authorization errors depending on the resource and token
404Not Found: Returned if the requested resource could not be found
405Method Not Allowed: Returned if the HTTP request method is not supported for a requested resource
500Processing Error: Returned if an error occurs on the server while processing the API call
\n
\n
\n
\nError handling\n

There are three processes involved with error handling and processing.

\n
    \n
  • The error is logged for supportability
    • \n
  • The error is also returned to the caller for any specific handling
    • \n
  • The database connection is rolled back
    • \n
\n
\n
\n
\ncURL examples\n

Retrieve licenses

\n

This example retrieves all the licenses associated with a specified account.

\n
curl -X GET "https://api.bluexp.netapp.com/license/licenses?includeSummaryInfo=true" -H  "accept: application/json" -H  "authorization: <user token>"\n
\n
\n
\n
\nFrequently asked questions\n

What’s the difference between user token and service token and why do we need two types of token authorization ?

\n

A user token is used for communication between a user (or the UI) and the NetApp Console REST APIs,
\nwhereas the service token is used for communication between two services (machine-to-machine interaction) in the NetApp Console control plane.
\nThe type of token required to invoke an API is documented in the description of each endpoint.

\n

What is a resource ID ?

\n

A resource ID is an internal identifier to denote a resource in the Console control plane. For example, a resource ID such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be denotes a license resource,
\na resource ID such as VsaWorkingEnvironment-XXXX denotes a Cloud Volumes ONTAP instance.

\n

What’s X-Service-Request-Id and why do we use it ?

\n

X-Service-Request-Id is an optional parameter and can be passed to the NetApp Console APIs to identify the origin of the request.
\nIt is used for tagging the API call with a specific ID for logging and better supportability.

\n

What does the parameter includeSummaryInfo mean in a GET license API call ?

\n

The includeSummaryInfo parameter contains various pieces of additional information associated with a license
\nrelating to its expiration and capacity usage. By default, the summary information is not included in the API response.
\nYou must pass the parameter explicitly to retrieve this information.

\n

What does the parameter group mean in a GET license API call ?

\n

group is the logical grouping of the various license types. Groups can be Data Services or CVO.
\nThe Data Services group includes Cloud Backup, Cloud Data Sense and Cloud Tiering services.

\n
\n \n\n", - "version": "1.0.0" - }, - "components": { - "securitySchemes": { - "authorization": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "JWT", - "description": "JWT access token to authorize the request, sent on the request header." - } - }, - "schemas": { - "def-0": { - "title": "Authorization", - "type": "object", - "properties": { - "X-Service-Request-Id": { - "description": "Request identifier", - "type": "string" - } - } - }, - "def-1": { - "title": "Error", - "type": "object", - "description": "Error response", - "properties": { - "errorCode": { - "description": "Error code", - "type": "string" - }, - "error": { - "description": "Error code/category", - "type": "string" - }, - "message": { - "description": "Error description message", - "type": "string" - } - } - }, - "def-2": { - "title": "subscriptionResponse", - "description": "Subscription response structure", - "type": "object", - "properties": { - "accounts": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "account-sdajkj5", - "account-euir74j" - ] - }, - "createdAt": { - "type": "integer", - "example": 1556636730921 - }, - "cloudProvider": { - "type": "string", - "enum": [ - "aws", - "azure", - "gcp" - ], - "example": "aws" - }, - "entitlements": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "contractOption": { - "type": "string", - "example": "Professional" - }, - "units": { - "type": "string", - "example": "12 TiB" - }, - "expirationDate": { - "type": "string", - "example": "2026-07-02T00:00:00Z" - }, - "details": { - "type": "string", - "example": "High Availability + Unlimited Cloud Backup" - }, - "category": { - "type": "string", - "example": "Cloud Volumes ONTAP" - }, - "dimension": { - "type": "string", - "example": "tier12" - }, - "IntegerValue": { - "type": "integer", - "example": 1 - }, - "usageReport": { - "type": "integer", - "example": 12 - }, - "unit": { - "type": "string", - "example": "TiB" - }, - "serviceName": { - "type": "string", - "enum": [ - "CLOUD_BACKUP", - "CLOUD_DATA_SENSE", - "BLUEXP_DISASTER_RECOVERY", - "BLUEXP_RANSOMWARE_PROTECTION", - "CLOUD_TIERING", - "CVO" - ], - "example": "CVO" - } - } - } - } - } - }, - "dimensions": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "professional" - ] - }, - "contract": { - "type": "boolean", - "example": false - }, - "customerIdentifier": { - "type": "string", - "example": "FJsUvVHffi9" - }, - "productCode": { - "type": "string", - "example": "1ajwvb3kjavjlk36izcn19e07" - }, - "planId": { - "type": "string", - "example": "paygo_example" - }, - "serviceName": { - "type": "string", - "example": "cloud-volumes-ontap" - }, - "subscriptionId": { - "type": "string", - "example": "aws-abcd-1234" - }, - "subscriptionName": { - "type": "string", - "example": "My Prod CVO subscription" - }, - "subscriptionStatus": { - "type": "string", - "enum": [ - "pending", - "subscribed", - "failed", - "unsubscribe-pending", - "unsubscribed", - "suspended" - ], - "example": "subscribed" - }, - "autoRenew": { - "type": "string", - "enum": [ - "No", - "Yes", - "N/A" - ], - "default": "N/A", - "example": "N/A" - }, - "endDate": { - "type": [ - "null", - "integer" - ], - "example": 1556636730921 - }, - "term": { - "type": [ - "null", - "string" - ], - "example": "12 Months" - }, - "isPrivate": { - "type": [ - "null", - "boolean" - ], - "example": true - }, - "listingUrl": { - "type": [ - "null", - "string" - ], - "example": "https://marketplace-fake-url.com" - }, - "productTitle": { - "type": [ - "null", - "string" - ], - "example": "Cloud Manager - Deploy & Manage Netapp Cloud Data Service" - }, - "cloudIds": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "0ae5-rew5-ttt1-4563" - ] - }, - "availableDimensions": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "ransomware_resilience" - ] - }, - "configuration": { - "type": "string", - "enum": [ - "Configured", - "Unconfigured" - ] - }, - "events": { - "type": "object", - "properties": { - "endDateEvent": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "subscriptionExpired", - "subscriptionAlmostExpired" - ] - }, - "subscriptionExpirationInDays": { - "type": "integer" - } - } - } - } - } - } - }, - "def-3": { - "title": "entitlementResponse", - "description": "Entitlements response structure", - "type": "array", - "items": { - "type": "object", - "properties": { - "entitlements": { - "type": "array", - "items": { - "type": "object", - "properties": { - "CustomerIdentifier": { - "type": "string", - "example": "XBtLDS79Sn2" - }, - "Dimension": { - "type": "string", - "example": "tier12" - }, - "ExpirationDate": { - "type": "string", - "example": "2023-04-03T11:39:08.004Z" - }, - "ProductCode": { - "type": "string", - "example": "23xcm7682luhyufqzn9tlvftt" - }, - "Value": { - "type": "object", - "properties": { - "IntegerValue": { - "type": "integer", - "example": 1 - } - } - } - } - } - }, - "productCode": { - "type": "string" - }, - "error": { - "type": "string" - } - } - } - }, - "def-4": { - "title": "servicesSummaryInfo", - "description": "one servicesSummaryInfo structure", - "type": "object", - "properties": { - "serviceName": { - "type": "string" - }, - "serviceNameUi": { - "type": "string" - }, - "subscriptionIds": { - "type": "array" - }, - "annualContractSummaryInfo": { - "type": "object", - "properties": { - "totalSubscribedCapacity": { - "type": "integer" - }, - "totalUsedCapacity": { - "type": "integer" - }, - "totalAnnualContracts": { - "type": "integer" - } - } - }, - "paygoSummaryInfo": { - "type": "object", - "properties": { - "totalPaygoSubscriptions": { - "type": "integer" - }, - "totalUsedCapacity": { - "type": "integer" - } - } - } - } - } - } - }, - "paths": { - "/license/serial-number/{serialNumber}": { - "post": { - "tags": [ - "License" - ], - "description": "

Associates a license with the NetApp Console either by providing a NetApp License File (NLF) in the license body field or a value for both the serialNumber query parameter and nssKeyId body field.

\n

Note:

\n
    \n
  • If you use a NetApp Console service token, accountId is not a required field.
    • \n
  • If you use a NetApp Console user token, accountId is a required field.
    • \n
  • serialNumber is a required field when using this site. In general, you can specify its value as null.
    • \n
  • If the value of licenseType is EXTRA_CAPACITY, you must provide the associated resource ID (resourceId).
    • \n
  • licenseType is not a required field for data services and capacity based license types.
    • \n
  • expirationDate is a required field unless you are registered with the NetApp Support Site.
    • \n
  • license is not a required field if values for serialnumber and nssKeyId are provided.
    • \n
  • capacity is a required field unless you are registered with the NetApp Support Site.
    • \n
  • packageValue is a required field (used only for internal purposes) unless you are registered with the NetApp Support Site.
    • \n
  • metadata is not a required field and is used to add additional data to a license that is not included in other request body fields.
    • \n
\n \nToken usage: Either a NetApp Console user token or service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "resourceId": { - "type": [ - "string", - "null" - ] - }, - "licenseType": { - "type": "string" - }, - "expirationDate": { - "type": [ - "integer", - "null" - ] - }, - "license": { - "type": "string" - }, - "capacity": { - "type": [ - "integer", - "null" - ] - }, - "metadata": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "propertyName": { - "type": "string" - }, - "propertyValue": { - "type": "string" - } - }, - "required": [ - "propertyName", - "propertyValue" - ] - } - }, - "nssKeyId": { - "type": "string" - } - }, - "example": { - "accountId": "string", - "resourceId": "string - assocaited resource identifier e.g. VsaWorkingEnvironment-XXXX", - "licenseType": "[ BACKUP | EXTRA_CAPACITY | CAPACITY_BASED | CVO_NODE ] - string", - "expirationDate": "integer - UNIX time in milliseconds", - "license": "string - license file content - can be fetched from IPA APIs by the serial number", - "capacity": "integer - should be in TB", - "metadata": [ - { - "propertyName": "some property name", - "propertyValue": "value" - }, - { - "propertyName": "some property name", - "propertyValue": "value" - } - ], - "nssKeyId": "string" - } - } - } - } - }, - "parameters": [ - { - "schema": { - "oneOf": [ - { - "type": "string", - "pattern": "^[0-9]{1,20}$" - }, - { - "type": "null" - } - ] - }, - "in": "path", - "name": "serialNumber", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - }, - "patch": { - "tags": [ - "License" - ], - "description": "

Updates a specified license by license serial number.
\nIf you use a user token, you must provide the NetApp License File (NLF). If you use the NetApp Console service token, provide either the NLF or values for serialNumber and the fields that you want to update.

\n

Note:

\n
    \n
  • If you use a NetApp Console service token, accountId is not a required field.
    • \n
  • If you use a NetApp Console user token, accountId is a required field.
    • \n
  • If you provide the NLF, the license data is overwritten by the NLF data.
    • \n
  • The metadata field value is appended to the existing metadata.
    • \n
  • Authorization is a required field.
    • \n
  • serialNumber is a required field when using this site. In general, you can specify its value as null.
    • \n
\n \nToken usage: Either a NetApp Console user token or service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "capacity": { - "type": [ - "integer", - "null" - ] - }, - "expirationDate": { - "type": [ - "integer", - "null" - ] - }, - "license": { - "type": [ - "string", - "null" - ] - }, - "meteringStatus": { - "type": "boolean" - }, - "metadata": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "propertyName": { - "type": "string" - }, - "propertyValue": { - "type": "string" - } - }, - "required": [ - "propertyName", - "propertyValue" - ] - } - } - }, - "example": { - "accountId": "string", - "capacity": "integer - should be in TB", - "expirationDate": "integer - UNIX time in milliseconds", - "license": "string - license file content", - "meteringStatus": true, - "metadata": [ - { - "propertyName": "string", - "propertyValue": "string" - }, - { - "propertyName": "string", - "propertyValue": "string" - } - ] - } - } - } - } - }, - "parameters": [ - { - "schema": { - "oneOf": [ - { - "type": "string", - "pattern": "^[0-9]{1,20}$" - }, - { - "type": "null" - } - ] - }, - "in": "path", - "name": "serialNumber", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - }, - "delete": { - "tags": [ - "License" - ], - "description": "

Deletes a license by using a specified serial number.

\n

Note:

\n
    \n
  • If you use a NetApp Console service token, accountId is not a required field.
    • \n
  • If you use a NetApp Console user token, accountId is a required field.
    • \n
  • serialNumber is a required parameter.
    • \n
\n \nToken usage: Either a NetApp Console user token or service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "accountId": { - "type": "string" - } - } - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string", - "pattern": "^[0-9]{1,20}$" - }, - "in": "path", - "name": "serialNumber", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/extra-capacity-licenses/cvoId/{cvoId}": { - "post": { - "tags": [ - "License" - ], - "description": "

Associates extra-capacity per-node licenses with a Cloud Volumes ONTAP system either by providing NetApp License Files (NLF) in the licenseFiles body field or a value for both serialNumbers and nssKeyId body fields. A Cloud Volumes ONTAP resource is represented by the cvoId parameter. If it's a single-node Cloud Volumes ONTAP resource, only one license file or a serial number and a NetApp Support Site key should be provided. For high-availability (HA) Cloud Volumes ONTAP resource, two license files or two serial numbers and a NetApp Support Site key should be provided.

\n

Note:

\n
    \n
  • The cvoId parameter is required.
    • \n
  • If you use a NetApp Console service token, accountId is not a required field.
    • \n
  • If you use a NetApp Console user token, accountId is a required field.
    • \n
  • serialNumbers is a required field when using this site. In general, you can specify its value as null.
    • \n
  • licenseFiles is not a required field if values for serialnumbers and nssKeyId are provided.
    • \n
  • nssKeyId is a required field unless you provide a value for the licenseFiles body field. In the latter case, nssKeyId must be omitted.
    • \n
  • accountId is a required field unless you use a service token.
    • \n
  • The serialNumbers and licenseFiles fields are mutually exclusive - one must have a value but not both.
    • \n
\n \nToken usage: Either a NetApp Console user token or service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "accountId": { - "type": [ - "string", - "null" - ], - "minLength": 1 - }, - "serialNumbers": { - "type": "array", - "items": { - "type": [ - "string", - "null" - ] - }, - "maxItems": 2 - }, - "licenseFiles": { - "type": "array", - "items": { - "type": [ - "string", - "null" - ] - }, - "maxItems": 2 - }, - "nssKeyId": { - "type": [ - "string", - "null" - ] - } - }, - "example": { - "accountId": "string", - "serialNumbers": "array of strings - the serial numbers of the licenses", - "licenseFiles": "array of strings - license files content - can be fetched from IPA APIs by the serial number", - "nssKeyId": "string" - } - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string", - "minLength": 1 - }, - "in": "path", - "name": "cvoId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - }, - "5XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/licenses": { - "get": { - "tags": [ - "License" - ], - "description": "

Retrieves a specified license by type (LicenseType), a resource ID (resourceId), or both.
\nThe license endpoints consult the used or consumed capacity under the includeSummaryInfo parameter when retrieving licenses with the GET API call.

\n

Note:

\n
    \n
  • If you use a NetApp Console service token, accountId is not a required field.
    • \n
  • If you use a NetApp Console user token, accountId is a required field.
    • \n
  • When you enter a value in serialNumber , all other fields are ignored.
    • \n
  • The boolean parameter includeSummaryInfo (optional) retrieves the totalLicensesCapacity, usedCapacity, reportTime and events such as capacity expired or about to expire for each data service (CLOUD_BACKUP, CLOUD_DATA_SENSE, CLOUD_TIERING).
    • \n
  • The boolean parameter fetchNlf (optional) retrieves the most updated valid NetApp license file from NetApp systems.
    • \n
  • If you use the boolean parameter fetchNlf, you must provide accountId, serialNumber, and nssKeyId.
    • \n
  • fetchNlf and includeSummaryInfo can't be provided in the same request.
    • \n
\n \nToken usage: Either a NetApp Console user token or service token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "accountId", - "required": false - }, - { - "schema": { - "type": [ - "string", - "null" - ], - "pattern": "^$|[0-9]{1,20}$" - }, - "in": "query", - "name": "serialNumber", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "resourceId", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "licenseType", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "service", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "group", - "required": false - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeSummaryInfo", - "required": false - }, - { - "schema": { - "type": "boolean", - "default": false - }, - "in": "query", - "name": "includeExchangedLicenses", - "required": false - }, - { - "schema": { - "type": "boolean", - "default": false - }, - "in": "query", - "name": "fetchNlf", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "nssKeyId", - "required": false - }, - { - "schema": { - "type": "string", - "default": "ALL" - }, - "in": "query", - "name": "eventTypes", - "required": false - }, - { - "schema": { - "type": "string", - "default": "ENABLED" - }, - "in": "query", - "name": "meteringStatus", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "servicesSummaryInfo": { - "type": "array", - "items": { - "type": "object", - "properties": { - "serviceName": { - "type": "string" - }, - "serviceNameUi": { - "type": "string" - }, - "totalLicensesCapacity": { - "type": "number" - }, - "totalLicensesNumber": { - "type": "integer" - }, - "usedCapacity": { - "type": "string" - }, - "accountEvents": { - "type": [ - "object", - "null" - ], - "properties": { - "capacityEvent": { - "type": "object", - "properties": { - "totalLicensesCapacity": { - "type": "string" - }, - "type": { - "type": "string" - }, - "usedCapacityAccount": { - "type": "string" - } - } - } - } - }, - "reportTime": { - "type": "integer" - } - } - } - }, - "licenses": { - "type": "array", - "items": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "serialNumber": { - "type": "string" - }, - "resourceId": { - "type": "string" - }, - "licenseType": { - "type": "string" - }, - "expirationDate": { - "type": "integer" - }, - "license": { - "type": "string" - }, - "capacity": { - "type": "number" - }, - "metadata": { - "type": "string" - }, - "associatedResourceId": { - "type": [ - "string", - "null" - ] - }, - "cloudProviderMetadata": { - "type": "object", - "properties": { - "provider": { - "type": "string" - }, - "cvoType": { - "type": "string" - } - } - }, - "ipaSyncTimestamp": { - "type": [ - "string", - "null" - ] - }, - "licensePackage": { - "type": [ - "string", - "null" - ] - }, - "nssKeyId": { - "type": [ - "string", - "null" - ] - }, - "serviceName": { - "type": "string" - }, - "meteringStatus": { - "type": "boolean", - "nullable": true - }, - "events": { - "any": [ - { - "type": "object", - "properties": { - "endDateEvent": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "licenseExpirationInDays": { - "type": "integer" - } - } - } - } - }, - { - "type": "object", - "properties": { - "capacityEvent": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "usedCapacityAccount": { - "type": "string" - }, - "totalLicensesCapacity": { - "type": "string" - } - } - } - } - }, - { - "type": "null" - } - ] - } - } - } - } - } - } - }, - { - "type": "array", - "items": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "serialNumber": { - "type": "string" - }, - "resourceId": { - "type": "string" - }, - "licenseType": { - "type": "string" - }, - "expirationDate": { - "type": "integer" - }, - "license": { - "type": "string" - }, - "capacity": { - "type": "number" - }, - "metadata": { - "type": "string" - }, - "associatedResourceId": { - "type": [ - "string", - "null" - ] - }, - "cloudProviderMetadata": { - "type": "object", - "properties": { - "provider": { - "type": "string" - }, - "cvoType": { - "type": "string" - } - } - }, - "ipaSyncTimestamp": { - "type": [ - "string", - "null" - ] - }, - "licensePackage": { - "type": [ - "string", - "null" - ] - }, - "nssKeyId": { - "type": [ - "string", - "null" - ] - }, - "serviceName": { - "type": "string" - }, - "meteringStatus": { - "type": "boolean", - "nullable": true - }, - "events": { - "any": [ - { - "type": "object", - "properties": { - "endDateEvent": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "licenseExpirationInDays": { - "type": "integer" - } - } - } - } - }, - { - "type": "object", - "properties": { - "capacityEvent": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "usedCapacityAccount": { - "type": "string" - }, - "totalLicensesCapacity": { - "type": "string" - } - } - } - } - }, - { - "type": "null" - } - ] - } - } - } - } - ] - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/account/{accountId}/licenseResource/{resourceIdentifier}": { - "patch": { - "tags": [ - "License" - ], - "description": "

Updates a specified license by resource ID.

\n \nToken usage: NetApp Console service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "license": { - "type": [ - "string", - "null" - ] - } - }, - "example": { - "license": "string - license file content" - } - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "resourceIdentifier", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - }, - "delete": { - "tags": [ - "License" - ], - "description": "

Deletes a specified license by resource ID.

\n \nToken usage: NetApp Console service token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "resourceIdentifier", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/exchange": { - "post": { - "tags": [ - "License" - ], - "description": "

Exchanges an unused Cloud Volume ONTAP license with a data service license.

\n

Note:
\nTo use this endpoint you must be an account administrator.

\n
    \n
  • accountId, targetLicenseType and resourceId are required fields.
    • \n
\n \nToken usage: NetApp Console user token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "targetLicenseType": { - "type": "string" - }, - "resourceId": { - "type": "string" - }, - "partnerResourceId": { - "type": "string" - } - }, - "required": [ - "accountId", - "targetLicenseType", - "resourceId" - ], - "example": { - "accountId": "string", - "targetLicenseType": "string", - "resourceId": "string", - "partnerResourceId": "string" - } - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - }, - "5XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/account/{accountId}/licenses": { - "patch": { - "tags": [ - "License" - ], - "description": "

Updates all licenses under an organization ID.

\n \nToken usage: NetApp Console service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "meteringStatus": { - "type": "boolean" - } - }, - "required": [ - "meteringStatus" - ], - "example": { - "meteringStatus": true - } - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/data-service-eligibility/account/{accountId}/provider/{cloudProvider}": { - "get": { - "tags": [ - "Data Services" - ], - "description": "

Retrieves data service eligibility details to determine whether an account is eligible to use a data service in an on-premises or cloud environment.

\n

Note:

\n
    \n
  • \n

    You can use a user token or service token with scope: license:internal.

    \n
    • \n
  • \n

    accountId, cloudProvider, and service are required parameters.

    \n
    • \n
  • \n

    The 'SGWS' value in the cloudProvider parameter denotes that the feature details request is for an on-premises ONTAP system backed up in StorageGRID and retrieves only license details.

    \n
    • \n
  • \n

    cloudAccountId and cvoId are optional parameters.

    \n
    • \n
  • \n

    If the feature details request is for a Cloud Volumes ONTAP or an on-premises ONTAP system backed up on a cloud, you must provide cloudAccountId.

    \n
    • \n
  • \n

    If the feature details request is for Cloud Volumes ONTAP, you must provide the cvoId parameter that is used to retrieve the Cloud Volumes ONTAP package.

    \n
    • \n
  • \n

    The TotalServiceLicensesCapacity value is in TB, the TotalServiceLicensesUsedCapacity value is in TiB, and the FreeTrialEndDate value is in ISO 8601 format.

    \n
    • \n
\n \nToken usage: Either a NetApp Console user token or service token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "service", - "required": true - }, - { - "schema": { - "type": [ - "string", - "null" - ] - }, - "in": "query", - "name": "cloudAccountId", - "required": false - }, - { - "schema": { - "type": [ - "string", - "null" - ] - }, - "in": "query", - "name": "cvoId", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "cloudProvider", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "totalServiceLicensesCapacity": { - "type": "integer" - }, - "totalServiceLicensesUsedCapacity": { - "type": "number" - }, - "subscriptionDetails": { - "type": "object", - "properties": { - "subscriptionId": { - "type": "string", - "nullable": true - }, - "active": { - "type": "boolean", - "nullable": true - } - }, - "nullable": true - }, - "freeTrialEndDate": { - "type": "string", - "nullable": true - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/account/{accountId}/subscriptions/{subscriptionId}": { - "post": { - "tags": [ - "Subscription" - ], - "description": "

Registers a subscription with the NetApp Console and associates it with the account by using the identity and access management service.
\nEach subscription can be associated with multiple accounts.

\n

Note:

\n

This endpoint updates the expiration date based on the date provided in the request.

\n \n \nToken usage: NetApp Console service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "subscriptionType": { - "type": "string" - }, - "expirationDate": { - "type": "integer" - }, - "dwAudit": { - "type": "boolean", - "description": "

The NetApp Console audits, by default, all API calls.

\n

Note:

\n
    \n
  • To stop the NetApp Console from auditing a request, you can set the calling service to false.
    • \n
  • dwAudit is an optional parameter, the default value is true.
    • \n
\n", - "default": true - } - }, - "required": [ - "subscriptionType", - "expirationDate" - ], - "example": { - "subscriptionType": "string", - "expirationDate": "defined as UNIX time in milliseconds", - "dwAudit": "false/true" - } - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string", - "minLength": 9 - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string", - "minLength": 1 - }, - "in": "path", - "name": "subscriptionId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/account/{accountId}/subscriptions": { - "get": { - "tags": [ - "Subscription" - ], - "description": "

Retrieves the subscription information for a specified subscription.

\n

Note:

\n
    \n
  • In the context of an account provided in URL parameters, the API returns subscriptions for all accounts.
    • \n
  • If the subscription ID is provided, the API returns only the subscription details or an empty response.
    • \n
  • The API authorizes three types of calls: user calls, agent calls (Console agent), and service calls (with a predefined scope).
    • \n
  • For a service call, you must send the subscription type as a query parameter (the API validates the scope against the subscription type).
    • \n
\n \nToken usage: NetApp Console service token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "subscriptionId", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "subscriptionType", - "required": false - }, - { - "schema": { - "type": "string", - "minLength": 9 - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "subscriptions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "subscriptionId": { - "type": "string" - }, - "subscriptionType": { - "type": "string" - }, - "expirationDate": { - "type": "integer" - }, - "numberOfAssociatedCvos": { - "type": "integer", - "default": 0 - }, - "lastModified": { - "type": "integer" - } - } - } - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/subscriptions/{subscriptionId}": { - "patch": { - "tags": [ - "Subscription" - ], - "description": "

Updates a subscription expiration date by using a specified subscription ID for services that support modification of the subscription expiry dates. Alternatively, you can update the subscription name of the services.

\n

Note:
\nTo update the expiration date, the expiration date and service name are mandatory, dwAudit is optional.
\nTo update the subscription name, provide only the subscription name. Do not provide a value for dwAudit.

\n \n \nToken usage: NetApp Console service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "subscriptionType": { - "type": "string" - }, - "expirationDate": { - "type": "integer" - }, - "dwAudit": { - "type": "boolean", - "description": "

The NetApp Console audits, by default, all API calls.

\n

Note:

\n
    \n
  • To stop the NetApp Console from auditing a request, you can set the calling service to false.
    • \n
  • dwAudit is an optional parameter, the default value is true.
    • \n
\n", - "default": true - } - }, - "required": [ - "subscriptionType", - "expirationDate" - ], - "example": { - "subscriptionType": "string", - "expirationDate": "defined as UNIX time in milliseconds", - "dwAudit": "false/true" - } - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string", - "minLength": 1 - }, - "in": "path", - "name": "subscriptionId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/account/{accountId}/subscription/{subscriptionId}": { - "delete": { - "tags": [ - "Subscription" - ], - "description": "

Deletes or disassociates a subscription that contains the specified subscription ID from an account.

\n

The specified subscription must exist and not be associated with a Cloud Volumes ONTAP instance.
\nThis endpoint deletes the subscription if no other account is associated with the subscription.
\nIf more than one account is associated with the subscription, this endpoint disassociates the account provided in the accountId field and the subscription.

\n \nToken usage: NetApp Console service token.", - "parameters": [ - { - "schema": { - "type": "boolean", - "default": true - }, - "in": "query", - "name": "dwAudit", - "required": false, - "description": "

The NetApp Console audits, by default, all API calls.

\n

Note:

\n
    \n
  • To stop the NetApp Console from auditing a request, you can set the calling service to false.
    • \n
  • dwAudit is an optional parameter, the default value is true.
    • \n
\n" - }, - { - "schema": { - "type": "string", - "minLength": 9 - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string", - "minLength": 1 - }, - "in": "path", - "name": "subscriptionId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/onPrem/account/{accountId}/clusters": { - "get": { - "tags": [ - "External Services" - ], - "description": "

Retrieves on-premises ONTAP cluster data.
\nThe ONTAP cluster must be configured for AutoSupport to send back the telemetry and configuration data to NetApp.

\n

Data retrieved by this endpoint is comprised mostly of ONTAP cluster configuration details (such as the cluster management IP address, capacity, contract date, feature licenses, and more).

\n \nToken usage: NetApp Console user token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "x-doc": { - "title": "", - "category": "", - "filename": "" - }, - "responses": { - "200": { - "description": "Account onPremise data", - "content": { - "application/json": { - "schema": { - "description": "Account onPremise data", - "type": "object", - "properties": { - "partialResponse": { - "type": "boolean" - }, - "clusterData": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hostName": { - "type": "string" - }, - "serialNumber": { - "type": "string" - }, - "hardwareContractEndDate": { - "type": "string" - }, - "softwareContractEndDate": { - "type": "string" - }, - "serviceTier": { - "type": "string" - }, - "clusterIp": { - "type": "string" - }, - "clusterName": { - "type": "string" - }, - "clusterId": { - "type": "string" - }, - "usedCapacity": { - "type": "integer" - }, - "allocatedCapacity": { - "type": "integer" - }, - "discovered": { - "type": "boolean" - } - } - } - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/subscriptions/entitlements": { - "get": { - "tags": [ - "Subscription" - ], - "description": "

Retrieves the subscription entitlements information for a specified service name.

\n

Note:

\n
    \n
  • This API authorizes service calls with a predefined scope only.
    • \n
\n
\nToken usage: NetApp Console service token with the following scopes: %scopes%.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "serviceName", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-3" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/subscriptions/account/{accountId}": { - "get": { - "tags": [ - "Subscription" - ], - "description": "

Retrieves the subscription information for a specified account ID.

\n

Note:

\n
    \n
  • If entitlements are provided, the API endpoint also returns the entitlements related to each subscription.
    • \n
  • If serviceName is provided, the API returns only the subscription related to the service name.
    • \n
  • The API authorizes two types of calls: user calls and service calls (with a predefined scope).
    \nFor KEYSTONE, only user calls are allowed.
    • \n
\n
\nToken usage: Either a NetApp Console user token or service token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "serviceName", - "required": false - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "entitlements", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "subscriptionId", - "required": false - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "dimensions", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "cloudProvider", - "required": false - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "extendSubInfo", - "required": false - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "extendEntitlementsInfo", - "required": false - }, - { - "schema": { - "type": "boolean", - "default": false - }, - "in": "query", - "name": "extendUsageReport", - "required": false - }, - { - "schema": { - "type": "boolean", - "default": false - }, - "in": "query", - "name": "includeCloudAccounts", - "required": false - }, - { - "schema": { - "type": "boolean", - "default": false - }, - "in": "query", - "name": "includeSummaryInfo", - "required": false - }, - { - "schema": { - "type": "string", - "default": "ALL" - }, - "in": "query", - "name": "eventTypes", - "required": false - }, - { - "schema": { - "type": "string", - "minLength": 9 - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/def-2" - } - }, - "servicesSummaryInfos": { - "type": "array", - "items": { - "$ref": "#/components/schemas/def-4" - } - }, - "subscriptionsSummary": { - "type": "object", - "properties": { - "annualContracts": { - "type": "integer" - }, - "payGo": { - "type": "integer" - }, - "unsubscribed": { - "type": "integer" - }, - "unconfigured": { - "type": "integer" - }, - "expired": { - "type": "integer" - }, - "aboutToExpire": { - "type": "integer" - } - } - } - } - }, - { - "type": "object", - "properties": { - "subscriptions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "subscriptionId": { - "type": "string" - }, - "subscriptionType": { - "type": "string" - }, - "expirationDate": { - "type": "integer" - }, - "numberOfAssociatedCvos": { - "type": "integer", - "default": 0 - }, - "lastModified": { - "type": "integer" - } - } - } - } - } - } - ] - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - }, - "delete": { - "tags": [ - "Subscription" - ], - "description": "

Deletes or disassociates a subscription that contains the specified subscription ID from an account.

\n

The specified subscription must exist and not be associated with a Cloud Volumes ONTAP instance.
\nThis endpoint deletes the subscription if no other account is associated with the subscription.
\nIf more than one account is associated with the subscription, this endpoint disassociates the account provided in the accountId field and the subscription.

\n
\nToken usage: Either a NetApp Console user token or service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "subscriptionId": { - "type": "string", - "minLength": 1 - } - }, - "required": [ - "subscriptionId" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string", - "minLength": 9 - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - }, - "post": { - "tags": [ - "Subscription" - ], - "description": "

Associate a subscription with an identity and access management service account.
\nEach subscription can be associated with multiple accounts.

\n
\nToken usage: Either a NetApp Console user token or service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "subscriptionId": { - "type": "string" - } - }, - "required": [ - "subscriptionId" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string", - "minLength": 9 - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/subscriptions/subscription/{subscriptionId}": { - "get": { - "tags": [ - "Subscription" - ], - "description": "

Retrieves the subscription information for a specified subscription ID. A newer version of this deprecated endpoint is available here.

\n

Note:

\n
    \n
  • This API authorizes service calls with a predefined scope only.
    • \n
\n
\nToken usage: NetApp Console service token with the following scopes: %scopes%.", - "parameters": [ - { - "schema": { - "type": "string", - "minLength": 9 - }, - "in": "path", - "name": "subscriptionId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "deprecated": true, - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - }, - "patch": { - "tags": [ - "Subscription" - ], - "description": "

Updates a subscription expiration date by using a specified subscription ID for services that support modification of the subscription expiry dates. Alternatively, you can update the subscription name of the services. A newer version of this deprecated endpoint is available here.

\n

Note:
\nTo update the expiration date, the expiration date and service name are mandatory, dwAudit is optional.
\nTo update the subscription name, provide only the subscription name. Do not provide a value for dwAudit.

\n
\nToken usage: Either a NetApp Console user token or service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "serviceName": { - "type": "string" - }, - "subscriptionName": { - "type": "string", - "minLength": 2, - "maxLength": 50 - }, - "expirationDate": { - "type": "integer" - }, - "subscriptionType": { - "type": "string" - }, - "dwAudit": { - "type": "boolean", - "description": "

The NetApp Console audits, by default, all API calls.

\n

Note:

\n
    \n
  • To stop the NetApp Console from auditing a request, you can set the calling service to false.
    • \n
  • dwAudit is an optional parameter, the default value is true.
    • \n
\n" - } - }, - "oneOf": [ - { - "allOf": [ - { - "required": [ - "serviceName" - ] - }, - { - "required": [ - "expirationDate" - ] - }, - { - "required": [ - "subscriptionType" - ] - } - ] - }, - { - "allOf": [ - { - "not": { - "required": [ - "dwAudit" - ] - } - }, - { - "required": [ - "subscriptionName" - ] - } - ] - } - ] - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "subscriptionId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "deprecated": true, - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/subscriptions/account/{accountId}/subscription/{subscriptionId}": { - "delete": { - "tags": [ - "Subscription" - ], - "description": "

Deletes or disassociates a subscription that contains the specified subscription ID from an account. A newer version of this deprecated endpoint is available here.

\n

The specified subscription must exist and not be associated with a Cloud Volumes ONTAP instance.
\nThis endpoint deletes the subscription if no other account is associated with the subscription.
\nIf more than one account is associated with the subscription, this endpoint disassociates the account provided in the accountId field and the subscription.

\n
\nToken usage: Either a NetApp Console user token or service token.", - "parameters": [ - { - "schema": { - "type": "string", - "minLength": 9 - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string", - "minLength": 1 - }, - "in": "path", - "name": "subscriptionId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "deprecated": true, - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/subscriptions/subscription/{subscriptionId}/account/{accountId}": { - "post": { - "tags": [ - "Subscription" - ], - "description": "

Associate a subscription with an identity and access management service account.
\nEach subscription can be associated with multiple accounts. A newer version of this deprecated endpoint is available here.

\n
\nToken usage: Either a NetApp Console user token or service token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "subscriptionId", - "required": true - }, - { - "schema": { - "type": "string", - "minLength": 9 - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "deprecated": true, - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/subscriptions/subscription": { - "get": { - "tags": [ - "Subscription" - ], - "description": "

Retrieves the subscription information for a specified subscription ID.

\n

Note:

\n
    \n
  • This API authorizes service calls with a predefined scope only.
    • \n
\n
\nToken usage: NetApp Console service token with the following scopes: %scopes%.", - "parameters": [ - { - "schema": { - "type": "string", - "minLength": 9 - }, - "in": "query", - "name": "subscriptionId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - }, - "patch": { - "tags": [ - "Subscription" - ], - "description": "

Updates a subscription expiration date by using a specified subscription ID for services that support modification of the subscription expiry dates. Alternatively, you can update the subscription name of the services.

\n

Note:
\nTo update the expiration date, the expiration date and service name are mandatory, dwAudit is optional.
\nTo update the subscription name, provide only the subscription name. Do not provide a value for dwAudit.

\n
\nToken usage: Either a NetApp Console user token or service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "subscriptionId": { - "type": "string" - }, - "accountId": { - "type": "string" - }, - "serviceName": { - "type": "string" - }, - "subscriptionName": { - "type": "string", - "minLength": 2, - "maxLength": 50 - }, - "expirationDate": { - "type": "integer" - }, - "subscriptionType": { - "type": "string" - }, - "dwAudit": { - "type": "boolean", - "description": "

The NetApp Console audits, by default, all API calls.

\n

Note:

\n
    \n
  • To stop the NetApp Console from auditing a request, you can set the calling service to false.
    • \n
  • dwAudit is an optional parameter, the default value is true.
    • \n
\n" - } - }, - "oneOf": [ - { - "allOf": [ - { - "required": [ - "serviceName" - ] - }, - { - "required": [ - "expirationDate" - ] - }, - { - "required": [ - "subscriptionType" - ] - }, - { - "required": [ - "subscriptionId" - ] - } - ] - }, - { - "allOf": [ - { - "not": { - "required": [ - "dwAudit" - ] - } - }, - { - "required": [ - "subscriptionName" - ] - }, - { - "required": [ - "subscriptionId" - ] - } - ] - } - ] - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "x-doc": { - "title": "", - "category": "", - "filename": "", - "explorer": false - }, - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/account/{accountId}/subscriptions/preferred": { - "get": { - "tags": [ - "Subscription" - ], - "description": "

Retrieves the preferred subscription ID for a specified account ID.

\n

Note:

\n
    \n
  • This API authorizes user calls and service calls with a predefined scope only.
    • \n
\n \nToken usage: Either a NetApp Console user token or service token.", - "parameters": [ - { - "schema": { - "type": "string", - "enum": [ - "aws", - "azure", - "gcp" - ], - "example": "aws" - }, - "in": "query", - "name": "cloudProvider", - "required": false - }, - { - "schema": { - "type": "string", - "minLength": 9 - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/def-2" - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - }, - "put": { - "tags": [ - "Subscription" - ], - "description": "

Updates the preferred subscription for a specified account ID.

\n

Note:

\n
    \n
  • This API authorizes user calls and service calls with a predefined scope only.
    • \n
\n \nToken usage: NetApp Console user token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aws": { - "type": "string" - }, - "gcp": { - "type": "string" - }, - "azure": { - "type": "string" - } - }, - "example": { - "aws": "aws-dqz78r9am2t0pvq9ve75uyxvc-NkQVsenYr39", - "azure": "azure-cloud-manager-1d3fce69-6982-44ab-d094-b3a443c5ede1", - "gcp": "gcp-netapp-cloudmanager/cloud-manager-for-cloud-volumes-ontap-9eb59d54-f139-4f7a-a230-9d6fcbq17c6a" - } - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string", - "minLength": 9 - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/subscriptions/configuration": { - "get": { - "tags": [ - "Subscription" - ], - "description": "

Retrieves the subscription configuration information for a specified subscription ID.

\n

Note:

\n
    \n
  • This API authorizes user calls and service calls with a predefined scope only.
    • \n
\n
\nToken usage: Either a NetApp Console user token or service token.", - "parameters": [ - { - "schema": { - "type": "string", - "example": "account-a2dsada" - }, - "in": "query", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string", - "minLength": 9 - }, - "in": "query", - "name": "subscriptionId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cloudAccountIds": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - }, - "patch": { - "tags": [ - "Subscription" - ], - "description": "

Sets the subscription configuration.
\nAssociates subscriptions to cloud accounts.

\n
\nToken usage: NetApp Console user token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "subscriptionId": { - "type": "string", - "minLength": 9 - }, - "cloudAccountIds": { - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "accountId", - "cloudAccountIds", - "subscriptionId" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "array", - "items": { - "type": "object", - "properties": { - "cloudAccountId": { - "type": "string" - }, - "status": { - "type": "string" - }, - "result": { - "type": "string" - } - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - }, - "/license/subscriptions/cloud-account/association": { - "get": { - "tags": [ - "Subscription" - ], - "description": "

Retrieves the associated subscription ID for each cloud account ID.

\n

Note:

\n
    \n
  • This API authorizes user calls and service calls with a predefined scope only.
    • \n
\n
\nToken usage: Either a NetApp Console user token or service token.", - "parameters": [ - { - "schema": { - "type": "string", - "example": "account-a2dsada" - }, - "in": "query", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "cloudAccountId": { - "type": "string" - }, - "subscriptionId": { - "type": "string" - } - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-1", - "description": "Error response" - } - } - } - } - } - } - } - }, - "servers": [ - { - "url": "https://dev.cloudmanager.cloud.netapp.com" - } - ], - "security": [ - { - "authorization": [] - } - ], - "tags": [ - { - "name": "License", - "description": "
\nOverview\n

The license endpoints manage the licenses for end users.
\nThis includes monitoring the expiration and capacity usage of end-user licenses.

\n

A license is a collection of the following information:

\n
    \n
  • License serial number (such as 481000495)
    • \n
  • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
    • \n
  • License type (such as BACKUP)
    • \n
  • Permitted capacity
    • \n
  • Expiration date
    • \n
\n
\n" - }, - { - "name": "Subscription", - "description": "
\nOverview\n

The subscription endpoints manage the subscriptions to NetApp Console services for end users.
\nThe endpoints register a specified subscription with the Console and associate it with the identity and access management service.

\n

A subscription for the Console services is a collection of the following:

\n
    \n
  • Subscription ID (such as 666777, A-S000003969)
    • \n
  • Subscription type (such as Keystone)
    • \n
  • Expiration date (such as 20251109)
    • \n
  • Last modified (such as 2021-11-09 00:00:00)
    • \n
  • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
    • \n
\n

The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

\n

Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

\n

You can perform the following actions with the subscription endpoints:

\n
    \n
  • Read, create, update, or delete a subscription.
    • \n
\n
\n" - }, - { - "name": "External Services", - "description": "
\nOverview\n

The external services endpoints retrieve data from external services that display in the NetApp Console.

\n

You can perform the following actions with the external services endpoints:

\n
    \n
  • Read on-premises (on-prem) ONTAP cluster data.
    • \n
\n
" - }, - { - "name": "Data Services", - "description": "
\nOverview\n

The data services endpoints retrieve data service information that is managed in the NetApp Console.

\n

You can perform the following actions with the data services endpoints:

\n
    \n
  • Read eligibility details of an account for a data service
    • \n
\n
\n" - } - ], - "externalDocs": { - "url": "https://docs.netapp.com/us-en/console-automation/cm/introduction.html", - "description": "Learn more about the NetApp Console control plane REST APIs." - } -} \ No newline at end of file diff --git a/dw/external_services_overview.adoc b/dw/external_services_overview.adoc new file mode 100644 index 00000000..83acbcef --- /dev/null +++ b/dw/external_services_overview.adoc @@ -0,0 +1,19 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/external_services_overview.html' +summary: 'External services endpoints in the License and subscriptions REST API for the NetApp Console' +--- + += External services endpoints in the License and subscriptions REST API for the NetApp Console + + + +The external services endpoints retrieve data from external services that display in the NetApp Console. + +You can perform the following actions with the external services endpoints: + +* Read on-premises (on-prem) ONTAP cluster data. + + diff --git a/dw/get-license-account-subscriptions-preferred.adoc b/dw/get-license-account-subscriptions-preferred.adoc new file mode 100644 index 00000000..9745a931 --- /dev/null +++ b/dw/get-license-account-subscriptions-preferred.adoc @@ -0,0 +1,426 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/get-license-account-subscriptions-preferred.html' +summary: 'Retrieve the preferred subscription ID for an account' +--- + += Retrieve the preferred subscription ID for an account + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/license/account/{accountId}/subscriptions/preferred`# + + + +Retrieves the preferred subscription ID for a specified account ID. + +**Note:** + +* This API authorizes user calls and service calls with a predefined scope only. +*Token usage:* Either a NetApp Console user token or service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cloudProvider +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accounts +|array[string] +|False +a| + +|createdAt +|integer +|False +a| + +|cloudProvider +|string +|False +a| + +|entitlements +|link:#entitlements[entitlements] +|False +a| + +|dimensions +|array[string] +|False +a| + +|contract +|boolean +|False +a| + +|customerIdentifier +|string +|False +a| + +|productCode +|string +|False +a| + +|planId +|string +|False +a| + +|serviceName +|string +|False +a| + +|subscriptionId +|string +|False +a| + +|subscriptionName +|string +|False +a| + +|subscriptionStatus +|string +|False +a| + +|autoRenew +|string +|False +a| + +|endDate +|["null", "integer"] +|False +a| + +|term +|["null", "string"] +|False +a| + +|isPrivate +|["null", "boolean"] +|False +a| + +|listingUrl +|["null", "string"] +|False +a| + +|productTitle +|["null", "string"] +|False +a| + +|cloudIds +|array[string] +|False +a| + +|availableDimensions +|array[string] +|False +a| + +|configuration +|string +|False +a| + +|events +|link:#events[events] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accounts": [ + "account-sdajkj5", + "account-euir74j" + ], + "createdAt": 1556636730921, + "cloudProvider": "aws", + "entitlements": { + "items": [ + { + "contractOption": "Professional", + "units": "12 TiB", + "expirationDate": "2026-07-02T00:00:00Z", + "details": "High Availability + Unlimited Cloud Backup", + "category": "Cloud Volumes ONTAP", + "dimension": "tier12", + "IntegerValue": 1, + "usageReport": 12, + "unit": "TiB", + "serviceName": "CVO" + } + ] + }, + "dimensions": [ + "professional" + ], + "contract": false, + "customerIdentifier": "FJsUvVHffi9", + "productCode": "1ajwvb3kjavjlk36izcn19e07", + "planId": "paygo_example", + "serviceName": "cloud-volumes-ontap", + "subscriptionId": "aws-abcd-1234", + "subscriptionName": "My Prod CVO subscription", + "subscriptionStatus": "subscribed", + "autoRenew": "N/A", + "endDate": 1556636730921, + "term": "12 Months", + "isPrivate": true, + "listingUrl": "https://marketplace-fake-url.com", + "productTitle": "Cloud Manager - Deploy & Manage Netapp Cloud Data Service", + "cloudIds": [ + "0ae5-rew5-ttt1-4563" + ], + "availableDimensions": [ + "ransomware_resilience" + ], + "configuration": "string", + "events": { + "endDateEvent": { + "type": "string" + } + } +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#items] +[.api-collapsible-fifth-title] +items + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contractOption +|string +|False +a| + +|units +|string +|False +a| + +|expirationDate +|string +|False +a| + +|details +|string +|False +a| + +|category +|string +|False +a|* example: Cloud Volumes ONTAP + + +|dimension +|string +|False +a| + +|IntegerValue +|integer +|False +a| + +|usageReport +|integer +|False +a| + +|unit +|string +|False +a| + +|serviceName +|string +|False +a| + +|=== + + +[#entitlements] +[.api-collapsible-fifth-title] +entitlements + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|items +|array[link:#items[items]] +|False +a| + +|=== + + +[#endDateEvent] +[.api-collapsible-fifth-title] +endDateEvent + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|subscriptionExpirationInDays +|integer +|False +a| + +|=== + + +[#events] +[.api-collapsible-fifth-title] +events + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|endDateEvent +|link:#endDateEvent[endDateEvent] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/dw/get-license-account-subscriptions.adoc b/dw/get-license-account-subscriptions.adoc new file mode 100644 index 00000000..731d42af --- /dev/null +++ b/dw/get-license-account-subscriptions.adoc @@ -0,0 +1,192 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/get-license-account-subscriptions.html' +summary: 'Retrieve all subscriptions for an account' +--- + += Retrieve all subscriptions for an account + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/license/account/{accountId}/subscriptions`# + + + +Retrieves the subscription information for a specified subscription. + +**Note:** + +* In the context of an account provided in URL parameters, the API returns subscriptions for all accounts. +* If the subscription ID is provided, the API returns only the subscription details or an empty response. +* The API authorizes three types of calls: user calls, agent calls (Console agent), and service calls (with a predefined scope). +* For a service call, you must send the subscription type as a query parameter (the API validates the scope against the subscription type). +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|query +|False +a| + +|subscriptionType +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptions +|array[link:#subscriptions[subscriptions]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "subscriptions": [ + { + "subscriptionId": "string", + "subscriptionType": "string" + } + ] +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#subscriptions] +[.api-collapsible-fifth-title] +subscriptions + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|False +a| + +|subscriptionType +|string +|False +a| + +|expirationDate +|integer +|False +a| + +|numberOfAssociatedCvos +|integer +|False +a| + +|lastModified +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/dw/get-license-data-service-eligibility-account-provider-.adoc b/dw/get-license-data-service-eligibility-account-provider-.adoc new file mode 100644 index 00000000..3aa19e4c --- /dev/null +++ b/dw/get-license-data-service-eligibility-account-provider-.adoc @@ -0,0 +1,204 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/get-license-data-service-eligibility-account-provider-.html' +summary: 'Retrieve data service eligibility details' +--- + += Retrieve data service eligibility details + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/license/data-service-eligibility/account/{accountId}/provider/{cloudProvider}`# + + + +Retrieves data service eligibility details to determine whether an account is eligible to use a data service in an on-premises or cloud environment. + +**Note:** + +* You can use a user token or service token with scope: license:internal. +* `accountId`, `cloudProvider`, and `service` are required parameters. +* The 'SGWS' value in the cloudProvider parameter denotes that the feature details request is for an on-premises ONTAP system backed up in StorageGRID and retrieves only license details. +* `cloudAccountId` and `cvoId` are optional parameters. +* If the feature details request is for a Cloud Volumes ONTAP or an on-premises ONTAP system backed up on a cloud, you must provide `cloudAccountId`. +* If the feature details request is for Cloud Volumes ONTAP, you must provide the `cvoId` parameter that is used to retrieve the Cloud Volumes ONTAP package. +* The TotalServiceLicensesCapacity value is in TB, the TotalServiceLicensesUsedCapacity value is in TiB, and the FreeTrialEndDate value is in ISO 8601 format.*Token usage:* Either a NetApp Console user token or service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|service +|string +|query +|True +a| + +|cloudAccountId +|["string", "null"] +|query +|False +a| + +|cvoId +|["string", "null"] +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|cloudProvider +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|totalServiceLicensesCapacity +|integer +|False +a| + +|totalServiceLicensesUsedCapacity +|number +|False +a| + +|subscriptionDetails +|link:#subscriptionDetails[subscriptionDetails] +|False +a| + +|freeTrialEndDate +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "subscriptionDetails": { + "subscriptionId": "string" + }, + "freeTrialEndDate": "string" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#subscriptionDetails] +[.api-collapsible-fifth-title] +subscriptionDetails + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|False +a| + +|active +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/dw/get-license-licenses.adoc b/dw/get-license-licenses.adoc new file mode 100644 index 00000000..c459d765 --- /dev/null +++ b/dw/get-license-licenses.adoc @@ -0,0 +1,174 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/get-license-licenses.html' +summary: 'Retrieve a license by type' +--- + += Retrieve a license by type + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/license/licenses`# + + + +Retrieves a specified license by type (`LicenseType`), a resource ID (`resourceId`), or both. + +The license endpoints consult the used or consumed capacity under the `includeSummaryInfo` parameter when retrieving licenses with the GET API call. + +**Note:** + +* If you use a NetApp Console service token, accountId is not a required field. +* If you use a NetApp Console user token, `accountId` is a required field. +* When you enter a value in `serialNumber` , all other fields are ignored. +* The boolean parameter `includeSummaryInfo` (optional) retrieves the `totalLicensesCapacity`, `usedCapacity`, `reportTime` and events such as capacity expired or about to expire for each data service (CLOUD_BACKUP, CLOUD_DATA_SENSE, CLOUD_TIERING). +* The boolean parameter `fetchNlf` (optional) retrieves the most updated valid NetApp license file from NetApp systems. +* If you use the boolean parameter `fetchNlf`, you must provide `accountId`, `serialNumber`, and `nssKeyId`. +* `fetchNlf` and `includeSummaryInfo` can't be provided in the same request. +*Token usage:* Either a NetApp Console user token or service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|query +|False +a| + +|serialNumber +|["string", "null"] +|query +|False +a| + +|resourceId +|string +|query +|False +a| + +|licenseType +|string +|query +|False +a| + +|service +|string +|query +|False +a| + +|group +|string +|query +|False +a| + +|includeSummaryInfo +|boolean +|query +|False +a| + +|includeExchangedLicenses +|boolean +|query +|False +a| + +|fetchNlf +|boolean +|query +|False +a| + +|nssKeyId +|string +|query +|False +a| + +|eventTypes +|string +|query +|False +a| + +|meteringStatus +|string +|query +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/get-license-onprem-account-clusters.adoc b/dw/get-license-onprem-account-clusters.adoc new file mode 100644 index 00000000..5ece3c98 --- /dev/null +++ b/dw/get-license-onprem-account-clusters.adoc @@ -0,0 +1,218 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/get-license-onprem-account-clusters.html' +summary: 'Retrieve on-prem ONTAP data' +--- + += Retrieve on-prem ONTAP data + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/license/onPrem/account/{accountId}/clusters`# + + + +Retrieves on-premises ONTAP cluster data. + +The ONTAP cluster must be configured for AutoSupport to send back the telemetry and configuration data to NetApp. + +Data retrieved by this endpoint is comprised mostly of ONTAP cluster configuration details (such as the cluster management IP address, capacity, contract date, feature licenses, and more). + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Account onPremise data +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|partialResponse +|boolean +|False +a| + +|clusterData +|array[link:#clusterData[clusterData]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "clusterData": [ + { + "hostName": "string", + "serialNumber": "string", + "hardwareContractEndDate": "string", + "softwareContractEndDate": "string", + "serviceTier": "string", + "clusterIp": "string", + "clusterName": "string", + "clusterId": "string" + } + ] +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#clusterData] +[.api-collapsible-fifth-title] +clusterData + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hostName +|string +|False +a| + +|serialNumber +|string +|False +a| + +|hardwareContractEndDate +|string +|False +a| + +|softwareContractEndDate +|string +|False +a| + +|serviceTier +|string +|False +a| + +|clusterIp +|string +|False +a| + +|clusterName +|string +|False +a| + +|clusterId +|string +|False +a| + +|usedCapacity +|integer +|False +a| + +|allocatedCapacity +|integer +|False +a| + +|discovered +|boolean +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/dw/get-license-subscriptions-account-.adoc b/dw/get-license-subscriptions-account-.adoc new file mode 100644 index 00000000..faf74404 --- /dev/null +++ b/dw/get-license-subscriptions-account-.adoc @@ -0,0 +1,171 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/get-license-subscriptions-account-.html' +summary: 'Retrieve subscription information for an account' +--- + += Retrieve subscription information for an account + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/license/subscriptions/account/{accountId}`# + + + +Retrieves the subscription information for a specified account ID. + +**Note:** + +* If entitlements are provided, the API endpoint also returns the entitlements related to each subscription. +* If serviceName is provided, the API returns only the subscription related to the service name. +* The API authorizes two types of calls: user calls and service calls (with a predefined scope). + +For KEYSTONE, only user calls are allowed. + + +*Token usage:* Either a NetApp Console user token or service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|serviceName +|string +|query +|False +a| + +|entitlements +|boolean +|query +|False +a| + +|subscriptionId +|string +|query +|False +a| + +|dimensions +|boolean +|query +|False +a| + +|cloudProvider +|string +|query +|False +a| + +|extendSubInfo +|boolean +|query +|False +a| + +|extendEntitlementsInfo +|boolean +|query +|False +a| + +|extendUsageReport +|boolean +|query +|False +a| + +|includeCloudAccounts +|boolean +|query +|False +a| + +|includeSummaryInfo +|boolean +|query +|False +a| + +|eventTypes +|string +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/get-license-subscriptions-cloud-account-association.adoc b/dw/get-license-subscriptions-cloud-account-association.adoc new file mode 100644 index 00000000..2dc24864 --- /dev/null +++ b/dw/get-license-subscriptions-cloud-account-association.adoc @@ -0,0 +1,100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/get-license-subscriptions-cloud-account-association.html' +summary: 'Retrieve the associated subscription ID for cloud accounts' +--- + += Retrieve the associated subscription ID for cloud accounts + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/license/subscriptions/cloud-account/association`# + + + +Retrieves the associated subscription ID for each cloud account ID. + +**Note:** + +* This API authorizes user calls and service calls with a predefined scope only. + + +*Token usage:* Either a NetApp Console user token or service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|query +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/get-license-subscriptions-configuration.adoc b/dw/get-license-subscriptions-configuration.adoc new file mode 100644 index 00000000..d4d98515 --- /dev/null +++ b/dw/get-license-subscriptions-configuration.adoc @@ -0,0 +1,133 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/get-license-subscriptions-configuration.html' +summary: 'Retrieve subscription configuration information' +--- + += Retrieve subscription configuration information + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/license/subscriptions/configuration`# + + + +Retrieves the subscription configuration information for a specified subscription ID. + +**Note:** + +* This API authorizes user calls and service calls with a predefined scope only. + + +*Token usage:* Either a NetApp Console user token or service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|query +|True +a| + +|subscriptionId +|string +|query +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudAccountIds +|array[string] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "cloudAccountIds": [ + "string" + ] +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/get-license-subscriptions-entitlements.adoc b/dw/get-license-subscriptions-entitlements.adoc new file mode 100644 index 00000000..8cfbdf5e --- /dev/null +++ b/dw/get-license-subscriptions-entitlements.adoc @@ -0,0 +1,198 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/get-license-subscriptions-entitlements.html' +summary: 'Retrieve the subscription entitlements' +--- + += Retrieve the subscription entitlements + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/license/subscriptions/entitlements`# + + + +Retrieves the subscription entitlements information for a specified service name. + +**Note:** + +* This API authorizes service calls with a predefined scope only. + + +*Token usage:* NetApp Console service token with the following scopes: %scopes%. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|serviceName +|string +|query +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + +List of link:#response[response] + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#Value] +[.api-collapsible-fifth-title] +Value + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|IntegerValue +|integer +|False +a| + +|=== + + +[#entitlements] +[.api-collapsible-fifth-title] +entitlements + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|CustomerIdentifier +|string +|False +a| + +|Dimension +|string +|False +a| + +|ExpirationDate +|string +|False +a| + +|ProductCode +|string +|False +a| + +|Value +|link:#Value[Value] +|False +a| + +|=== + + +[#response] +[.api-collapsible-fifth-title] +response + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|entitlements +|array[link:#entitlements[entitlements]] +|False +a| + +|productCode +|string +|False +a| + +|error +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/dw/get-license-subscriptions-subscription-.adoc b/dw/get-license-subscriptions-subscription-.adoc new file mode 100644 index 00000000..18e0e5d2 --- /dev/null +++ b/dw/get-license-subscriptions-subscription-.adoc @@ -0,0 +1,424 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/get-license-subscriptions-subscription-.html' +summary: 'Retrieve subscription information using the subscription ID (deprecated)' +--- + += Retrieve subscription information using the subscription ID (deprecated) + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/license/subscriptions/subscription/{subscriptionId}`# + + + +Retrieves the subscription information for a specified subscription ID. A newer version of this deprecated endpoint is available https://docs.netapp.com/us-en/console-automation/dw/get-license-subscriptions-subscription.html[here.] + +**Note:** + +* This API authorizes service calls with a predefined scope only. + + +*Token usage:* NetApp Console service token with the following scopes: %scopes%. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accounts +|array[string] +|False +a| + +|createdAt +|integer +|False +a| + +|cloudProvider +|string +|False +a| + +|entitlements +|link:#entitlements[entitlements] +|False +a| + +|dimensions +|array[string] +|False +a| + +|contract +|boolean +|False +a| + +|customerIdentifier +|string +|False +a| + +|productCode +|string +|False +a| + +|planId +|string +|False +a| + +|serviceName +|string +|False +a| + +|subscriptionId +|string +|False +a| + +|subscriptionName +|string +|False +a| + +|subscriptionStatus +|string +|False +a| + +|autoRenew +|string +|False +a| + +|endDate +|["null", "integer"] +|False +a| + +|term +|["null", "string"] +|False +a| + +|isPrivate +|["null", "boolean"] +|False +a| + +|listingUrl +|["null", "string"] +|False +a| + +|productTitle +|["null", "string"] +|False +a| + +|cloudIds +|array[string] +|False +a| + +|availableDimensions +|array[string] +|False +a| + +|configuration +|string +|False +a| + +|events +|link:#events[events] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accounts": [ + "account-sdajkj5", + "account-euir74j" + ], + "createdAt": 1556636730921, + "cloudProvider": "aws", + "entitlements": { + "items": [ + { + "contractOption": "Professional", + "units": "12 TiB", + "expirationDate": "2026-07-02T00:00:00Z", + "details": "High Availability + Unlimited Cloud Backup", + "category": "Cloud Volumes ONTAP", + "dimension": "tier12", + "IntegerValue": 1, + "usageReport": 12, + "unit": "TiB", + "serviceName": "CVO" + } + ] + }, + "dimensions": [ + "professional" + ], + "contract": false, + "customerIdentifier": "FJsUvVHffi9", + "productCode": "1ajwvb3kjavjlk36izcn19e07", + "planId": "paygo_example", + "serviceName": "cloud-volumes-ontap", + "subscriptionId": "aws-abcd-1234", + "subscriptionName": "My Prod CVO subscription", + "subscriptionStatus": "subscribed", + "autoRenew": "N/A", + "endDate": 1556636730921, + "term": "12 Months", + "isPrivate": true, + "listingUrl": "https://marketplace-fake-url.com", + "productTitle": "Cloud Manager - Deploy & Manage Netapp Cloud Data Service", + "cloudIds": [ + "0ae5-rew5-ttt1-4563" + ], + "availableDimensions": [ + "ransomware_resilience" + ], + "configuration": "string", + "events": { + "endDateEvent": { + "type": "string" + } + } +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#items] +[.api-collapsible-fifth-title] +items + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contractOption +|string +|False +a| + +|units +|string +|False +a| + +|expirationDate +|string +|False +a| + +|details +|string +|False +a| + +|category +|string +|False +a|* example: Cloud Volumes ONTAP + + +|dimension +|string +|False +a| + +|IntegerValue +|integer +|False +a| + +|usageReport +|integer +|False +a| + +|unit +|string +|False +a| + +|serviceName +|string +|False +a| + +|=== + + +[#entitlements] +[.api-collapsible-fifth-title] +entitlements + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|items +|array[link:#items[items]] +|False +a| + +|=== + + +[#endDateEvent] +[.api-collapsible-fifth-title] +endDateEvent + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|subscriptionExpirationInDays +|integer +|False +a| + +|=== + + +[#events] +[.api-collapsible-fifth-title] +events + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|endDateEvent +|link:#endDateEvent[endDateEvent] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/dw/get-license-subscriptions-subscription.adoc b/dw/get-license-subscriptions-subscription.adoc new file mode 100644 index 00000000..9b7af5ef --- /dev/null +++ b/dw/get-license-subscriptions-subscription.adoc @@ -0,0 +1,421 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/get-license-subscriptions-subscription.html' +summary: 'Retrieve subscription information using the subscription ID' +--- + += Retrieve subscription information using the subscription ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/license/subscriptions/subscription`# + + + +Retrieves the subscription information for a specified subscription ID. + +**Note:** + +* This API authorizes service calls with a predefined scope only. + + +*Token usage:* NetApp Console service token with the following scopes: %scopes%. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|query +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accounts +|array[string] +|False +a| + +|createdAt +|integer +|False +a| + +|cloudProvider +|string +|False +a| + +|entitlements +|link:#entitlements[entitlements] +|False +a| + +|dimensions +|array[string] +|False +a| + +|contract +|boolean +|False +a| + +|customerIdentifier +|string +|False +a| + +|productCode +|string +|False +a| + +|planId +|string +|False +a| + +|serviceName +|string +|False +a| + +|subscriptionId +|string +|False +a| + +|subscriptionName +|string +|False +a| + +|subscriptionStatus +|string +|False +a| + +|autoRenew +|string +|False +a| + +|endDate +|["null", "integer"] +|False +a| + +|term +|["null", "string"] +|False +a| + +|isPrivate +|["null", "boolean"] +|False +a| + +|listingUrl +|["null", "string"] +|False +a| + +|productTitle +|["null", "string"] +|False +a| + +|cloudIds +|array[string] +|False +a| + +|availableDimensions +|array[string] +|False +a| + +|configuration +|string +|False +a| + +|events +|link:#events[events] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accounts": [ + "account-sdajkj5", + "account-euir74j" + ], + "createdAt": 1556636730921, + "cloudProvider": "aws", + "entitlements": { + "items": [ + { + "contractOption": "Professional", + "units": "12 TiB", + "expirationDate": "2026-07-02T00:00:00Z", + "details": "High Availability + Unlimited Cloud Backup", + "category": "Cloud Volumes ONTAP", + "dimension": "tier12", + "IntegerValue": 1, + "usageReport": 12, + "unit": "TiB", + "serviceName": "CVO" + } + ] + }, + "dimensions": [ + "professional" + ], + "contract": false, + "customerIdentifier": "FJsUvVHffi9", + "productCode": "1ajwvb3kjavjlk36izcn19e07", + "planId": "paygo_example", + "serviceName": "cloud-volumes-ontap", + "subscriptionId": "aws-abcd-1234", + "subscriptionName": "My Prod CVO subscription", + "subscriptionStatus": "subscribed", + "autoRenew": "N/A", + "endDate": 1556636730921, + "term": "12 Months", + "isPrivate": true, + "listingUrl": "https://marketplace-fake-url.com", + "productTitle": "Cloud Manager - Deploy & Manage Netapp Cloud Data Service", + "cloudIds": [ + "0ae5-rew5-ttt1-4563" + ], + "availableDimensions": [ + "ransomware_resilience" + ], + "configuration": "string", + "events": { + "endDateEvent": { + "type": "string" + } + } +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#items] +[.api-collapsible-fifth-title] +items + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|contractOption +|string +|False +a| + +|units +|string +|False +a| + +|expirationDate +|string +|False +a| + +|details +|string +|False +a| + +|category +|string +|False +a|* example: Cloud Volumes ONTAP + + +|dimension +|string +|False +a| + +|IntegerValue +|integer +|False +a| + +|usageReport +|integer +|False +a| + +|unit +|string +|False +a| + +|serviceName +|string +|False +a| + +|=== + + +[#entitlements] +[.api-collapsible-fifth-title] +entitlements + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|items +|array[link:#items[items]] +|False +a| + +|=== + + +[#endDateEvent] +[.api-collapsible-fifth-title] +endDateEvent + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|False +a| + +|subscriptionExpirationInDays +|integer +|False +a| + +|=== + + +[#events] +[.api-collapsible-fifth-title] +events + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|endDateEvent +|link:#endDateEvent[endDateEvent] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/dw/license_overview.adoc b/dw/license_overview.adoc new file mode 100644 index 00000000..f3592e35 --- /dev/null +++ b/dw/license_overview.adoc @@ -0,0 +1,24 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/license_overview.html' +summary: 'License endpoints in the License and subscriptions REST API for the NetApp Console' +--- + += License endpoints in the License and subscriptions REST API for the NetApp Console + + + +The license endpoints manage the licenses for end users. + +This includes monitoring the expiration and capacity usage of end-user licenses. + +A license is a collection of the following information: + +* License serial number (such as 481000495) +* Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally +* License type (such as BACKUP) +* Permitted capacity +* Expiration date + + diff --git a/dw/overview.adoc b/dw/overview.adoc new file mode 100644 index 00000000..5fe219f0 --- /dev/null +++ b/dw/overview.adoc @@ -0,0 +1,192 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/overview.html' +summary: 'Licenses and subscriptions REST API for the NetApp Console' +--- + += Licenses and subscriptions REST API for the NetApp Console + + + +NetApp Console manages licenses for Cloud Volumes ONTAP and subscriptions to other Console services. + +Every license and subscription managed by the Console is assigned a unique resource identifier in the identity and access management service. The ID associates it with a specific account. + +You can view and manage procured licenses and subscriptions by using the **Licenses and subscriptions** menu in the Console UI and through the licenses and subscriptions REST API endpoints. + +You can manage the following types of licenses in the Console: + +* Node: Each node has a unique serial number +* Capacity: Comes with multiple packages (Professional, Essential, Freemium (500 GB)) +* Data services: Used for data management services (Backup & Restore, Compliance (Data Sense), and Tiering) + +Each license contains the following information to monitor the expiration and capacity usage of licenses in an account: + +* License serial number (such as 481000485) +* License type/service (such as BACKUP) +* Permitted/Entitled capacity (TB) +* Expiration date + +Each subscription contains the following information to monitor the expiration and capacity subscriptions in an account + +(a subscription can be associated with more than one account): + +* Subscription number (subscription ID) +* Permitted/entitled capacity (TiB) +* Currently used (or consumed) capacity (TiB) +* Expiration date + +The following components are defined in the licenses and subscriptions REST API: + +* Data services +* External services +* License +* Subscription + +All licenses and subscriptions API calls are short-lived and run synchronously. Asynchronous processing and internal process tracking are not supported. + +**Note:** Before using the API reference documentation, review the https://docs.netapp.com/us-en/console-automation/platform/overview.html[Get started] section for the NetApp Console APIs. For more information about the security tokens and identifiers you'll need when using the API, review the https://docs.netapp.com/us-en/console-automation/platform/get_identifiers.html[Common workflows and tasks] section. + +''' + +== REST implementation + +=== HTTP methods + +|=== +| Method | Description + +| `POST` +| Create an object instance + +| `GET` +| Retrieve an object instance or collection + +| `PATCH` +| Update an existing object + +| `DELETE` +| Remove an existing object +|=== + +=== Request headers + +|=== +| Request Header | Description + +| `Authorization` +| Contains the JWT access token and is required + +| `X-Service-Request-Id` +| Used to tag a request with application-specific keys for improved supportability +|=== + +=== Query parameters + +You can use query parameters with endpoints in the following components: + +|=== +| Component | Query Parameter + +| `License` +| accountId + +serialNumber + +resourceId + +licenseType + +service + +group + +includeSummaryInfo (boolean) + +| `Subscription` +| subscriptionId + +subscriptionType +|=== + +=== Response headers + +This API uses the standard HTTP response headers common with all NetApp Console APIs. + +See https://docs.netapp.com/us-en/console-automation/platform/http_details.html#response-headers[REST implementation] for more information. + +=== HTTP status codes + +|=== +| HTTP Status Code | Description + +| `200` +| OK: Returned for successful operation completion + +| `400` +| Bad Request: Returned if the input is malformed and could not be parsed + +| `401` +| Unauthorized: Returned if user authentication failed or the token has expired + +| `403` +| Forbidden: Returned for authorization errors depending on the resource and token + +| `404` +| Not Found: Returned if the requested resource could not be found + +| `405` +| Method Not Allowed: Returned if the HTTP request method is not supported for a requested resource + +| `500` +| Processing Error: Returned if an error occurs on the server while processing the API call +|=== + +''' + +== Error handling + +There are three processes involved with error handling and processing. + +* The error is logged for supportability +* The error is also returned to the caller for any specific handling +* The database connection is rolled back + +''' + +== cURL examples + +=== Retrieve licenses + +This example retrieves all the licenses associated with a specified account. + +.... + + curl -X GET "https://api.bluexp.netapp.com/license/licenses?includeSummaryInfo=true" -H "accept: application/json" -H "authorization: " +.... + +''' + +== Frequently asked questions + +**What's the difference between user token and service token and why do we need two types of token authorization ?** + +A user token is used for communication between a user (or the UI) and the NetApp Console REST APIs, + +whereas the service token is used for communication between two services (machine-to-machine interaction) in the NetApp Console control plane. + +The type of token required to invoke an API is documented in the description of each endpoint. + +**What is a resource ID ?** + +A resource ID is an internal identifier to denote a resource in the Console control plane. For example, a resource ID such as `license-481000495-6897991f-f83f-41c1-b151-eb62073e57be` denotes a license resource, + +a resource ID such as `VsaWorkingEnvironment-XXXX` denotes a Cloud Volumes ONTAP instance. + +**What's `X-Service-Request-Id` and why do we use it ?** + +`X-Service-Request-Id` is an optional parameter and can be passed to the NetApp Console APIs to identify the origin of the request. + +It is used for tagging the API call with a specific ID for logging and better supportability. + +**What does the parameter `includeSummaryInfo` mean in a GET license API call ?** + +The `includeSummaryInfo` parameter contains various pieces of additional information associated with a license + +relating to its expiration and capacity usage. By default, the summary information is not included in the API response. + +You must pass the parameter explicitly to retrieve this information. + +**What does the parameter `group` mean in a GET license API call ?** + +`group` is the logical grouping of the various license types. Groups can be `Data Services` or `CVO`. + +The `Data Services` group includes `Cloud Backup`, `Cloud Data Sense` and `Cloud Tiering` services. + + diff --git a/dw/patch-license-account-licenseresource-.adoc b/dw/patch-license-account-licenseresource-.adoc new file mode 100644 index 00000000..61fb99ab --- /dev/null +++ b/dw/patch-license-account-licenseresource-.adoc @@ -0,0 +1,123 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/patch-license-account-licenseresource-.html' +summary: 'Update a license by resource ID' +--- + += Update a license by resource ID + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/license/account/{accountId}/licenseResource/{resourceIdentifier}`# + + + +Updates a specified license by resource ID. + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|resourceIdentifier +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|license +|["string", "null"] +|False +a| + +|=== + + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/patch-license-account-licenses.adoc b/dw/patch-license-account-licenses.adoc new file mode 100644 index 00000000..23d1a66d --- /dev/null +++ b/dw/patch-license-account-licenses.adoc @@ -0,0 +1,117 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/patch-license-account-licenses.html' +summary: 'Update all licenses under an organization ID' +--- + += Update all licenses under an organization ID + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/license/account/{accountId}/licenses`# + + + +Updates all licenses under an organization ID. + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|meteringStatus +|boolean +|True +a| + +|=== + + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/patch-license-serial-number-.adoc b/dw/patch-license-serial-number-.adoc new file mode 100644 index 00000000..2c61f948 --- /dev/null +++ b/dw/patch-license-serial-number-.adoc @@ -0,0 +1,160 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/patch-license-serial-number-.html' +summary: 'Update a license by serial number' +--- + += Update a license by serial number + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/license/serial-number/{serialNumber}`# + + + +Updates a specified license by license serial number. + +If you use a user token, you must provide the NetApp License File (NLF). If you use the NetApp Console service token, provide either the NLF or values for `serialNumber` and the fields that you want to update. + +**Note:** + +* If you use a NetApp Console service token, accountId is not a required field. +* If you use a NetApp Console user token, accountId is a required field. +* If you provide the NLF, the license data is overwritten by the NLF data. +* The `metadata` field value is appended to the existing metadata. +* `Authorization` is a required field. +* `serialNumber` is a required field when using this site. In general, you can specify its value as `null`. +*Token usage:* Either a NetApp Console user token or service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|serialNumber +|["string", "null"] +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|False +a| + +|capacity +|["integer", "null"] +|False +a| + +|expirationDate +|["integer", "null"] +|False +a| + +|license +|["string", "null"] +|False +a| + +|meteringStatus +|boolean +|False +a| + +|metadata +|["array", "null"] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountId": "string" +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/patch-license-subscriptions-.adoc b/dw/patch-license-subscriptions-.adoc new file mode 100644 index 00000000..7fbb099a --- /dev/null +++ b/dw/patch-license-subscriptions-.adoc @@ -0,0 +1,137 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/patch-license-subscriptions-.html' +summary: 'Update a subscription expiration date using the subscription ID' +--- + += Update a subscription expiration date using the subscription ID + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/license/subscriptions/{subscriptionId}`# + + + +Updates a subscription expiration date by using a specified subscription ID for services that support modification of the subscription expiry dates. Alternatively, you can update the subscription name of the services. + +**Note:** + +To update the expiration date, the expiration date and service name are mandatory, dwAudit is optional. + +To update the subscription name, provide only the subscription name. Do not provide a value for dwAudit. + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionType +|string +|True +a| + +|expirationDate +|integer +|True +a| + +|dwAudit +|boolean +|False +a|The NetApp Console audits, by default, all API calls. + +NOTE: + +* To stop the NetApp Console from auditing a request, you can set the calling service to `false`. +* `dwAudit` is an optional parameter, the default value is `true`. + + +|=== + + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/patch-license-subscriptions-configuration.adoc b/dw/patch-license-subscriptions-configuration.adoc new file mode 100644 index 00000000..de0b4c6d --- /dev/null +++ b/dw/patch-license-subscriptions-configuration.adoc @@ -0,0 +1,134 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/patch-license-subscriptions-configuration.html' +summary: 'Set the subscription configuration' +--- + += Set the subscription configuration + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/license/subscriptions/configuration`# + + + +Sets the subscription configuration. + +Associates subscriptions to cloud accounts. + +{blank} + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|True +a| + +|subscriptionId +|string +|True +a| + +|cloudAccountIds +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountId": "string", + "subscriptionId": "string", + "cloudAccountIds": [ + "string" + ] +} +==== + +== Response + +``` +Status: 200, Success response +``` + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/patch-license-subscriptions-subscription-.adoc b/dw/patch-license-subscriptions-subscription-.adoc new file mode 100644 index 00000000..2bbba1b5 --- /dev/null +++ b/dw/patch-license-subscriptions-subscription-.adoc @@ -0,0 +1,168 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/patch-license-subscriptions-subscription-.html' +summary: 'Update a subscription expiration date (deprecated)' +--- + += Update a subscription expiration date (deprecated) + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/license/subscriptions/subscription/{subscriptionId}`# + + + +Updates a subscription expiration date by using a specified subscription ID for services that support modification of the subscription expiry dates. Alternatively, you can update the subscription name of the services. A newer version of this deprecated endpoint is available https://docs.netapp.com/us-en/console-automation/dw/patch-license-subscriptions-subscription.html[here.] + +**Note:** + +To update the expiration date, the expiration date and service name are mandatory, dwAudit is optional. + +To update the subscription name, provide only the subscription name. Do not provide a value for dwAudit. + +{blank} + +*Token usage:* Either a NetApp Console user token or service token. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|False +a| + +|serviceName +|string +|False +a| + +|subscriptionName +|string +|False +a| + +|expirationDate +|integer +|False +a| + +|subscriptionType +|string +|False +a| + +|dwAudit +|boolean +|False +a|The NetApp Console audits, by default, all API calls. + +NOTE: + +* To stop the NetApp Console from auditing a request, you can set the calling service to `false`. +* `dwAudit` is an optional parameter, the default value is `true`. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountId": "string", + "serviceName": "string", + "subscriptionName": "string", + "subscriptionType": "string" +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/patch-license-subscriptions-subscription.adoc b/dw/patch-license-subscriptions-subscription.adoc new file mode 100644 index 00000000..2d76df58 --- /dev/null +++ b/dw/patch-license-subscriptions-subscription.adoc @@ -0,0 +1,165 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/patch-license-subscriptions-subscription.html' +summary: 'Update a subscription expiration date' +--- + += Update a subscription expiration date + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/license/subscriptions/subscription`# + + + +Updates a subscription expiration date by using a specified subscription ID for services that support modification of the subscription expiry dates. Alternatively, you can update the subscription name of the services. + +**Note:** + +To update the expiration date, the expiration date and service name are mandatory, dwAudit is optional. + +To update the subscription name, provide only the subscription name. Do not provide a value for dwAudit. + +{blank} + +*Token usage:* Either a NetApp Console user token or service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|False +a| + +|accountId +|string +|False +a| + +|serviceName +|string +|False +a| + +|subscriptionName +|string +|False +a| + +|expirationDate +|integer +|False +a| + +|subscriptionType +|string +|False +a| + +|dwAudit +|boolean +|False +a|The NetApp Console audits, by default, all API calls. + +NOTE: + +* To stop the NetApp Console from auditing a request, you can set the calling service to `false`. +* `dwAudit` is an optional parameter, the default value is `true`. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "subscriptionId": "string", + "accountId": "string", + "serviceName": "string", + "subscriptionName": "string", + "subscriptionType": "string" +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/post-license-account-subscriptions-.adoc b/dw/post-license-account-subscriptions-.adoc new file mode 100644 index 00000000..09bdd7c1 --- /dev/null +++ b/dw/post-license-account-subscriptions-.adoc @@ -0,0 +1,144 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/post-license-account-subscriptions-.html' +summary: 'Register a subscription' +--- + += Register a subscription + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/license/account/{accountId}/subscriptions/{subscriptionId}`# + + + +Registers a subscription with the NetApp Console and associates it with the account by using the identity and access management service. + +Each subscription can be associated with multiple accounts. + +**Note:** + +This endpoint updates the expiration date based on the date provided in the request. + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|subscriptionId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionType +|string +|True +a| + +|expirationDate +|integer +|True +a| + +|dwAudit +|boolean +|False +a|The NetApp Console audits, by default, all API calls. + +NOTE: + +* To stop the NetApp Console from auditing a request, you can set the calling service to `false`. +* `dwAudit` is an optional parameter, the default value is `true`. + + +|=== + + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/post-license-exchange.adoc b/dw/post-license-exchange.adoc new file mode 100644 index 00000000..a6f8d3c9 --- /dev/null +++ b/dw/post-license-exchange.adoc @@ -0,0 +1,188 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/post-license-exchange.html' +summary: 'Exchange a Cloud Volumes ONTAP license' +--- + += Exchange a Cloud Volumes ONTAP license + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/license/exchange`# + + + +Exchanges an unused Cloud Volume ONTAP license with a data service license. + +**Note:** + +To use this endpoint you must be an account administrator. + +* `accountId`, `targetLicenseType` and `resourceId` are required fields. +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|True +a| + +|targetLicenseType +|string +|True +a| + +|resourceId +|string +|True +a| + +|partnerResourceId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountId": "string", + "targetLicenseType": "string", + "resourceId": "string", + "partnerResourceId": "string" +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + +== Response + +``` +Status: 5xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/post-license-extra-capacity-licenses-cvoid-.adoc b/dw/post-license-extra-capacity-licenses-cvoid-.adoc new file mode 100644 index 00000000..9c567652 --- /dev/null +++ b/dw/post-license-extra-capacity-licenses-cvoid-.adoc @@ -0,0 +1,208 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/post-license-extra-capacity-licenses-cvoid-.html' +summary: 'Associate extra-capacity per-node licenses with a Cloud Volumes ONTAP system' +--- + += Associate extra-capacity per-node licenses with a Cloud Volumes ONTAP system + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/license/extra-capacity-licenses/cvoId/{cvoId}`# + + + +Associates extra-capacity per-node licenses with a Cloud Volumes ONTAP system either by providing NetApp License Files (NLF) in the `licenseFiles` body field or a value for both `serialNumbers` and `nssKeyId` body fields. A Cloud Volumes ONTAP resource is represented by the `cvoId` parameter. If it's a single-node Cloud Volumes ONTAP resource, only one license file or a serial number and a NetApp Support Site key should be provided. For high-availability (HA) Cloud Volumes ONTAP resource, two license files or two serial numbers and a NetApp Support Site key should be provided. + +**Note:** + +* The `cvoId` parameter is required. +* If you use a NetApp Console service token, `accountId` is not a required field. +* If you use a NetApp Console user token, `accountId` is a required field. +* `serialNumbers` is a required field when using this site. In general, you can specify its value as `null`. +* `licenseFiles` is not a required field if values for `serialnumbers` and `nssKeyId` are provided. +* `nssKeyId` is a required field unless you provide a value for the `licenseFiles` body field. In the latter case, `nssKeyId` must be omitted. +* `accountId` is a required field unless you use a service token. +* The `serialNumbers` and `licenseFiles` fields are mutually exclusive - one must have a value but not both. +*Token usage:* Either a NetApp Console user token or service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|cvoId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|["string", "null"] +|False +a| + +|serialNumbers +|array[["string", "null"]] +|False +a| + +|licenseFiles +|array[["string", "null"]] +|False +a| + +|nssKeyId +|["string", "null"] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serialNumbers": [ + [ + "string", + "null" + ] + ], + "licenseFiles": [ + [ + "string", + "null" + ] + ] +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + +== Response + +``` +Status: 5xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/post-license-serial-number-.adoc b/dw/post-license-serial-number-.adoc new file mode 100644 index 00000000..26d0f404 --- /dev/null +++ b/dw/post-license-serial-number-.adoc @@ -0,0 +1,176 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/post-license-serial-number-.html' +summary: 'Associate a license' +--- + += Associate a license + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/license/serial-number/{serialNumber}`# + + + +Associates a license with the NetApp Console either by providing a NetApp License File (NLF) in the license body field or a value for both the `serialNumber` query parameter and `nssKeyId` body field. + +**Note:** + +* If you use a NetApp Console service token, accountId is not a required field. +* If you use a NetApp Console user token, `accountId` is a required field. +* `serialNumber` is a required field when using this site. In general, you can specify its value as `null`. +* If the value of `licenseType` is `EXTRA_CAPACITY`, you must provide the associated resource ID (resourceId). +* `licenseType` is not a required field for data services and capacity based license types. +* `expirationDate` is a required field unless you are registered with the NetApp Support Site. +* `license` is not a required field if values for `serialnumber` and `nssKeyId` are provided. +* `capacity` is a required field unless you are registered with the NetApp Support Site. +* `packageValue` is a required field (used only for internal purposes) unless you are registered with the NetApp Support Site. +* `metadata` is not a required field and is used to add additional data to a license that is not included in other request body fields. +*Token usage:* Either a NetApp Console user token or service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|serialNumber +|["string", "null"] +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|False +a| + +|resourceId +|["string", "null"] +|False +a| + +|licenseType +|string +|False +a| + +|expirationDate +|["integer", "null"] +|False +a| + +|license +|string +|False +a| + +|capacity +|["integer", "null"] +|False +a| + +|metadata +|["array", "null"] +|False +a| + +|nssKeyId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountId": "string", + "licenseType": "string", + "license": "string", + "nssKeyId": "string" +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/post-license-subscriptions-account-.adoc b/dw/post-license-subscriptions-account-.adoc new file mode 100644 index 00000000..216fa2a5 --- /dev/null +++ b/dw/post-license-subscriptions-account-.adoc @@ -0,0 +1,128 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/post-license-subscriptions-account-.html' +summary: 'Associate a subscription' +--- + += Associate a subscription + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/license/subscriptions/account/{accountId}`# + + + +Associate a subscription with an identity and access management service account. + +Each subscription can be associated with multiple accounts. + +{blank} + +*Token usage:* Either a NetApp Console user token or service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|subscriptionId +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "subscriptionId": "string" +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/post-license-subscriptions-subscription-account-.adoc b/dw/post-license-subscriptions-subscription-account-.adoc new file mode 100644 index 00000000..5c61e831 --- /dev/null +++ b/dw/post-license-subscriptions-subscription-account-.adoc @@ -0,0 +1,109 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/post-license-subscriptions-subscription-account-.html' +summary: 'Associate a subscription (deprecated)' +--- + += Associate a subscription (deprecated) + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/license/subscriptions/subscription/{subscriptionId}/account/{accountId}`# + + + +Associate a subscription with an identity and access management service account. + +Each subscription can be associated with multiple accounts. A newer version of this deprecated endpoint is available https://docs.netapp.com/us-en/console-automation/dw/post-license-subscriptions-account-.html[here.] + +{blank} + +*Token usage:* Either a NetApp Console user token or service token. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|subscriptionId +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/put-license-account-subscriptions-preferred.adoc b/dw/put-license-account-subscriptions-preferred.adoc new file mode 100644 index 00000000..789b6aa1 --- /dev/null +++ b/dw/put-license-account-subscriptions-preferred.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/put-license-account-subscriptions-preferred.html' +summary: 'Update the preferred subscription ID for an account' +--- + += Update the preferred subscription ID for an account + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/license/account/{accountId}/subscriptions/preferred`# + + + +Updates the preferred subscription for a specified account ID. + +**Note:** + +* This API authorizes user calls and service calls with a predefined scope only. +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aws +|string +|False +a| + +|gcp +|string +|False +a| + +|azure +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "aws": "string", + "gcp": "string", + "azure": "string" +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|errorCode +|string +|False +a|Error code + + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "errorCode": "string", + "error": "string", + "message": "string" +} +==== + diff --git a/dw/sidebar.yml b/dw/sidebar.yml deleted file mode 100644 index 3ef95043..00000000 --- a/dw/sidebar.yml +++ /dev/null @@ -1,3 +0,0 @@ -section: dw -title: Licenses and subscriptions -generate: dw diff --git a/dw/subscription_overview.adoc b/dw/subscription_overview.adoc new file mode 100644 index 00000000..649e7dcf --- /dev/null +++ b/dw/subscription_overview.adoc @@ -0,0 +1,32 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'dw/subscription_overview.html' +summary: 'Subscription endpoints in the License and subscriptions REST API for the NetApp Console' +--- + += Subscription endpoints in the License and subscriptions REST API for the NetApp Console + + + +The subscription endpoints manage the subscriptions to NetApp Console services for end users. + +The endpoints register a specified subscription with the Console and associate it with the identity and access management service. + +A subscription for the Console services is a collection of the following: + +* Subscription ID (such as 666777, A-S000003969) +* Subscription type (such as Keystone) +* Expiration date (such as 20251109) +* Last modified (such as 2021-11-09 00:00:00) +* Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally + +The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the `subscription` and `subscription_resource` tables based on the subscription ID. + +Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account. + +You can perform the following actions with the subscription endpoints: + +* Read, create, update, or delete a subscription. + + diff --git a/federation/delete-organizations-domains-.adoc b/federation/delete-organizations-domains-.adoc new file mode 100644 index 00000000..24b43c7c --- /dev/null +++ b/federation/delete-organizations-domains-.adoc @@ -0,0 +1,346 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'federation/delete-organizations-domains-.html' +summary: 'Delete a domain' +--- + += Delete a domain + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/organizations/{organization_id}/domains/{domain_id}`# + + + +Deletes the specified domain. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|Identifier for an organization. + + +|domain_id +|string +|path +|True +a|ID of the domain. + +* example: 4336388b-2992-43af-81de-ba9284b7dc36 + + +|=== + +== Response + +``` +Status: 204, Indicates whether the domain was deleted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/federation/delete-organizations-federations-.adoc b/federation/delete-organizations-federations-.adoc new file mode 100644 index 00000000..0bbfd2e7 --- /dev/null +++ b/federation/delete-organizations-federations-.adoc @@ -0,0 +1,346 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'federation/delete-organizations-federations-.html' +summary: 'Delete a federation' +--- + += Delete a federation + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/organizations/{organization_id}/federations/{federation_id}`# + + + +Deletes the specified federation. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|Identifier for an organization. + + +|federation_id +|string +|path +|True +a|ID of the federation. + +* example: 645eae30-ea32-4542-af58-1d9012fed81a + + +|=== + +== Response + +``` +Status: 204, Indicates if the federation was deleted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/federation/domain_overview.adoc b/federation/domain_overview.adoc new file mode 100644 index 00000000..da0f9f1b --- /dev/null +++ b/federation/domain_overview.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'federation/domain_overview.html' +summary: 'Domain endpoints in the Federation REST API for the NetApp Console' +--- + += Domain endpoints in the Federation REST API for the NetApp Console + + + +The domain endpoints enable you to verify ownership of a domain name. All domains that don't match your user's email address must be verified. + +You can perform the following actions using the domain endpoints: + +* List domains +* Create a domain +* Delete a domain +* Retrieve a domain +* Update a domain + + diff --git a/federation/federation-x-doc.yml b/federation/federation-x-doc.yml deleted file mode 100644 index cc38dbec..00000000 --- a/federation/federation-x-doc.yml +++ /dev/null @@ -1,104 +0,0 @@ ---- -overview: Federation REST API for the NetApp Console -permalink: overview.html -paths: - "/organizations/{organization_id}/domains": - get: - x-doc: - title: List domains - category: Domain - filename: get-organizations-domains.html - subcategory: - explorer: false - post: - x-doc: - title: Create a domain - category: Domain - filename: post-organizations-domains.html - subcategory: - explorer: false - "/organizations/{organization_id}/domains/{domain_id}": - delete: - x-doc: - title: Delete a domain - category: Domain - filename: delete-organizations-domains-.html - subcategory: - explorer: false - get: - x-doc: - title: Retrieve a domain - category: Domain - filename: get-organizations-domains-.html - subcategory: - explorer: false - patch: - x-doc: - title: Update a domain - category: Domain - filename: patch-organizations-domains-.html - subcategory: - explorer: false - "/organizations/{organization_id}/federations": - get: - x-doc: - title: List federations - category: Federation - filename: get-organizations-federations.html - subcategory: - explorer: false - post: - x-doc: - title: Create a federation - category: Federation - filename: post-organizations-federations.html - subcategory: - explorer: false - "/organizations/{organization_id}/federations/{federation_id}": - delete: - x-doc: - title: Delete a federation - category: Federation - filename: delete-organizations-federations-.html - subcategory: - explorer: false - get: - x-doc: - title: Retrieve a federation - category: Federation - filename: get-organizations-federations-.html - subcategory: - explorer: false - patch: - x-doc: - title: Update a federation - category: Federation - filename: patch-organizations-federations-.html - subcategory: - explorer: false - "/unmigratedconnections": - get: - x-doc: - title: List unmigrated connections - category: Unmigrated Connection - filename: get-unmigratedconnections.html - subcategory: - explorer: false - "/unmigratedconnections/{connection_id}": - patch: - x-doc: - title: Import a connection - category: Unmigrated Connection - filename: patch-unmigratedconnections-.html - subcategory: - explorer: false -categories: -- id: domain - title: Domain endpoints in the Federation REST API for the NetApp Console - permalink: domain_overview.html -- id: federation - title: Federation endpoints in the Federation REST API for the NetApp Console - permalink: federation_overview.html -- id: unmigrated connection - title: Unmigrated connection endpoints in the Federation REST API for the NetApp Console - permalink: unmigrated_connection_overview.html diff --git a/federation/federation.yaml b/federation/federation.yaml deleted file mode 100644 index ae8b56bc..00000000 --- a/federation/federation.yaml +++ /dev/null @@ -1,2794 +0,0 @@ -components: - parameters: - continue: - description: |- - Indicates the token to resume from when listing a collection. - - - URL examples: "continue=[Continue Token from Collection Metadata]" - - - OpenAPI examples: "[Continue Token from Collection Metadata]" - in: query - name: continue - schema: - $ref: '#/components/schemas/query_continue' - count: - description: |- - Indicates if the total number of resources should be returned in the response object. - - - URL examples: "count=true" - - - OpenAPI examples: "true" - in: query - name: count - schema: - $ref: '#/components/schemas/query_count' - filter: - description: |- - Specifies which fields should be matched in order to return a resource when listing a collection. - - - Supported operators: - * eq - Equality - * lt/gt - Less than/greater than - * lte/gte - Less than or equal to/greater than or equal to - - - URL example: "filter=field%20eq%20%27value%27" - - - OpenAPI examples: "field eq 'value'" - in: query - name: filter - schema: - $ref: '#/components/schemas/query_filter' - include: - description: |- - Specifies which fields should be returned when listing a collection. - - - URL examples: "include=id", "include=id,name" - - - OpenAPI examples: "id" - in: query - name: include - schema: - $ref: '#/components/schemas/query_include' - limit: - description: |- - Specifies the maximum number of resources to return when listing a collection. - - - URL examples: "limit=2" - - - OpenAPI examples: "2" - in: query - name: limit - schema: - $ref: '#/components/schemas/query_limit' - order_by: - description: |- - Indicates the sort order of resources when listing a collection. - - - URL examples: "orderBy=name", "orderBy=name%20desc" - - - OpenAPI examples: "name desc" - in: query - name: orderBy - schema: - $ref: '#/components/schemas/query_order_by' - organization_id: - description: Identifier for an organization. - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - skip: - description: |- - Specifies the number of resources to skip when listing a collection. - - - URL examples: "skip=1" - - - OpenAPI examples: "1" - in: query - name: skip - schema: - $ref: '#/components/schemas/query_skip' - responses: - 400BadRequest: - content: - application/vnd.netapp.bxp.problem+json: - example: - detail: The supplied query parameters are invalid. - status: "400" - title: Invalid query parameters - type: https://bluexp.netapp.io/problems/1 - schema: - $ref: '#/components/schemas/type_bxp_problem_detail' - description: Bad Request - 401Unauthorized: - content: - application/vnd.netapp.bxp.problem+json: - example: - detail: The request is missing the required bearer token. - status: "401" - title: Missing bearer token - type: https://bluexp.netapp.io/problems/1 - schema: - $ref: '#/components/schemas/type_bxp_problem_detail' - description: Unauthorized - 403Forbidden: - content: - application/vnd.netapp.bxp.problem+json: - example: - detail: The requested operation isn't permitted. - status: "403" - title: Operation not permitted - type: https://bluexp.netapp.io/problems/11 - schema: - $ref: '#/components/schemas/type_bxp_problem_detail' - description: Forbidden - 404NotFound: - content: - application/vnd.netapp.bxp.problem+json: - example: - detail: The collection specified in the request URI wasn't found. - status: "404" - title: Collection not found - type: https://bluexp.netapp.io/problems/2 - schema: - $ref: '#/components/schemas/type_bxp_problem_detail' - description: Not Found - 409Conflict: - content: - application/vnd.netapp.bxp.problem+json: - example: - detail: The request body JSON contains a field that conflicts with an idempotent value. - status: "409" - title: JSON resource conflict - type: https://bluexp.netapp.io/problems/10 - schema: - $ref: '#/components/schemas/type_bxp_problem_detail' - description: Conflict - schemas: - connection_1.0_get_response_body: - properties: - domains: - description: Array of email domain names that are associated with the connection. - example: - - example.com - - example2.com - items: - type: string - minItems: 1 - type: array - uniqueItems: true - id: - description: The ID of the Auth0 connection. - example: con_jxQFVfPHKSdiwoxs - type: string - name: - description: The name of the Auth0 connection. - example: fed-example-com-waad - type: string - type: - description: Media type of the resource. - enum: - - application/vnd.netapp.bxp.connection - example: application/vnd.netapp.bxp.connection - type: string - version: - description: Version of the resource. - enum: - - "1.0" - example: "1.0" - type: string - type: object - connection_1.0_list_response_body: - properties: - count: - description: Total number of resources in the collection that match the query. - example: 1 - format: int64 - minimum: 0 - type: integer - items: - items: - $ref: '#/components/schemas/connection_1.0_get_response_body' - type: array - uniqueItems: true - required: - - items - type: object - connection_1.0_patch_request_body: - additionalProperties: false - properties: - stateDesired: - description: |- - The desired state of the connection. Defined values are: - * "SYNCED" - The connection is synced with Auth0. - enum: - - SYNCED - example: SYNCED - type: string - type: - description: Media type of the resource. - enum: - - application/vnd.netapp.bxp.connection - example: application/vnd.netapp.bxp.connection - type: string - version: - description: Version of the resource. - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - stateDesired - type: object - connection_1.0_patch_response_body: - properties: - domains: - description: Array of email domain names that are associated with the connection. - example: - - example.com - - example2.com - items: - type: string - minItems: 1 - type: array - uniqueItems: true - id: - description: The ID of the Auth0 connection. - example: con_jxQFVfPHKSdiwoxs - type: string - name: - description: The name of the Auth0 connection. - example: fed-example-com-waad - type: string - state: - description: |- - The state of the connection. Defined values are: - * "SYNCED" - The connection is synced with Auth0. - enum: - - SYNCED - example: SYNCED - type: string - type: - description: Media type of the resource. - enum: - - application/vnd.netapp.bxp.connection - example: application/vnd.netapp.bxp.connection - type: string - version: - description: Version of the resource. - enum: - - "1.0" - example: "1.0" - type: string - type: object - domain_1.0_get_response_body: - properties: - code: - description: The unique verification code for this domain. - example: Console133ad2ea-99de-4ada-9be4-876d4d53923e - type: string - federations: - description: The list of federations that use this domain. - example: - - id: 4336388b-2992-43af-81de-ba9284b7dc36 - name: Example Co. AD FS - - id: 645eae30-ea32-4542-af58-1d9012fed81a - name: Example Co. SAML - items: - properties: - id: - description: Globally unique identifier of the resource conforming to the UUIDv4 schema. - example: 4336388b-2992-43af-81de-ba9284b7dc36 - format: uuid - type: string - name: - description: The name of the federation. - example: Example Co. - type: string - type: object - type: array - uniqueItems: true - id: - description: Globally unique identifier of the resource conforming to the UUIDv4 schema. - example: 4336388b-2992-43af-81de-ba9284b7dc36 - format: uuid - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: The domain name. - example: example.com - type: string - organizationId: - description: Identifier for an organization. - example: 9b0ee210-70a0-4158-b025-0decde66e4de - format: uuid - type: string - resourceId: - description: Identifier for the resource. - example: 862b6f03-58ac-479b-9ca5-5cb4429d8996 - format: uuid - type: string - state: - description: |- - The state of the domain. - Defined values are: - * "UNVERIFIED" - Ownership of the domain has not been verified. - * "VERIFIED" - Ownership of the domain has been verified using a DNS TXT record with the verification code. - enum: - - UNVERIFIED - - VERIFIED - example: VERIFIED - type: string - type: - description: Media type of the resource. - enum: - - application/vnd.netapp.bxp.domain - example: application/vnd.netapp.bxp.domain - type: string - verificationTimestamp: - description: The date that the domain was verified. - example: "2024-11-18T20:58:16.305662Z" - format: date-time - type: string - version: - description: Version of the resource. - enum: - - "1.0" - example: "1.0" - type: string - type: object - domain_1.0_list_response_body: - properties: - count: - description: Total number of resources in the collection that match the query. - example: 1 - format: int64 - minimum: 0 - type: integer - items: - items: - $ref: '#/components/schemas/domain_1.0_get_response_body' - type: array - uniqueItems: true - required: - - items - type: object - domain_1.0_patch_request_body: - additionalProperties: false - properties: - stateDesired: - description: The desired state of the domain. - enum: - - VERIFIED - example: VERIFIED - type: string - type: - description: Media type of the resource. - enum: - - application/vnd.netapp.bxp.domain - example: application/vnd.netapp.bxp.domain - type: string - version: - description: Version of the resource. - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - stateDesired - type: object - domain_1.0_post_request_body: - additionalProperties: false - properties: - name: - description: The domain name. - example: example.com - type: string - type: - description: Media type of the resource. - enum: - - application/vnd.netapp.bxp.domain - example: application/vnd.netapp.bxp.domain - type: string - version: - description: Version of the resource. - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - name - type: object - federation_1.0_adfs_request_options: - description: "Active Directory Federation Services (AD FS) configuration options when `providerType=ADFS`. \nEither `metadataUrl` or `metadataFile` must be provided." - properties: - metadataFile: - description: JSON escaped contents of the Federation metadata XML file. - example: |- - - All previously configured domains must be included in the request body when updating the `domains` \nfield or they will be removed. Previously configured domains do not need to be in a `VERIFIED` state.\n
\nIf a domain matches the user's email address or is an Entra ID `*.onmicrosoft.com` tenant domain, then it\ndoes not need to be in a `VERIFIED` state. All other domains must be added to the domains\ncollection and in a `VERIFIED` state." - example: - - example.com - - example2.com - items: - type: string - minItems: 1 - type: array - uniqueItems: true - entraIdOptions: - $ref: '#/components/schemas/federation_1.0_entraid_patch_request_options' - expirationNotificationPeriod: - description: |- - The time period when expiration notifications are generated. Defined values are: - * "P7D" - Notifications are sent daily 7 days before expiration. - * "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. - enum: - - P7D - - P30D - example: P30D - type: string - expirationTimestamp: - description: "The date that the credentials expire. This is only applicable when `providerType=ENTRAID`. When a \ncertificate is provided for other provider types, the value is set to the certificate's expiration timestamp." - example: "2024-11-18T20:58:16.305662Z" - format: date-time - type: string - name: - description: The name of the federation. - example: Example Co. - type: string - pingFederateOptions: - $ref: '#/components/schemas/federation_1.0_pingfederate_patch_request_options' - providerType: - description: |- - The type of the identity provider. Defined values are: - * "ADFS" - Active Directory Federation Services - * "ENTRAID" - Microsoft Entra ID (formerly Azure Active Directory) - * "PINGFEDERATE" - PingFederate - * "SAML" - Security Assertion Markup Language 2.0 - enum: - - ADFS - - ENTRAID - - PINGFEDERATE - - SAML - example: ENTRAID - type: string - samlOptions: - $ref: '#/components/schemas/federation_1.0_saml_patch_request_options' - stateDesired: - description: |- - The desired state of the federation. Defined values are: - * "DRAFT" - The federation is partially configured. - * "CREATED" - The federation is configured but not tested. - * "TESTED" - The federation has been successfully tested. - * "ENABLED" - The federation is enabled. - * "DISABLED" - The federation is disabled. - enum: - - DRAFT - - CREATED - - TESTED - - ENABLED - - DISABLED - example: ENABLED - type: string - type: - description: Media type of the resource. - enum: - - application/vnd.netapp.bxp.federation - example: application/vnd.netapp.bxp.federation - type: string - version: - description: Version of the resource. - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - federation_1.0_pingfederate_patch_request_options: - description: PingFederate configuration options when `providerType=PINGFEDERATE`. - properties: - serverUrl: - description: PingFederate server URL. - example: https://example.com/saml/signin - type: string - signingCertificate: - description: X.509 Signing certificate in PEM or CER format converted to a string with escaped new-line characters (`\n`). - example: |- - -----BEGIN CERTIFICATE----- - MIIC+jCCAeKgAwIBAgIJM... - type: string - type: object - federation_1.0_pingfederate_post_request_options: - description: PingFederate configuration options when `providerType=PINGFEDERATE`. - properties: - serverUrl: - description: PingFederate server URL. - example: https://example.com/saml/signin - type: string - signingCertificate: - description: X.509 signing certificate in PEM or CER format converted to a string with escaped new-line characters (`\n`). - example: |- - -----BEGIN CERTIFICATE----- - MIIC+jCCAeKgAwIBAgIJM... - type: string - required: - - serverUrl - - signingCertificate - type: object - federation_1.0_pingfederate_response_options: - description: PingFederate configuration options when `providerType=PINGFEDERATE`. - properties: - serverUrl: - description: PingFederate server URL. - example: https://example.com/saml/signin - type: string - signingCertificateFingerprint: - description: The SHA-1 fingerprint of the X.509 Signing certificate. - example: 33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8 - type: string - type: object - federation_1.0_post_request_body: - additionalProperties: false - properties: - adfsOptions: - $ref: '#/components/schemas/federation_1.0_adfs_request_options' - domains: - description: "Array of email domain names that are associated with the federation.\n
\nIf a domain matches the user's email address or is an Entra ID `*.onmicrosoft.com` tenant domain, then it \ndoes not need to be in a `VERIFIED` state. All other domains must be added to the domains \ncollection and in a `VERIFIED` state." - example: - - example.com - - example2.com - items: - type: string - minItems: 1 - type: array - uniqueItems: true - entraIdOptions: - $ref: '#/components/schemas/federation_1.0_entraid_post_request_options' - expirationNotificationPeriod: - description: |- - The time period when expiration notifications are generated. Defined values are: - * "P7D" - Notifications are sent daily 7 days before expiration. - * "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. - enum: - - P7D - - P30D - example: P30D - type: string - expirationTimestamp: - description: "The date that the credentials expire. This is only applicable when `providerType=ENTRAID`. When a \ncertificate is provided for other provider types, the value is set to the certificate's expiration timestamp." - example: "2024-11-18T20:58:16.305662Z" - format: date-time - type: string - name: - description: The name of the federation. - example: Example Co. - type: string - pingFederateOptions: - $ref: '#/components/schemas/federation_1.0_pingfederate_post_request_options' - providerType: - description: |- - The type of the identity provider. Defined values are: - * "ADFS" - Active Directory Federation Services - * "ENTRAID" - Microsoft Entra ID (formerly Azure Active Directory) - * "PINGFEDERATE" - PingFederate - * "SAML" - Security Assertion Markup Language 2.0 - enum: - - ADFS - - ENTRAID - - PINGFEDERATE - - SAML - example: ENTRAID - type: string - samlOptions: - $ref: '#/components/schemas/federation_1.0_saml_post_request_options' - state: - description: |- - The state of the federation. Defined values are: - * "DRAFT" - The federation is partially configured. - * "CREATED" - The federation is configured but not tested. - enum: - - DRAFT - - CREATED - example: CREATED - type: string - type: - description: Media type of the resource. - enum: - - application/vnd.netapp.bxp.federation - example: application/vnd.netapp.bxp.federation - type: string - version: - description: Version of the resource. - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - name - - state - - domains - type: object - federation_1.0_saml_patch_request_options: - description: SAML configuration options when `providerType=SAML`. - properties: - signInUrl: - description: SAML single login URL. - example: https://example.com/saml/signin - type: string - signOutUrl: - description: SAML single logout URL. - example: https://example.com/saml/signout - type: string - signingCertificate: - description: X.509 signing certificate in PEM or CER format converted to a string with escaped new-line characters (`\n`). - example: |- - -----BEGIN CERTIFICATE----- - MIIC+jCCAeKgAwIBAgIJM... - type: string - type: object - federation_1.0_saml_post_request_options: - description: SAML configuration options when `providerType=SAML`. - properties: - signInUrl: - description: SAML single login URL. - example: https://example.com/saml/signin - type: string - signOutUrl: - description: SAML single logout URL. - example: https://example.com/saml/signout - type: string - signingCertificate: - description: X.509 signing certificate in PEM or CER format converted to a string with escaped new-line characters (`\n`). - example: |- - -----BEGIN CERTIFICATE----- - MIIC+jCCAeKgAwIBAgIJM... - type: string - required: - - signInUrl - - signingCertificate - type: object - federation_1.0_saml_response_options: - description: SAML configuration options when `providerType=SAML`. - properties: - signInUrl: - description: SAML single login URL. - example: https://example.com/saml/signin - type: string - signOutUrl: - description: SAML single logout URL. - example: https://example.com/saml/signout - type: string - signingCertificateFingerprint: - description: The SHA-1 fingerprint of the X.509 Signing certificate. - example: 33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8 - type: string - type: object - query_continue: - description: Format of the continue query parameter. - pattern: ^([A-Za-z0-9+/]{4})*(([A-Za-z0-9+/]{2})==|([A-Za-z0-9+/]{3})=)?$ - type: string - x-common: true - query_count: - description: Format of the count query parameter. - pattern: ^true$ - type: string - x-common: true - query_filter: - description: Format of the filter query parameter. - pattern: ^(([0-9a-zA-Z]+(\[\*\])?)((\.[0-9a-zA-Z]+(\[\*\])?)+)? (eq|lt|gt|lte|gte|in) '([0-9a-zA-Z.,-_:@ {}\"])+')(,(\1))*$ - type: string - x-common: true - query_include: - description: Format of the include query parameter. - pattern: ^([0-9a-zA-Z]+)(,[0-9a-zA-Z]+)*$ - type: string - x-common: true - query_limit: - description: Format of the limit query parameter. - pattern: ^([1-9][0-9]*)$ - type: string - x-common: true - query_order_by: - description: Format of the order_by query parameter. - pattern: ^(([0-9a-zA-Z]+)( desc)?)$ - type: string - x-common: true - query_skip: - description: Format of the skip query parameter. - pattern: ^([1-9][0-9]*)$ - type: string - x-common: true - type_bxp_api_relative_uri: - description: String describing a relative URI. - pattern: ^(\/([-0-9a-zA-Z])+)+$ - type: string - x-common: true - type_bxp_identifier: - description: |- - JSON string containing a Resource ID. - Defined values are: * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - x-common: true - type_bxp_invalid_reason: - properties: - details: - description: | - The description of the invalid reasons. The possible values are: - 1. CERT_NOT_YET_VALID: The certificate is not yet valid. - 2. CERT_HOST_MISMATCH: The host name does not match the CN or subject alt name. - 3. CERT_WEAK_ENCRYPTION_KEY_SIZE: The certificate has weak encryption key size. - 4. CERT_CHAIN_BROKEN: The certificate chain is broken. - 5. CERT_INVALID_SIGNATURE: The certificate has an invalid signature. - 6. OTHER: Any other invalid reason. - example: Host name is not matching with CN or subject alt name - type: string - error: - description: The error enum value for the invalid certificate. - enum: - - CERT_NOT_YET_VALID - - CERT_HOST_MISMATCH - - CERT_WEAK_ENCRYPTION_KEY_SIZE - - CERT_CHAIN_BROKEN - - CERT_INVALID_SIGNATURE - - OTHER - example: CERT_HOST_MISMATCH - type: string - type: object - x-common: true - type_bxp_label: - description: Name/value pair. - example: - name: secure - value: "true" - properties: - name: - description: Name of the label. - type: string - value: - description: Value of the label. - type: string - required: - - name - - value - type: object - x-common: true - type_bxp_labels: - description: JSON Array of Name/value pairs. - example: - - name: secure - value: "true" - items: - $ref: '#/components/schemas/type_bxp_label' - type: array - uniqueItems: true - x-common: true - type_bxp_link: - description: Link relationship - properties: - hints: - properties: - accept-post: - description: Provides details about which media types are accepted when creating a resource. - type: object - accept-put: - description: Indicates details about what media types are accepted when updating a resource. - type: object - allow: - description: |- - An array of methods that can be used to interact with the link target. - - Defined values for collections: - - "POST" - Indicates if new resources can be created in the collection. - Defined values for resources: - - "PUT" - Indicates if the resource can be modified - "DELETE" - Indicates if the resource can be deleted - items: - enum: - - POST - - GET - - PUT - - DELETE - type: string - type: array - permissions: - description: List of the permissions required to use the link. - items: - pattern: ^([a-z]([a-zA-Z])*)(-[a-z]([a-zA-Z])*){1,2}$ - type: string - type: array - status: - description: |- - Indicates if the target of the link is deprecated. - - Defined values are: - - "deprecated" - enum: - - deprecated - type: string - type: object - href: - $ref: '#/components/schemas/type_bxp_api_relative_uri' - rel: - description: The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. - enum: - - self - - canonical - - collection - - up - - related - - service-doc - - service-desc - type: string - targetSchema: - description: |- - Link to a JSON schema that can be used to validate the target of the link (response body). - - The preferred format is a $ref link to an external schema. - - This field is optional and should only be included when there is a known schema for the target of the href. - - See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. - type: object - title: - description: |- - Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). - - Minimum length: 0 - Maximum length: 1023 - maxLength: 1023 - minLength: 1 - type: string - type: - description: |- - The media type of the target of the href. - - This field is optional and should be included when there is a known media type for the target of the href. - - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. - pattern: ^((application\/vnd\.netapp(\.(([a-z])([a-zA-Z0-9]){0,30})){1,3})(-v(([0-9]){1,3}))?)$ - type: string - required: - - rel - - href - type: object - x-common: true - type_bxp_links: - description: Array of link relationships associated with the resource or ID. - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - x-common: true - type_bxp_metadata: - description: Metadata associated with the resource. - properties: - createdBy: - description: UUID of the user who created the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - creationTimestamp: - description: Resource creation date. - example: "2022-10-06T20:58:16.305662Z" - format: date-time - type: string - labels: - description: Array of name/value pairs representing additional information for the resource. - items: - $ref: '#/components/schemas/type_bxp_label' - type: array - uniqueItems: true - modificationTimestamp: - description: Resource modification date. - example: "2022-10-06T20:58:16.305662Z" - format: date-time - type: string - modifiedBy: - description: UUID of the user who modified the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - type: object - x-common: true - type_bxp_metadata_list: - description: Metadata associated with a list of resources. - properties: - count: - type: number - createdBy: - description: UUID of the user who created the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - creationTimestamp: - description: Resource creation date. - example: "2022-10-06T20:58:16.305662Z" - format: date-time - type: string - labels: - description: Array of name/value pairs representing additional information for the resource. - items: - $ref: '#/components/schemas/type_bxp_label' - type: array - uniqueItems: true - modificationTimestamp: - description: Resource modification date. - example: "2022-10-06T20:58:16.305662Z" - format: date-time - type: string - modifiedBy: - description: UUID of the user who modified the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - type: object - x-common: true - type_bxp_metadata_update: - description: Metadata associated to an updated resource. - properties: - createdBy: - description: UUID of the user who created the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - creationTimestamp: - description: Resource creation date. - example: "2022-10-06T20:58:16.305662Z" - format: date-time - type: string - labels: - description: Array of name/value pairs representing additional information for the resource. - items: - $ref: '#/components/schemas/type_bxp_label' - type: array - uniqueItems: true - modificationTimestamp: - description: Resource modification date. - example: "2022-10-06T20:58:16.305662Z" - format: date-time - type: string - modifiedBy: - description: UUID of the user who modified the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - type: object - x-common: true - type_bxp_problem_detail: - additionalProperties: true - description: Represents a problem detail returned by an API in case of error. - properties: - correlationId: - description: Internal UUID representing the request or trace ID related. - format: uuid - type: string - detail: - description: Details about the problem. - enum: - - The resource specified in the request URI wasn't found. - type: string - invalidParams: - description: List of invalid parameters. - items: - properties: - name: - description: Name of the invalid parameter. - type: string - reason: - description: Reason why the parameter is invalid. - type: string - required: - - name - - reason - type: object - minItems: 1 - type: array - uniqueItems: true - status: - description: HTTP error code related to the problem. - enum: - - "404" - type: string - title: - description: Title description of the problem. - enum: - - Resource not found - type: string - type: - description: Content-type of the object. - enum: - - https://bluexp.netapp.io/problems/1 - type: string - required: - - type - - title - - description - - status - type: object - x-common: true - type_bxp_state_details: - description: Array of all possible states and their detailed description. - items: - properties: - detail: - description: Detailed description for the state. - maxLength: 511 - minLength: 1 - type: string - title: - description: Name of the state. - maxLength: 40 - minLength: 1 - type: string - type: - description: Represents a state detail. - type: string - required: - - type - - title - - detail - type: object - type: array - uniqueItems: true - x-common: true - type_bxp_state_transitions: - description: Array representing the state machine associated with the object. - items: - properties: - from: - type: string - to: - items: - type: string - type: array - uniqueItems: true - required: - - from - - to - type: object - type: array - uniqueItems: true - x-common: true - type_dns_1123: - description: Represents a Domain Name as defined in RFC 1123. - maxLength: 63 - minLength: 1 - pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ - type: string - x-common: true - type_json: - description: JSON Representation. - type: object - x-common: true - type_json_schema: - description: Represents a JSON Schema. - properties: - $schema: - enum: - - http://json-schema.org/draft-07/schema# - type: string - additionalProperties: - enum: - - false - type: boolean - properties: - type: object - required: - items: - type: string - type: array - uniqueItems: true - type: - enum: - - object - type: string - required: - - $schema - - type - - properties - - additionalProperties - - required - type: object - x-common: true - type_swver: - description: Represents a software version in the format Major.Minor.Patch . - pattern: ^([0-9]+)\.([0-9]+)\.([0-9]+)(\-[a-zA-Z0-9-]+)*$ - type: string - x-common: true - unmigratedconnection_1.0_adfs_response_options: - description: Active Directory Federation Services (AD FS) configuration options when `providerType=ADFS`. - properties: - metadataFileProvided: - description: Indicates whether the connection uses the Federation metadata XML file or the server URL. - example: true - type: boolean - metadataUrl: - description: AD FS server URL for the Federation metadata XML file. - example: https://example.com/FederationMetadata/2007-06/FederationMetadata.xml - type: string - signInUrl: - description: AD FS single login URL extracted from the Federation metadata XML file. - example: https://example.com/adfs/ls/ - type: string - type: object - unmigratedconnection_1.0_entraid_response_options: - description: Microsoft Entra ID (formerly Azure Active Directory) configuration options when `providerType=ENTRAID`. - properties: - clientId: - description: Entra ID client ID. - example: 94e2a45c-64e6-48d1-a31e-1eee0ded5c2a - type: string - tenantDomain: - description: Entra ID domain. - example: example.onmicrosoft.com - type: string - type: object - unmigratedconnection_1.0_get_response_body: - properties: - adfsOptions: - $ref: '#/components/schemas/unmigratedconnection_1.0_adfs_response_options' - creatorUsers: - description: Array of Auth0 user IDs that can manage the connection in Cloud Central. - example: - - auth0|680f8f5e279840afb355ab00 - - auth0|680f8f5e279840afb355ab11 - items: - type: string - minItems: 1 - type: array - uniqueItems: true - domains: - description: Array of domain names that are associated with the connection. - example: - - example.com - - example2.com - items: - type: string - minItems: 1 - type: array - uniqueItems: true - emailDomain: - description: The primary email domain associated with the connection. - example: example.com - type: string - entraIdOptions: - $ref: '#/components/schemas/unmigratedconnection_1.0_entraid_response_options' - id: - description: The ID of the connection in Auth0. - example: con_jxQFVfPHKSdiwoxs - type: string - name: - description: The name of the connection in Auth0. - example: fed-example-com-waad - type: string - pingFederateOptions: - $ref: '#/components/schemas/unmigratedconnection_1.0_pingfederate_response_options' - providerType: - description: |- - The type of the identity provider. Defined values are: - * "ADFS" - Active Directory Federation Services - * "ENTRAID" - Microsoft Entra ID (formerly Azure Active Directory) - * "PINGFEDERATE" - PingFederate - * "SAML" - Security Assertion Markup Language 2.0 - enum: - - ADFS - - ENTRAID - - PINGFEDERATE - - SAML - example: ENTRAID - type: string - samlOptions: - $ref: '#/components/schemas/unmigratedconnection_1.0_saml_response_options' - type: - description: Media type of the resource. - enum: - - application/vnd.netapp.bxp.unmigratedconnection - example: application/vnd.netapp.bxp.unmigratedconnection - type: string - version: - description: Version of the resource. - enum: - - "1.0" - example: "1.0" - type: string - type: object - unmigratedconnection_1.0_list_response_body: - properties: - items: - items: - $ref: '#/components/schemas/unmigratedconnection_1.0_get_response_body' - type: array - uniqueItems: true - required: - - items - type: object - unmigratedconnection_1.0_patch_request_body: - additionalProperties: false - properties: - expirationNotificationPeriod: - description: |- - The time period when expiration notifications are generated. Defined values are: - * "P7D" - Notifications are sent daily 7 days before expiration. - * "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. - enum: - - P7D - - P30D - example: P30D - type: string - expirationTimestamp: - description: "The date that the credentials expire. This is only applicable when `providerType=ENTRAID`. When a \ncertificate is provided for other provider types, the value is set to the certificate's expiration timestamp." - example: "2024-11-18T20:58:16.305662Z" - format: date-time - type: string - name: - description: The name of the federation. - example: Example Co. - type: string - organizationId: - description: Identifier for an organization. - example: 9b0ee210-70a0-4158-b025-0decde66e4de - format: uuid - type: string - stateDesired: - description: The desired state of the connection. - enum: - - IMPORTED - example: IMPORTED - type: string - type: - description: Media type of the resource. - enum: - - application/vnd.netapp.bxp.unmigratedconnection - example: application/vnd.netapp.bxp.unmigratedconnection - type: string - version: - description: Version of the resource. - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - name - - organizationId - - stateDesired - type: object - unmigratedconnection_1.0_patch_response_body: - properties: - federationId: - description: Identifier of the federation that was created. - example: 4336388b-2992-43af-81de-ba9284b7dc36 - format: uuid - type: string - id: - description: The ID of the connection in Auth0. - example: con_jxQFVfPHKSdiwoxs - type: string - organizationId: - description: Identifier for an organization. - example: 9b0ee210-70a0-4158-b025-0decde66e4de - format: uuid - type: string - state: - description: The current state of the connection. - enum: - - IMPORTED - example: IMPORTED - type: string - type: - description: Media type of the resource. - enum: - - application/vnd.netapp.bxp.unmigratedconnection - example: application/vnd.netapp.bxp.unmigratedconnection - type: string - version: - description: Version of the resource. - enum: - - "1.0" - example: "1.0" - type: string - type: object - unmigratedconnection_1.0_pingfederate_response_options: - description: PingFederate configuration options when `providerType=PINGFEDERATE`. - properties: - serverUrl: - description: PingFederate server URL. - example: https://example.com/saml/signin - type: string - type: object - unmigratedconnection_1.0_saml_response_options: - description: SAML configuration options when `providerType=SAML`. - properties: - signInUrl: - description: SAML single login URL. - example: https://example.com/saml/signin - type: string - type: object - securitySchemes: - bxp_bearer_auth: - scheme: bearer - type: http -info: - description: "Federation through the NetApp Console manages identity federation between the Console and customer identity providers. \nIdentity federation enables single sign-on with the Console so that your corporate users can log in using their credentials. \n\nThe federation endpoints also allow your users to configure their notification settings so that they're notified \nbefore their identity provider credentials or certificates expire.\n\nThe following components are defined within federation:\n
    \n
  • domain
    • \n
  • federation
    • \n
  • unmigrated connection
    • \n
\n\nTo configure a federation, all domains that don't match your user's email address must be verified. To verify a domain, you first need to add the domain to the Console in order to receive a unique code. You use the code to create a DNS TXT record for the domain, and then you verify the domain in the Console.\n\nFederation provided through the Console replaces the functionality provided through Cloud Central Federation Setup. Federations \nconfigured through Cloud Central are \"unmigrated connections\". The unmigrated connection endpoints enable you to \nnon-disruptively import a connection into an organization and manage it with federation in the Console. \nAfter you import a connection, it cannot be managed through Cloud Central Federation Setup.\n\n**Note**: Before using the API reference documentation, review the \n[Get started](https://docs.netapp.com/us-en/bluexp-automation/platform/overview.html) section for the \nConsole APIs. For more information about the security tokens and identifiers you'll need when using the API, review the \n[Common workflows and tasks](https://docs.netapp.com/us-en/bluexp-automation/platform/get_identifiers.html) section.\n\n---\n\n## REST implementation\n\n### HTTP methods\n\n| Method | Description |\n|--------|---------------------------------------------|\n| POST | Create an object instance |\n| GET | Retrieve an object instance or collection |\n| PATCH | Update an existing object |\n| DELETE | Remove an existing object |\n\n### Request headers\n\n| Request Header | Description |\n|----------------|--------------------------------------------------------------------------------------------|\n| Authorization | This header contains a bearer token used to access the Console server. |\n| Content-Type | This representation header is used to indicate the original media type of the resource. |\n| Accept | The server automatically returns content in JSON format if Accept header is not specified. |\n\n### Query parameters\n\nYou can use query parameters with endpoints in the following components:\n\n| Component | Query Parameter |\n|-------------|------------------------------------------------------|\n| Domain | include, count, filter, limit, skip, orderBy |\n| Federation | include, count, filter, limit, skip, orderBy |\n\n### Response headers\n\nThis API uses the standard HTTP response headers common with all Console APIs. See \n[REST implementation](https://docs.netapp.com/us-en/bluexp-automation/platform/http_details.html) for more information.\n\n### HTTP status codes\n\n| HTTP Status Code | Description |\n|------------------|-------------------------------------------------------------------------------------------------------------------|\n| 200 | OK: Returned for successful operation completion |\n| 202 | Accepted: The request was accepted and is currently in process. |\n| 204 | The operation was completed successfully and the server did not send a response message. |\n| 400 | Bad Request: Returned if the input is malformed and could not be parsed |\n| 401 | Unauthorized: Returned if user authentication failed or the token has expired |\n| 403 | Forbidden: Returned for authorization errors depending on the resource and token. |\n| 409 | Conflict: The operation failed because another operation is already in progress. |\n| 5xx | An unexpected error occurred within the Console server which has prevented it from fulfilling the request. |\n\n## Error handling\n\nThere are three processes involved with error handling and processing:\n* The error is logged for supportability\n* The error is also returned to the caller for any specific handling\n* The database connection is rolled back" - license: - name: NetApp Console License - termsOfService: https://www.netapp.com/media/10784-cloud-data-services-terms.pdf - title: (documentation) Federation API - version: "1.0" -openapi: 3.0.3 -paths: - /organizations/{organization_id}/domains: - get: - description: Lists all domains. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - responses: - "200": - content: - application/vnd.netapp.bxp.domains+json: - schema: - $ref: '#/components/schemas/domain_1.0_list_response_body' - description: List of domains. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - summary: List domains. - tags: - - Domain - x-permission: bxp:domain-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - $ref: '#/components/parameters/organization_id' - post: - description: Creates a new domain. - requestBody: - content: - application/vnd.netapp.bxp.domain+json: - schema: - $ref: '#/components/schemas/domain_1.0_post_request_body' - description: Create a new domain. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.domain+json: - schema: - $ref: '#/components/schemas/domain_1.0_get_response_body' - description: Returns the newly created domain in the JSON response body. - headers: - Location: - description: Location of the newly created resource. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new domain. - tags: - - Domain - x-permission: bxp:domain-create - x-persistence: true - x-scope: documentation,private,public - /organizations/{organization_id}/domains/{domain_id}: - delete: - description: Deletes the specified domain. - responses: - "204": - description: Indicates whether the domain was deleted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Delete a domain. - tags: - - Domain - x-permission: bxp:domain-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves the specified domain. - parameters: - - $ref: '#/components/parameters/include' - responses: - "200": - content: - application/vnd.netapp.bxp.domain+json: - schema: - $ref: '#/components/schemas/domain_1.0_get_response_body' - description: Returns the stored domain in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a domain. - tags: - - Domain - x-permission: bxp:domain-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - $ref: '#/components/parameters/organization_id' - - description: ID of the domain. - example: 4336388b-2992-43af-81de-ba9284b7dc36 - in: path - name: domain_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates the specified domain. - requestBody: - content: - application/vnd.netapp.bxp.domain+json: - schema: - $ref: '#/components/schemas/domain_1.0_patch_request_body' - description: Replaces the specified attributes in the request body with the values provided. - required: true - responses: - "200": - content: - application/vnd.netapp.bxp.domain+json: - schema: - $ref: '#/components/schemas/domain_1.0_get_response_body' - description: Returns the updated domain in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Update a domain. - tags: - - Domain - x-permission: bxp:domain-modify - x-persistence: true - x-scope: documentation,private,public - /organizations/{organization_id}/federations: - get: - description: Lists all federations. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - responses: - "200": - content: - application/vnd.netapp.bxp.federations+json: - example: - count: 5 - items: - - adfsOptions: - metadataUrl: https://example.com/FederationMetadata/2007-06/FederationMetadata.xml - auth0Id: con_jxQFVfPHKSdiwoxs - auth0Name: fed-example-com-adfs - domains: - - example.com - - example2.com - expirationNotificationPeriod: P30D - id: 645eae30-ea32-4542-af58-1d9012fed81a - metadata: - createdBy: 666a3f38-d4fa-5b62-a391-a69029758d32 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: AD FS Federation with Metadata URL - organizationId: 9b0ee210-70a0-4158-b025-0decde66e4de - providerType: ADFS - resourceId: 862b6f03-58ac-479b-9ca5-5cb4429d8996 - state: ENABLED - type: application/vnd.netapp.bxp.federation - version: "1.0" - - adfsOptions: - signingCertificateFingerprint: 33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8 - auth0Id: con_jxQFVfPHKSdiwoxs - auth0Name: fed-example-com-adfs - domains: - - example.com - - example2.com - expirationNotificationPeriod: P30D - expirationTimestamp: "2024-11-18T20:58:16.305662Z" - id: 645eae30-ea32-4542-af58-1d9012fed81a - metadata: - createdBy: 666a3f38-d4fa-5b62-a391-a69029758d32 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: AD FS Federation with Metadata File - organizationId: 9b0ee210-70a0-4158-b025-0decde66e4de - providerType: ADFS - resourceId: 862b6f03-58ac-479b-9ca5-5cb4429d8996 - state: ENABLED - type: application/vnd.netapp.bxp.federation - version: "1.0" - - auth0Id: con_jxQFVfPHKSdiwoxs - auth0Name: fed-example-com-waad - domains: - - example.com - - example2.com - entraIdOptions: - clientId: 94e2a45c-64e6-48d1-a31e-1eee0ded5c2a - clientSecretMasked: qPz******* - groupsEnabled: false - maxGroupCount: 10 - tenantDomain: example.onmicrosoft.com - expirationNotificationPeriod: P30D - expirationTimestamp: "2024-11-18T20:58:16.305662Z" - id: 645eae30-ea32-4542-af58-1d9012fed81a - metadata: - createdBy: 666a3f38-d4fa-5b62-a391-a69029758d32 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: Entra ID Federation - organizationId: 9b0ee210-70a0-4158-b025-0decde66e4de - providerType: ENTRAID - resourceId: 862b6f03-58ac-479b-9ca5-5cb4429d8996 - state: ENABLED - type: application/vnd.netapp.bxp.federation - version: "1.0" - - auth0Id: con_jxQFVfPHKSdiwoxs - auth0Name: fed-example-com-pingfederate - domains: - - example.com - - example2.com - expirationNotificationPeriod: P30D - expirationTimestamp: "2024-11-18T20:58:16.305662Z" - id: 645eae30-ea32-4542-af58-1d9012fed81a - metadata: - createdBy: 666a3f38-d4fa-5b62-a391-a69029758d32 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: PingFederate Federation - organizationId: 9b0ee210-70a0-4158-b025-0decde66e4de - pingFederateOptions: - serverUrl: https://example.com/saml/signin - signingCertificateFingerprint: 33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8 - providerType: PINGFEDERATE - resourceId: 862b6f03-58ac-479b-9ca5-5cb4429d8996 - state: ENABLED - type: application/vnd.netapp.bxp.federation - version: "1.0" - - auth0Id: con_jxQFVfPHKSdiwoxs - auth0Name: fed-example-com-samlp - domains: - - example.com - - example2.com - expirationNotificationPeriod: P30D - expirationTimestamp: "2024-11-18T20:58:16.305662Z" - id: 645eae30-ea32-4542-af58-1d9012fed81a - metadata: - createdBy: 666a3f38-d4fa-5b62-a391-a69029758d32 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: SAML Federation - organizationId: 9b0ee210-70a0-4158-b025-0decde66e4de - providerType: SAML - resourceId: 862b6f03-58ac-479b-9ca5-5cb4429d8996 - samlOptions: - signInUrl: https://example.com/saml/signin - signOutUrl: https://example.com/saml/signout - signingCertificateFingerprint: 33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8 - state: ENABLED - type: application/vnd.netapp.bxp.federation - version: "1.0" - schema: - $ref: '#/components/schemas/federation_1.0_list_response_body' - description: List of federations. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - summary: List federations. - tags: - - Federation - x-permission: bxp:federation-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - $ref: '#/components/parameters/organization_id' - post: - description: Creates a new federation. - requestBody: - content: - application/vnd.netapp.bxp.federation+json: - examples: - AD FS Provider with Metadata File: - value: - adfsOptions: - metadataFile: |- - - - \n
  • List domains
    • \n
  • Create a domain
    • \n
  • Delete a domain
    • \n
  • Retrieve a domain
    • \n
  • Update a domain
    • \n" - - name: Domain - - description: "The federation endpoints enable you to create and manage federation connections with identity providers. Federation provided through the NetApp Console replaces the functionality provided through Cloud Central Federation Setup.\n\nYou can perform the following actions using the federation endpoints:\n
      \n
    • List federations
      • \n
    • Create a federation
      • \n
    • Delete a federation
      • \n
    • Retrieve a federation
      • \n
    • Update a federation
      • \n
    " - name: Federation - - description: "The unmigrated connection endpoints enable you to import connections from Cloud Central into the NetApp Console. After you import a connection, it cannot be managed through Cloud Central Federation Setup. \n\nYou can perform the following actions using the unmigrated connection endpoints:\n
      \n
    • List unmigrated connections
      • \n
    • Import a connection
      • \n
    " - name: Unmigrated Connection \ No newline at end of file diff --git a/federation/federation_overview.adoc b/federation/federation_overview.adoc new file mode 100644 index 00000000..cbf279fc --- /dev/null +++ b/federation/federation_overview.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'federation/federation_overview.html' +summary: 'Federation endpoints in the Federation REST API for the NetApp Console' +--- + += Federation endpoints in the Federation REST API for the NetApp Console + + + +The federation endpoints enable you to create and manage federation connections with identity providers. Federation provided through the NetApp Console replaces the functionality provided through Cloud Central Federation Setup. + +You can perform the following actions using the federation endpoints: + +* List federations +* Create a federation +* Delete a federation +* Retrieve a federation +* Update a federation + + diff --git a/federation/get-organizations-domains-.adoc b/federation/get-organizations-domains-.adoc new file mode 100644 index 00000000..dbe1c799 --- /dev/null +++ b/federation/get-organizations-domains-.adoc @@ -0,0 +1,579 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'federation/get-organizations-domains-.html' +summary: 'Retrieve a domain' +--- + += Retrieve a domain + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/domains/{domain_id}`# + + + +Retrieves the specified domain. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|Identifier for an organization. + + +|domain_id +|string +|path +|True +a|ID of the domain. + +* example: 4336388b-2992-43af-81de-ba9284b7dc36 + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|=== + +== Response + +``` +Status: 200, Returns the stored domain in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|code +|string +|False +a|The unique verification code for this domain. + + +|federations +|array[link:#federations[federations]] +|False +a|The list of federations that use this domain. + + +|id +|string +|False +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|The domain name. + + +|organizationId +|string +|False +a|Identifier for an organization. + + +|resourceId +|string +|False +a|Identifier for the resource. + + +|state +|string +|False +a|The state of the domain. +Defined values are: + +* "UNVERIFIED" - Ownership of the domain has not been verified. +* "VERIFIED" - Ownership of the domain has been verified using a DNS TXT record with the verification code. + + +|type +|string +|False +a|Media type of the resource. + + +|verificationTimestamp +|string +|False +a|The date that the domain was verified. + + +|version +|string +|False +a|Version of the resource. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "code": "Console133ad2ea-99de-4ada-9be4-876d4d53923e", + "federations": [ + { + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "name": "Example Co. AD FS" + }, + { + "id": "645eae30-ea32-4542-af58-1d9012fed81a", + "name": "Example Co. SAML" + } + ], + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "example.com", + "organizationId": "9b0ee210-70a0-4158-b025-0decde66e4de", + "resourceId": "862b6f03-58ac-479b-9ca5-5cb4429d8996", + "state": "VERIFIED", + "type": "application/vnd.netapp.bxp.domain", + "verificationTimestamp": "2024-11-18T20:58:16.305662Z", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#federations] +[.api-collapsible-fifth-title] +federations + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|name +|string +|False +a|The name of the federation. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/federation/get-organizations-domains.adoc b/federation/get-organizations-domains.adoc new file mode 100644 index 00000000..9767c8c7 --- /dev/null +++ b/federation/get-organizations-domains.adoc @@ -0,0 +1,596 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'federation/get-organizations-domains.html' +summary: 'List domains' +--- + += List domains + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/domains`# + + + +Lists all domains. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|Identifier for an organization. + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|=== + +== Response + +``` +Status: 200, List of domains. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|integer +|False +a|Total number of resources in the collection that match the query. + + +|items +|array[link:#domain_1_0_get_response_body[domain_1.0_get_response_body]] +|True +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "count": 1, + "items": [ + { + "code": "Console133ad2ea-99de-4ada-9be4-876d4d53923e", + "federations": [ + { + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "name": "Example Co. AD FS" + }, + { + "id": "645eae30-ea32-4542-af58-1d9012fed81a", + "name": "Example Co. SAML" + } + ], + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "example.com", + "organizationId": "9b0ee210-70a0-4158-b025-0decde66e4de", + "resourceId": "862b6f03-58ac-479b-9ca5-5cb4429d8996", + "state": "VERIFIED", + "type": "application/vnd.netapp.bxp.domain", + "verificationTimestamp": "2024-11-18T20:58:16.305662Z", + "version": "1.0" + } + ] +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#federations] +[.api-collapsible-fifth-title] +federations + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|name +|string +|False +a|The name of the federation. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#domain_1_0_get_response_body] +[.api-collapsible-fifth-title] +domain_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|code +|string +|False +a|The unique verification code for this domain. + + +|federations +|array[link:#federations[federations]] +|False +a|The list of federations that use this domain. + + +|id +|string +|False +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|The domain name. + + +|organizationId +|string +|False +a|Identifier for an organization. + + +|resourceId +|string +|False +a|Identifier for the resource. + + +|state +|string +|False +a|The state of the domain. +Defined values are: + +* "UNVERIFIED" - Ownership of the domain has not been verified. +* "VERIFIED" - Ownership of the domain has been verified using a DNS TXT record with the verification code. + + +|type +|string +|False +a|Media type of the resource. + + +|verificationTimestamp +|string +|False +a|The date that the domain was verified. + + +|version +|string +|False +a|Version of the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/federation/get-organizations-federations-.adoc b/federation/get-organizations-federations-.adoc new file mode 100644 index 00000000..f570b19d --- /dev/null +++ b/federation/get-organizations-federations-.adoc @@ -0,0 +1,763 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'federation/get-organizations-federations-.html' +summary: 'Retrieve a federation' +--- + += Retrieve a federation + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/federations/{federation_id}`# + + + +Retrieves the specified federation. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|Identifier for an organization. + + +|federation_id +|string +|path +|True +a|ID of the federation. + +* example: 645eae30-ea32-4542-af58-1d9012fed81a + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|=== + +== Response + +``` +Status: 200, Returns the stored federation in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|adfsOptions +|link:#federation_1_0_adfs_response_options[federation_1.0_adfs_response_options] +|False +a|Active Directory Federation Services (AD FS) configuration options when `providerType=ADFS`. + + +|auth0Id +|string +|False +a|The ID of the connection in Auth0. + + +|auth0Name +|string +|False +a|The name of the connection in Auth0. + + +|domains +|array[string] +|False +a|Array of email domain names that are associated with the federation. + + +|entraIdOptions +|link:#federation_1_0_entraid_response_options[federation_1.0_entraid_response_options] +|False +a|Microsoft Entra ID (formerly Azure Active Directory) configuration options when `providerType=ENTRAID`. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|expirationTimestamp +|string +|False +a|The date that the credentials or certificate expires. When a certificate is provided, the value is set to +the certificate's expiration timestamp. + + +|id +|string +|False +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|The name of the federation. + + +|organizationId +|string +|False +a|Identifier for an organization. + + +|pingFederateOptions +|link:#federation_1_0_pingfederate_response_options[federation_1.0_pingfederate_response_options] +|False +a|PingFederate configuration options when `providerType=PINGFEDERATE`. + + +|providerType +|string +|False +a|The type of the identity provider. Defined values are: + +* "ADFS" - Active Directory Federation Services +* "ENTRAID" - Microsoft Entra ID (formerly Azure Active Directory) +* "PINGFEDERATE" - PingFederate +* "SAML" - Security Assertion Markup Language 2.0 + + +|resourceId +|string +|False +a|Identifier for the resource. + + +|samlOptions +|link:#federation_1_0_saml_response_options[federation_1.0_saml_response_options] +|False +a|SAML configuration options when `providerType=SAML`. + + +|state +|string +|False +a|The state of the federation. Defined values are: + +* "DRAFT" - The federation is partially configured. +* "CREATED" - The federation is configured but not tested. +* "TESTED" - The federation has been successfully tested. +* "ENABLED" - The federation is enabled. +* "DISABLED" - The federation is disabled. + + +|type +|string +|False +a|Media type of the resource. + + +|version +|string +|False +a|Version of the resource. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "adfsOptions": { + "metadataUrl": "https://example.com/FederationMetadata/2007-06/FederationMetadata.xml", + "signingCertificateFingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8" + }, + "auth0Id": "con_jxQFVfPHKSdiwoxs", + "auth0Name": "fed-example-com-waad", + "domains": [ + "example.com", + "example2.com" + ], + "entraIdOptions": { + "clientId": "94e2a45c-64e6-48d1-a31e-1eee0ded5c2a", + "clientSecretMasked": "qPz*******", + "groupsEnabled": true, + "maxGroupCount": 10, + "tenantDomain": "example.onmicrosoft.com" + }, + "expirationNotificationPeriod": "P30D", + "expirationTimestamp": "2024-11-18T20:58:16.305662Z", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "Example Co.", + "organizationId": "9b0ee210-70a0-4158-b025-0decde66e4de", + "pingFederateOptions": { + "serverUrl": "https://example.com/saml/signin", + "signingCertificateFingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8" + }, + "providerType": "ENTRAID", + "resourceId": "862b6f03-58ac-479b-9ca5-5cb4429d8996", + "samlOptions": { + "signInUrl": "https://example.com/saml/signin", + "signOutUrl": "https://example.com/saml/signout", + "signingCertificateFingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.federation", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#federation_1_0_adfs_response_options] +[.api-collapsible-fifth-title] +federation_1.0_adfs_response_options + +Active Directory Federation Services (AD FS) configuration options when `providerType=ADFS`. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|metadataUrl +|string +|False +a|AD FS server URL for the Federation metadata XML file. + + +|signingCertificateFingerprint +|string +|False +a|The SHA-1 fingerprint of the X.509 signing certificate if the metadata XML file was provided. + + +|=== + + +[#federation_1_0_entraid_response_options] +[.api-collapsible-fifth-title] +federation_1.0_entraid_response_options + +Microsoft Entra ID (formerly Azure Active Directory) configuration options when `providerType=ENTRAID`. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clientId +|string +|False +a|Entra ID client ID. + + +|clientSecretMasked +|string +|False +a|Partially masked Entra ID client secret. + + +|groupsEnabled +|boolean +|False +a|Whether federation groups are enabled for Microsoft Entra ID. + + +|maxGroupCount +|integer +|False +a|Maximum number of groups to retrieve from Entra ID. + + +|tenantDomain +|string +|False +a|Entra ID domain. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#federation_1_0_pingfederate_response_options] +[.api-collapsible-fifth-title] +federation_1.0_pingfederate_response_options + +PingFederate configuration options when `providerType=PINGFEDERATE`. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serverUrl +|string +|False +a|PingFederate server URL. + + +|signingCertificateFingerprint +|string +|False +a|The SHA-1 fingerprint of the X.509 Signing certificate. + + +|=== + + +[#federation_1_0_saml_response_options] +[.api-collapsible-fifth-title] +federation_1.0_saml_response_options + +SAML configuration options when `providerType=SAML`. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|signInUrl +|string +|False +a|SAML single login URL. + + +|signOutUrl +|string +|False +a|SAML single logout URL. + + +|signingCertificateFingerprint +|string +|False +a|The SHA-1 fingerprint of the X.509 Signing certificate. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/federation/get-organizations-federations.adoc b/federation/get-organizations-federations.adoc new file mode 100644 index 00000000..92015947 --- /dev/null +++ b/federation/get-organizations-federations.adoc @@ -0,0 +1,871 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'federation/get-organizations-federations.html' +summary: 'List federations' +--- + += List federations + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/federations`# + + + +Lists all federations. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|Identifier for an organization. + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|=== + +== Response + +``` +Status: 200, List of federations. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|integer +|False +a|Total number of resources in the collection that match the query. + + +|items +|array[link:#federation_1_0_get_response_body[federation_1.0_get_response_body]] +|True +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "count": 5, + "items": [ + { + "adfsOptions": { + "metadataUrl": "https://example.com/FederationMetadata/2007-06/FederationMetadata.xml" + }, + "auth0Id": "con_jxQFVfPHKSdiwoxs", + "auth0Name": "fed-example-com-adfs", + "domains": [ + "example.com", + "example2.com" + ], + "expirationNotificationPeriod": "P30D", + "id": "645eae30-ea32-4542-af58-1d9012fed81a", + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "AD FS Federation with Metadata URL", + "organizationId": "9b0ee210-70a0-4158-b025-0decde66e4de", + "providerType": "ADFS", + "resourceId": "862b6f03-58ac-479b-9ca5-5cb4429d8996", + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.federation", + "version": "1.0" + }, + { + "adfsOptions": { + "signingCertificateFingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8" + }, + "auth0Id": "con_jxQFVfPHKSdiwoxs", + "auth0Name": "fed-example-com-adfs", + "domains": [ + "example.com", + "example2.com" + ], + "expirationNotificationPeriod": "P30D", + "expirationTimestamp": "2024-11-18T20:58:16.305662Z", + "id": "645eae30-ea32-4542-af58-1d9012fed81a", + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "AD FS Federation with Metadata File", + "organizationId": "9b0ee210-70a0-4158-b025-0decde66e4de", + "providerType": "ADFS", + "resourceId": "862b6f03-58ac-479b-9ca5-5cb4429d8996", + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.federation", + "version": "1.0" + }, + { + "auth0Id": "con_jxQFVfPHKSdiwoxs", + "auth0Name": "fed-example-com-waad", + "domains": [ + "example.com", + "example2.com" + ], + "entraIdOptions": { + "clientId": "94e2a45c-64e6-48d1-a31e-1eee0ded5c2a", + "clientSecretMasked": "qPz*******", + "groupsEnabled": false, + "maxGroupCount": 10, + "tenantDomain": "example.onmicrosoft.com" + }, + "expirationNotificationPeriod": "P30D", + "expirationTimestamp": "2024-11-18T20:58:16.305662Z", + "id": "645eae30-ea32-4542-af58-1d9012fed81a", + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "Entra ID Federation", + "organizationId": "9b0ee210-70a0-4158-b025-0decde66e4de", + "providerType": "ENTRAID", + "resourceId": "862b6f03-58ac-479b-9ca5-5cb4429d8996", + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.federation", + "version": "1.0" + }, + { + "auth0Id": "con_jxQFVfPHKSdiwoxs", + "auth0Name": "fed-example-com-pingfederate", + "domains": [ + "example.com", + "example2.com" + ], + "expirationNotificationPeriod": "P30D", + "expirationTimestamp": "2024-11-18T20:58:16.305662Z", + "id": "645eae30-ea32-4542-af58-1d9012fed81a", + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "PingFederate Federation", + "organizationId": "9b0ee210-70a0-4158-b025-0decde66e4de", + "pingFederateOptions": { + "serverUrl": "https://example.com/saml/signin", + "signingCertificateFingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8" + }, + "providerType": "PINGFEDERATE", + "resourceId": "862b6f03-58ac-479b-9ca5-5cb4429d8996", + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.federation", + "version": "1.0" + }, + { + "auth0Id": "con_jxQFVfPHKSdiwoxs", + "auth0Name": "fed-example-com-samlp", + "domains": [ + "example.com", + "example2.com" + ], + "expirationNotificationPeriod": "P30D", + "expirationTimestamp": "2024-11-18T20:58:16.305662Z", + "id": "645eae30-ea32-4542-af58-1d9012fed81a", + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "SAML Federation", + "organizationId": "9b0ee210-70a0-4158-b025-0decde66e4de", + "providerType": "SAML", + "resourceId": "862b6f03-58ac-479b-9ca5-5cb4429d8996", + "samlOptions": { + "signInUrl": "https://example.com/saml/signin", + "signOutUrl": "https://example.com/saml/signout", + "signingCertificateFingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.federation", + "version": "1.0" + } + ] +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#federation_1_0_adfs_response_options] +[.api-collapsible-fifth-title] +federation_1.0_adfs_response_options + +Active Directory Federation Services (AD FS) configuration options when `providerType=ADFS`. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|metadataUrl +|string +|False +a|AD FS server URL for the Federation metadata XML file. + + +|signingCertificateFingerprint +|string +|False +a|The SHA-1 fingerprint of the X.509 signing certificate if the metadata XML file was provided. + + +|=== + + +[#federation_1_0_entraid_response_options] +[.api-collapsible-fifth-title] +federation_1.0_entraid_response_options + +Microsoft Entra ID (formerly Azure Active Directory) configuration options when `providerType=ENTRAID`. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clientId +|string +|False +a|Entra ID client ID. + + +|clientSecretMasked +|string +|False +a|Partially masked Entra ID client secret. + + +|groupsEnabled +|boolean +|False +a|Whether federation groups are enabled for Microsoft Entra ID. + + +|maxGroupCount +|integer +|False +a|Maximum number of groups to retrieve from Entra ID. + + +|tenantDomain +|string +|False +a|Entra ID domain. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#federation_1_0_pingfederate_response_options] +[.api-collapsible-fifth-title] +federation_1.0_pingfederate_response_options + +PingFederate configuration options when `providerType=PINGFEDERATE`. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serverUrl +|string +|False +a|PingFederate server URL. + + +|signingCertificateFingerprint +|string +|False +a|The SHA-1 fingerprint of the X.509 Signing certificate. + + +|=== + + +[#federation_1_0_saml_response_options] +[.api-collapsible-fifth-title] +federation_1.0_saml_response_options + +SAML configuration options when `providerType=SAML`. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|signInUrl +|string +|False +a|SAML single login URL. + + +|signOutUrl +|string +|False +a|SAML single logout URL. + + +|signingCertificateFingerprint +|string +|False +a|The SHA-1 fingerprint of the X.509 Signing certificate. + + +|=== + + +[#federation_1_0_get_response_body] +[.api-collapsible-fifth-title] +federation_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|adfsOptions +|link:#federation_1_0_adfs_response_options[federation_1.0_adfs_response_options] +|False +a|Active Directory Federation Services (AD FS) configuration options when `providerType=ADFS`. + + +|auth0Id +|string +|False +a|The ID of the connection in Auth0. + + +|auth0Name +|string +|False +a|The name of the connection in Auth0. + + +|domains +|array[string] +|False +a|Array of email domain names that are associated with the federation. + + +|entraIdOptions +|link:#federation_1_0_entraid_response_options[federation_1.0_entraid_response_options] +|False +a|Microsoft Entra ID (formerly Azure Active Directory) configuration options when `providerType=ENTRAID`. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|expirationTimestamp +|string +|False +a|The date that the credentials or certificate expires. When a certificate is provided, the value is set to +the certificate's expiration timestamp. + + +|id +|string +|False +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|The name of the federation. + + +|organizationId +|string +|False +a|Identifier for an organization. + + +|pingFederateOptions +|link:#federation_1_0_pingfederate_response_options[federation_1.0_pingfederate_response_options] +|False +a|PingFederate configuration options when `providerType=PINGFEDERATE`. + + +|providerType +|string +|False +a|The type of the identity provider. Defined values are: + +* "ADFS" - Active Directory Federation Services +* "ENTRAID" - Microsoft Entra ID (formerly Azure Active Directory) +* "PINGFEDERATE" - PingFederate +* "SAML" - Security Assertion Markup Language 2.0 + + +|resourceId +|string +|False +a|Identifier for the resource. + + +|samlOptions +|link:#federation_1_0_saml_response_options[federation_1.0_saml_response_options] +|False +a|SAML configuration options when `providerType=SAML`. + + +|state +|string +|False +a|The state of the federation. Defined values are: + +* "DRAFT" - The federation is partially configured. +* "CREATED" - The federation is configured but not tested. +* "TESTED" - The federation has been successfully tested. +* "ENABLED" - The federation is enabled. +* "DISABLED" - The federation is disabled. + + +|type +|string +|False +a|Media type of the resource. + + +|version +|string +|False +a|Version of the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/federation/get-unmigratedconnections.adoc b/federation/get-unmigratedconnections.adoc new file mode 100644 index 00000000..c690deaa --- /dev/null +++ b/federation/get-unmigratedconnections.adoc @@ -0,0 +1,513 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'federation/get-unmigratedconnections.html' +summary: 'List unmigrated connections' +--- + += List unmigrated connections + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/unmigratedconnections`# + + + +Lists connections managed through Cloud Central that you can import into the NetApp Console. +Connections must be enabled in Cloud Central to be eligible for import. +Only connections that you have permission to manage in Cloud Central are returned. + + +== Response + +``` +Status: 200, List of unmigrated connections. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|items +|array[link:#unmigratedconnection_1_0_get_response_body[unmigratedconnection_1.0_get_response_body]] +|True +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "items": [ + { + "adfsOptions": { + "metadataFileProvided": true, + "metadataUrl": "https://example.com/FederationMetadata/2007-06/FederationMetadata.xml", + "signInUrl": "https://example.com/adfs/ls/" + }, + "creatorUsers": [ + "auth0|680f8f5e279840afb355ab00", + "auth0|680f8f5e279840afb355ab11" + ], + "domains": [ + "example.com", + "example2.com" + ], + "emailDomain": "example.com", + "entraIdOptions": { + "clientId": "94e2a45c-64e6-48d1-a31e-1eee0ded5c2a", + "tenantDomain": "example.onmicrosoft.com" + }, + "id": "con_jxQFVfPHKSdiwoxs", + "name": "fed-example-com-waad", + "pingFederateOptions": { + "serverUrl": "https://example.com/saml/signin" + }, + "providerType": "ENTRAID", + "samlOptions": { + "signInUrl": "https://example.com/saml/signin" + }, + "type": "application/vnd.netapp.bxp.unmigratedconnection", + "version": "1.0" + } + ] +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#unmigratedconnection_1_0_adfs_response_options] +[.api-collapsible-fifth-title] +unmigratedconnection_1.0_adfs_response_options + +Active Directory Federation Services (AD FS) configuration options when `providerType=ADFS`. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|metadataFileProvided +|boolean +|False +a|Indicates whether the connection uses the Federation metadata XML file or the server URL. + + +|metadataUrl +|string +|False +a|AD FS server URL for the Federation metadata XML file. + + +|signInUrl +|string +|False +a|AD FS single login URL extracted from the Federation metadata XML file. + + +|=== + + +[#unmigratedconnection_1_0_entraid_response_options] +[.api-collapsible-fifth-title] +unmigratedconnection_1.0_entraid_response_options + +Microsoft Entra ID (formerly Azure Active Directory) configuration options when `providerType=ENTRAID`. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clientId +|string +|False +a|Entra ID client ID. + + +|tenantDomain +|string +|False +a|Entra ID domain. + + +|=== + + +[#unmigratedconnection_1_0_pingfederate_response_options] +[.api-collapsible-fifth-title] +unmigratedconnection_1.0_pingfederate_response_options + +PingFederate configuration options when `providerType=PINGFEDERATE`. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serverUrl +|string +|False +a|PingFederate server URL. + + +|=== + + +[#unmigratedconnection_1_0_saml_response_options] +[.api-collapsible-fifth-title] +unmigratedconnection_1.0_saml_response_options + +SAML configuration options when `providerType=SAML`. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|signInUrl +|string +|False +a|SAML single login URL. + + +|=== + + +[#unmigratedconnection_1_0_get_response_body] +[.api-collapsible-fifth-title] +unmigratedconnection_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|adfsOptions +|link:#unmigratedconnection_1_0_adfs_response_options[unmigratedconnection_1.0_adfs_response_options] +|False +a|Active Directory Federation Services (AD FS) configuration options when `providerType=ADFS`. + + +|creatorUsers +|array[string] +|False +a|Array of Auth0 user IDs that can manage the connection in Cloud Central. + + +|domains +|array[string] +|False +a|Array of domain names that are associated with the connection. + + +|emailDomain +|string +|False +a|The primary email domain associated with the connection. + + +|entraIdOptions +|link:#unmigratedconnection_1_0_entraid_response_options[unmigratedconnection_1.0_entraid_response_options] +|False +a|Microsoft Entra ID (formerly Azure Active Directory) configuration options when `providerType=ENTRAID`. + + +|id +|string +|False +a|The ID of the connection in Auth0. + + +|name +|string +|False +a|The name of the connection in Auth0. + + +|pingFederateOptions +|link:#unmigratedconnection_1_0_pingfederate_response_options[unmigratedconnection_1.0_pingfederate_response_options] +|False +a|PingFederate configuration options when `providerType=PINGFEDERATE`. + + +|providerType +|string +|False +a|The type of the identity provider. Defined values are: + +* "ADFS" - Active Directory Federation Services +* "ENTRAID" - Microsoft Entra ID (formerly Azure Active Directory) +* "PINGFEDERATE" - PingFederate +* "SAML" - Security Assertion Markup Language 2.0 + + +|samlOptions +|link:#unmigratedconnection_1_0_saml_response_options[unmigratedconnection_1.0_saml_response_options] +|False +a|SAML configuration options when `providerType=SAML`. + + +|type +|string +|False +a|Media type of the resource. + + +|version +|string +|False +a|Version of the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/federation/overview.adoc b/federation/overview.adoc new file mode 100644 index 00000000..7c0557d1 --- /dev/null +++ b/federation/overview.adoc @@ -0,0 +1,131 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'federation/overview.html' +summary: 'Federation REST API for the NetApp Console' +--- + += Federation REST API for the NetApp Console + + + +Federation through the NetApp Console manages identity federation between the Console and customer identity providers. +Identity federation enables single sign-on with the Console so that your corporate users can log in using their credentials. + +The federation endpoints also allow your users to configure their notification settings so that they're notified +before their identity provider credentials or certificates expire. + +The following components are defined within federation: + +* domain +* federation +* unmigrated connection + +To configure a federation, all domains that don't match your user's email address must be verified. To verify a domain, you first need to add the domain to the Console in order to receive a unique code. You use the code to create a DNS TXT record for the domain, and then you verify the domain in the Console. + +Federation provided through the Console replaces the functionality provided through Cloud Central Federation Setup. Federations +configured through Cloud Central are "unmigrated connections". The unmigrated connection endpoints enable you to +non-disruptively import a connection into an organization and manage it with federation in the Console. +After you import a connection, it cannot be managed through Cloud Central Federation Setup. + +NOTE: Before using the API reference documentation, review the +https://docs.netapp.com/us-en/bluexp-automation/platform/overview.html[Get started] section for the +Console APIs. For more information about the security tokens and identifiers you'll need when using the API, review the +https://docs.netapp.com/us-en/bluexp-automation/platform/get_identifiers.html[Common workflows and tasks] section. + +''' + +== REST implementation + +=== HTTP methods + +|=== +| Method | Description + +| POST +| Create an object instance + +| GET +| Retrieve an object instance or collection + +| PATCH +| Update an existing object + +| DELETE +| Remove an existing object +|=== + +=== Request headers + +|=== +| Request Header | Description + +| Authorization +| This header contains a bearer token used to access the Console server. + +| Content-Type +| This representation header is used to indicate the original media type of the resource. + +| Accept +| The server automatically returns content in JSON format if Accept header is not specified. +|=== + +=== Query parameters + +You can use query parameters with endpoints in the following components: + +|=== +| Component | Query Parameter + +| Domain +| include, count, filter, limit, skip, orderBy + +| Federation +| include, count, filter, limit, skip, orderBy +|=== + +=== Response headers + +This API uses the standard HTTP response headers common with all Console APIs. See +https://docs.netapp.com/us-en/bluexp-automation/platform/http_details.html[REST implementation] for more information. + +=== HTTP status codes + +|=== +| HTTP Status Code | Description + +| 200 +| OK: Returned for successful operation completion + +| 202 +| Accepted: The request was accepted and is currently in process. + +| 204 +| The operation was completed successfully and the server did not send a response message. + +| 400 +| Bad Request: Returned if the input is malformed and could not be parsed + +| 401 +| Unauthorized: Returned if user authentication failed or the token has expired + +| 403 +| Forbidden: Returned for authorization errors depending on the resource and token. + +| 409 +| Conflict: The operation failed because another operation is already in progress. + +| 5xx +| An unexpected error occurred within the Console server which has prevented it from fulfilling the request. +|=== + +== Error handling + +There are three processes involved with error handling and processing: + +* The error is logged for supportability +* The error is also returned to the caller for any specific handling +* The database connection is rolled back + + diff --git a/federation/patch-organizations-domains-.adoc b/federation/patch-organizations-domains-.adoc new file mode 100644 index 00000000..ba89bf48 --- /dev/null +++ b/federation/patch-organizations-domains-.adoc @@ -0,0 +1,612 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'federation/patch-organizations-domains-.html' +summary: 'Update a domain' +--- + += Update a domain + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/organizations/{organization_id}/domains/{domain_id}`# + + + +Updates the specified domain. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|Identifier for an organization. + + +|domain_id +|string +|path +|True +a|ID of the domain. + +* example: 4336388b-2992-43af-81de-ba9284b7dc36 + + +|=== + +== Request Body + +Replaces the specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stateDesired +|string +|True +a|The desired state of the domain. + + +|type +|string +|True +a|Media type of the resource. + + +|version +|string +|True +a|Version of the resource. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "stateDesired": "VERIFIED", + "type": "application/vnd.netapp.bxp.domain", + "version": "1.0" +} +==== + +== Response + +``` +Status: 200, Returns the updated domain in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|code +|string +|False +a|The unique verification code for this domain. + + +|federations +|array[link:#federations[federations]] +|False +a|The list of federations that use this domain. + + +|id +|string +|False +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|The domain name. + + +|organizationId +|string +|False +a|Identifier for an organization. + + +|resourceId +|string +|False +a|Identifier for the resource. + + +|state +|string +|False +a|The state of the domain. +Defined values are: + +* "UNVERIFIED" - Ownership of the domain has not been verified. +* "VERIFIED" - Ownership of the domain has been verified using a DNS TXT record with the verification code. + + +|type +|string +|False +a|Media type of the resource. + + +|verificationTimestamp +|string +|False +a|The date that the domain was verified. + + +|version +|string +|False +a|Version of the resource. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "code": "Console133ad2ea-99de-4ada-9be4-876d4d53923e", + "federations": [ + { + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "name": "Example Co. AD FS" + }, + { + "id": "645eae30-ea32-4542-af58-1d9012fed81a", + "name": "Example Co. SAML" + } + ], + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "example.com", + "organizationId": "9b0ee210-70a0-4158-b025-0decde66e4de", + "resourceId": "862b6f03-58ac-479b-9ca5-5cb4429d8996", + "state": "VERIFIED", + "type": "application/vnd.netapp.bxp.domain", + "verificationTimestamp": "2024-11-18T20:58:16.305662Z", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#federations] +[.api-collapsible-fifth-title] +federations + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|name +|string +|False +a|The name of the federation. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/federation/patch-organizations-federations-.adoc b/federation/patch-organizations-federations-.adoc new file mode 100644 index 00000000..f49a0c55 --- /dev/null +++ b/federation/patch-organizations-federations-.adoc @@ -0,0 +1,1042 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'federation/patch-organizations-federations-.html' +summary: 'Update a federation' +--- + += Update a federation + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/organizations/{organization_id}/federations/{federation_id}`# + + + +Updates the specified federation. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|Identifier for an organization. + + +|federation_id +|string +|path +|True +a|ID of the federation. + +* example: 645eae30-ea32-4542-af58-1d9012fed81a + + +|=== + +== Request Body + +Replaces the specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|adfsOptions +|link:#federation_1_0_adfs_request_options[federation_1.0_adfs_request_options] +|False +a|Active Directory Federation Services (AD FS) configuration options when `providerType=ADFS`. +Either `metadataUrl` or `metadataFile` must be provided. + + +|domains +|array[string] +|False +a|Array of email domain names that are associated with the federation. + +All previously configured domains must be included in the request body when updating the `domains` +field or they will be removed. Previously configured domains do not need to be in a `VERIFIED` state. + +If a domain matches the user's email address or is an Entra ID `*.onmicrosoft.com` tenant domain, then it +does not need to be in a `VERIFIED` state. All other domains must be added to the domains +collection and in a `VERIFIED` state. + + +|entraIdOptions +|link:#federation_1_0_entraid_patch_request_options[federation_1.0_entraid_patch_request_options] +|False +a|Microsoft Entra ID (formerly Azure Active Directory) configuration options when `providerType=ENTRAID`. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|expirationTimestamp +|string +|False +a|The date that the credentials expire. This is only applicable when `providerType=ENTRAID`. When a +certificate is provided for other provider types, the value is set to the certificate's expiration timestamp. + + +|name +|string +|False +a|The name of the federation. + + +|pingFederateOptions +|link:#federation_1_0_pingfederate_patch_request_options[federation_1.0_pingfederate_patch_request_options] +|False +a|PingFederate configuration options when `providerType=PINGFEDERATE`. + + +|providerType +|string +|False +a|The type of the identity provider. Defined values are: + +* "ADFS" - Active Directory Federation Services +* "ENTRAID" - Microsoft Entra ID (formerly Azure Active Directory) +* "PINGFEDERATE" - PingFederate +* "SAML" - Security Assertion Markup Language 2.0 + + +|samlOptions +|link:#federation_1_0_saml_patch_request_options[federation_1.0_saml_patch_request_options] +|False +a|SAML configuration options when `providerType=SAML`. + + +|stateDesired +|string +|False +a|The desired state of the federation. Defined values are: + +* "DRAFT" - The federation is partially configured. +* "CREATED" - The federation is configured but not tested. +* "TESTED" - The federation has been successfully tested. +* "ENABLED" - The federation is enabled. +* "DISABLED" - The federation is disabled. + + +|type +|string +|True +a|Media type of the resource. + + +|version +|string +|True +a|Version of the resource. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "adfsOptions": { + "metadataFile": "\n\n+++The AWS credentials endpoints interact with the Credentials service to retrieve appropriate AWS credentials. + +You can perform the following actions with the AWS credentials endpoints: + +* Retrieve AWS credentials for a Tenancy account *++++++[Deprecated] Create AWS credentials++++++++++++ + + diff --git a/fsx/aws_operations_overview.adoc b/fsx/aws_operations_overview.adoc new file mode 100644 index 00000000..554a75e6 --- /dev/null +++ b/fsx/aws_operations_overview.adoc @@ -0,0 +1,19 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/aws_operations_overview.html' +summary: 'AWS operations endpoints in the Amazon FSx for NetApp ONTAP management REST API' +--- + += AWS operations endpoints in the Amazon FSx for NetApp ONTAP management REST API + + + ++++
    +++The AWS operations endpoints manage operations made directly on AWS resources by using AWS credentials. + +You can perform the following actions with the AWS operations endpoints: + +* Retrieve AWS VPCs * Retrieve AWS route tables * Retrieve AWS encryption keys+++
    +++ + + diff --git a/fsx/delete-working-environments--workspace-.adoc b/fsx/delete-working-environments--workspace-.adoc new file mode 100644 index 00000000..7303a5e3 --- /dev/null +++ b/fsx/delete-working-environments--workspace-.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/delete-working-environments--workspace-.html' +summary: 'Remove working environment from workspace' +--- + += Remove working environment from workspace + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/working-environments/{accountId}/{workingEnvironmentId}/workspace/{workspaceId}`# + + + +Removes working environments from a workspace. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|workspaceId +|string +|path +|True +a| + +|=== + +== Response + +``` +Status: 200, +``` + diff --git a/fsx/delete-working-environments-.adoc b/fsx/delete-working-environments-.adoc new file mode 100644 index 00000000..f9e9d9ff --- /dev/null +++ b/fsx/delete-working-environments-.adoc @@ -0,0 +1,61 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/delete-working-environments-.html' +summary: 'Delete an FSX working environment' +--- + += Delete an FSX working environment + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/working-environments/{accountId}/{workingEnvironmentId}`# + + + +Deletes an FSx ONTAP working environment. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Response + +``` +Status: 200, +``` + diff --git a/fsx/fsx-x-doc.json b/fsx/fsx-x-doc.json deleted file mode 100644 index a4285363..00000000 --- a/fsx/fsx-x-doc.json +++ /dev/null @@ -1,200 +0,0 @@ -{ - "overview": "Amazon FSx for NetApp ONTAP management REST API", - "permalink": "overview.html", - "paths": { - "/aws-credentials/{accountId}": { - "get": { - "x-doc": { - "title": "Retrieve AWS credentials", - "category": "AWS Credentials", - "filename": "get-aws-credentials-.html", - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Add AWS credentials", - "category": "AWS Credentials", - "filename": "post-aws-credentials-.html", - "explorer": false - } - } - }, - "/working-environments/{accountId}": { - "get": { - "x-doc": { - "title": "Retrieve working environments", - "category": "Working Environments", - "filename": "get-working-environments-.html", - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create FSx for ONTAP working environments", - "category": "Working Environments", - "filename": "post-working-environments-.html", - "explorer": false - } - } - }, - "/working-environments/{accountId}/discover": { - "get": { - "x-doc": { - "title": "Discover working environments", - "category": "Working Environments", - "filename": "get-working-environments-discover.html", - "explorer": false - } - } - }, - "/working-environments/{accountId}/{workingEnvironmentId}/volumes": { - "get": { - "x-doc": { - "title": "Retrieve volumes", - "category": "Working Environments", - "filename": "get-working-environments--volumes.html", - "explorer": false - } - } - }, - "/working-environments/{accountId}/{workingEnvironmentId}/credentials": { - "get": { - "x-doc": { - "title": "Retrieve ONTAP credentials", - "category": "Working Environments", - "filename": "get-working-environments--credentials.html", - "explorer": false - } - }, - "post": { - "x-doc": { - "title": "Create ONTAP credentials", - "category": "Working Environments", - "filename": "post-working-environments--credentials.html", - "explorer": false - } - } - }, - "/working-environments/{accountId}/recover": { - "post": { - "x-doc": { - "title": "Recover working environments", - "category": "Working Environments", - "filename": "post-working-environments-recover.html", - "explorer": false - } - } - }, - "/working-environments/{accountId}/{workingEnvironmentId}": { - "get": { - "x-doc": { - "title": "Retrieve working environments by account", - "category": "Working Environments", - "filename": "get-working-environments-id-.html", - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete an FSX working environment", - "category": "Working Environments", - "filename": "delete-working-environments-.html", - "explorer": false - } - } - }, - "/working-environments/{accountId}/{workingEnvironmentId}/workspace/{workspaceId}": { - "delete": { - "x-doc": { - "title": "Remove working environment from workspace", - "category": "Working Environments", - "filename": "delete-working-environments--workspace-.html", - "explorer": false - } - } - }, - "/aws/vpcs": { - "get": { - "x-doc": { - "title": "Retrieve VPCs", - "category": "AWS Operations", - "filename": "get-aws-vpcs.html", - "explorer": false - } - } - }, - "/aws/route-tables": { - "get": { - "x-doc": { - "title": "Retrieve route tables", - "category": "AWS Operations", - "filename": "get-aws-route-tables.html", - "explorer": false - } - } - }, - "/aws/encryption-keys": { - "get": { - "x-doc": { - "title": "Retrieve encryption keys", - "category": "AWS Operations", - "filename": "get-aws-encryption-keys.html", - "explorer": false - } - } - }, - "/working-environments/{accountId}/{fileSystemId}": { - "patch": { - "x-doc": { - "title": "Update FSx ONTAP systems", - "category": "Working Environments", - "filename": "patch-working-environments-.html", - "explorer": false - } - } - }, - "/discovery/{accountId}/discover": { - "get": { - "x-doc": { - "title": "Discover FSx ONTAP systems", - "category": "FSx ONTAP discovery", - "filename": "get-discovery-discover.html", - "explorer": false - } - } - }, - "/aws/supported-regions": { - "get": { - "x-doc": { - "title": "Retrieve supported regions", - "category": "AWS Operations", - "filename": "get-aws-supported-regions.html", - "explorer": false - } - } - } - }, - "categories": [ - { - "id": "working environments", - "title": "Working environments endpoints in the Amazon FSx for NetApp ONTAP management REST API", - "permalink": "working_environments_overview.html" - }, - { - "id": "aws operations", - "title": "AWS operations endpoints in the Amazon FSx for NetApp ONTAP management REST API", - "permalink": "aws_operations_overview.html" - }, - { - "id": "aws credentials", - "title": "AWS credentials endpoints in the Amazon FSx for NetApp ONTAP management REST API", - "permalink": "aws_credentials_overview.html" - }, - { - "id": "fsx ontap discovery", - "title": "FSx ONTAP discovery endpoints in the Amazon FSx for NetApp ONTAP management REST API", - "permalink": "fsx_ontap_discovery_overview.html" - } - ] -} \ No newline at end of file diff --git a/fsx/fsx.json b/fsx/fsx.json deleted file mode 100644 index 71db991d..00000000 --- a/fsx/fsx.json +++ /dev/null @@ -1,1795 +0,0 @@ -{ - "openapi":"3.0.0", - "info":{ - "title":"Fsx for Ontap service API", - "description":"
    Overview\n

    Amazon FSx for NetApp ONTAP is a Cloud Manager service that enables you to create, operate, and delete Amazon FSx storage facilities for ONTAP systems.
    \nFor more information about FSx for ONTAP, see Cloud Manager FSx ONTAP.

    \n

    There are four categories of API endpoints defined within the FSx for ONTAP service:

    \n
      \n
    • AWS operations
      • \n
    • AWS credentials
      • \n
    • Working environments
      • \n
    • FSx ONTAP discovery
    \n

    References

    \n\n
    \n
    \n
    \nREST implementation\n

    HTTP methods

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    MethodDescription
    POSTCreate an object instance
    GETRetrieve an object instance or collection
    PUTUpdate specified properties of existing objects
    DELETERemove an existing object
    \n

    Request headers

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Request HeaderDescription
    AuthorizationRequired. Contains a JWT access token
    X-Service-Request-IdRequest ID to use in logs
    x-simulatorIndicates whether this API call is simulated or real
    \n

    Query parameters

    \n

    You can use query parameters with endpoints in the following components:

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ComponentQuery Parameter
    isGov- Used to decide whether FSx storage is located in the governed location
    region- The API will be executed in the specified region
    workspace-id- The Cloud Manager workspace
    \n

    Path parameters

    \n

    You can use path parameters with endpoints.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ComponentQuery Parameter
    account-idTenancy account ID for this API
    workingEnvironmentIdFSx working environment ID used to execute this API
    \n

    Response headers

    \n

    This API uses the standard HTTP response headers common with all Cloud Manager APIs. See REST implementation for more information.

    \n

    HTTP status codes

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    HTTP Status CodeDescription
    200OK: Returned for successful operation completion
    400Bad Request: Returned if the input is malformed and could not be parsed
    401Unauthorized: Returned if user authentication failed or the token has expired
    403Forbidden: Returned for authorization errors depending on the resource and token
    404Not Found: Returned if the requested resource could not be found
    500Processing Error: Returned if an error occurs on the server while processing the API call
    \n
    \n
    \n
    \nError handling\n

    There are three processes involved with error handling and processing:

    \n
      \n
    • The error is logged for supportability
      • \n
    • The error is returned to the caller for specific handling
      • \n
    • The database connection is rolled back
      • \n
    \n
    \n
    \n
    \ncURL examples\n

    Retrieve FSx working environments for a specified account ID

    \n

    This cURL example retrieves FSx working environments for a specified account ID.

    \n
    curl -X GET "https://staging.cloudmanager.cloud.netapp.com/fsx-ontap/working-environments/<accountId>"\n -H  "accept: application/json" -H  "authorization: <user token>"\n
    \n
    \n
    \n

    ", - "version":"1.0", - "contact":{ - - } - }, - "tags":[ - { - "name":"Working Environments", - "description":"
    \nOverview\n
    \nThe working environment endpoints manage operations made on working environments in Cloud Manager.\n

    You can perform the following actions with the working environment endpoints:

    \n
      \n
    • Create an FSx for ONTAP working environment
      • \n
    • Retrieve FSx for ONTAP working environments by account
      • \n
    • Discover an FSx for ONTAP working environment
      • \n
    • Retrieve volume details for an FSx for ONTAP working environment
      • \n
    • Retrieve ONTAP credentials for an FSx for ONTAP working environment
      • \n
    • Create ONTAP credentials for an FSx for ONTAP working environment
      • \n
    • Recover FSx for ONTAP as a working environment
      • \n
    • Retrieve details for an FSx for ONTAP working environment
      • \n
    • Delete an FSx for ONTAP working environment
      • \n
    • Remove an FSx for ONTAP working environment from a workspace
      • \n
    • Update the throughput capacity of an FSx for ONTAP working environment
      • \n
    \n
    \n
    \n" - }, - { - "name":"AWS Operations", - "description":"
    \nOverview\n
    \nThe AWS operations endpoints manage operations made directly on AWS resources by using AWS credentials.\n

    You can perform the following actions with the AWS operations endpoints:

    \n
      \n
    • Retrieve AWS VPCs
      • \n
    • Retrieve AWS route tables
      • \n
    • Retrieve AWS encryption keys
      • \n
    \n
    \n
    \n" - }, - { - "name":"AWS Credentials", - "description":"
    \nOverview\n
    \nThe AWS credentials endpoints interact with the Credentials service to retrieve appropriate AWS credentials.\n

    You can perform the following actions with the AWS credentials endpoints:

    \n
      \n
    • Retrieve AWS credentials for a Tenancy account
      • \n
    • [Deprecated] Create AWS credentials
      • \n
    \n
    \n
    \n" - }, - { - "name":"FSx ONTAP discovery", - "description":"
    \nOverview\n
    \nThe discovery endpoints provide an API for discovering FSx ONTAP systems for a specified account in Cloud Manager.\n

    You can perform the following actions with the discovery endpoints:

    \n
      \n
    • Discover an FSx for ONTAP an account
      • \n
    \n
    \n
    \n" - } - ], - "servers":[ - { - "url":"/fsx-ontap" - } - ], - "components":{ - "securitySchemes":{ - "bearer":{ - "scheme":"bearer", - "bearerFormat":"JWT", - "type":"http" - } - }, - "schemas":{ - "AwsCredentialsDetails":{ - "type":"object", - "properties":{ - - } - }, - "AddAwsCredentialsRequest":{ - "type":"object", - "properties":{ - "accessKey":{ - "type":"string" - }, - "secretKey":{ - "type":"string" - }, - "name":{ - "type":"string" - } - }, - "required":[ - "accessKey", - "secretKey", - "name" - ] - }, - "WorkingEnvironmentResponse":{ - "type":"object", - "properties":{ - "id":{ - "type":"string" - }, - "name":{ - "type":"string" - }, - "region":{ - "type":"string" - }, - "deploymentType":{ - "type":"string" - }, - "providerDetails":{ - "type":"object" - }, - "volumes":{ - "type":"array", - "items":{ - "type":"string" - } - } - }, - "required":[ - "id", - "name", - "region", - "deploymentType", - "providerDetails", - "volumes" - ] - }, - "DiscoverResponse":{ - "type":"object", - "properties":{ - - } - }, - "ServiceVolume":{ - "type":"object", - "properties":{ - "id":{ - "type":"string" - }, - "endpoints":{ - "type":"object" - }, - "lifecycle":{ - "type":"string" - }, - "name":{ - "type":"string" - }, - "junctionPath":{ - "type":"string" - }, - "sizeInMegabytes":{ - "type":"number" - }, - "state":{ - "type":"string" - }, - "storageEfficiency":{ - "type":"boolean" - }, - "svmId":{ - "type":"string" - }, - "tieringPolicy":{ - "type":"object" - }, - "uuid":{ - "type":"string" - }, - "arn":{ - "type":"string" - }, - "tags":{ - "type":"array", - "items":{ - "type":"string" - } - }, - "volumeType":{ - "type":"string" - }, - "ontapVolumeType":{ - "type":"string" - } - }, - "required":[ - "id", - "endpoints", - "lifecycle", - "name", - "junctionPath", - "sizeInMegabytes", - "state", - "storageEfficiency", - "svmId", - "tieringPolicy", - "uuid", - "arn", - "tags", - "volumeType", - "ontapVolumeType" - ] - }, - "FsxOntapCredentials":{ - "type":"object", - "properties":{ - "ip":{ - "type":"string" - }, - "userName":{ - "type":"string" - }, - "password":{ - "type":"string" - } - }, - "required":[ - "ip", - "userName", - "password" - ] - }, - "FsxOntapCredentialsResponse":{ - "type":"object", - "properties":{ - "credentials":{ - "$ref":"#/components/schemas/FsxOntapCredentials" - } - }, - "required":[ - "credentials" - ] - }, - "FsxOntapCredentialsRequest":{ - "type":"object", - "properties":{ - "password":{ - "type":"string" - } - }, - "required":[ - "password" - ] - }, - "RecoverRequestBody":{ - "type":"object", - "properties":{ - "workspaceId":{ - "type":"string" - }, - "credentialsId":{ - "type":"string" - }, - "region":{ - "type":"string" - }, - "fileSystemId":{ - "type":"string" - }, - "name":{ - "type":"string" - } - }, - "required":[ - "workspaceId", - "credentialsId", - "region", - "fileSystemId", - "name" - ] - }, - "CreateFileSystemDto":{ - "type":"object", - "properties":{ - "name":{ - "type":"string" - }, - "credentialsId":{ - "type":"string" - }, - "region":{ - "type":"string" - }, - "workspaceId":{ - "type":"string" - }, - "storageCapacity":{ - "type":"object" - }, - "primarySubnetId":{ - "type":"string" - }, - "throughputCapacity":{ - "type":"number" - }, - "fsxAdminPassword":{ - "type":"string" - }, - "deploymentType":{ - "type":"string" - }, - "secondarySubnetId":{ - "type":"string" - }, - "securityGroupIds":{ - "type":"array", - "items":{ - "type":"string" - } - }, - "tags":{ - "type":"array", - "items":{ - "type":"string" - } - }, - "kmsKeyId":{ - "type":"string" - }, - "endpointIpAddressRange":{ - "type":"string" - }, - "svmAdminPassword":{ - "type":"string" - }, - "minimumSsdIops":{ - "type":"number" - }, - "routeTableIds":{ - "type":"array", - "items":{ - "type":"string" - } - } - }, - "required":[ - "name", - "credentialsId", - "region", - "workspaceId", - "storageCapacity", - "primarySubnetId", - "throughputCapacity", - "fsxAdminPassword", - "deploymentType" - ] - }, - "FsxOntapFileSystem":{ - "type":"object", - "properties":{ - "id":{ - "type":"string" - }, - "accountId":{ - "type":"string" - }, - "lifecycle":{ - "type":"string" - }, - "failureDetails":{ - "type":"string" - }, - "storageType":{ - "type":"string" - }, - "storageCapacity":{ - "type":"number" - }, - "vpcId":{ - "type":"string" - }, - "subnetIds":{ - "type":"array", - "items":{ - "type":"string" - } - }, - "networkInterfaceIds":{ - "type":"array", - "items":{ - "type":"string" - } - }, - "dnsName":{ - "type":"string" - }, - "kmsKeyId":{ - "type":"string" - }, - "arn":{ - "type":"string" - }, - "tags":{ - "type":"array", - "items":{ - "type":"string" - } - }, - "deploymentType":{ - "type":"string" - }, - "endpointIpAddressRange":{ - "type":"string" - }, - "endpoints":{ - "type":"object" - }, - "minimumSsdIops":{ - "type":"number" - }, - "preferredSubnetId":{ - "type":"string" - }, - "routeTableIds":{ - "type":"array", - "items":{ - "type":"string" - } - }, - "throughputCapacity":{ - "type":"number" - }, - "administrativeActions":{ - "type":"object" - }, - "diskIopsConfiguration":{ - "type":"object" - } - }, - "required":[ - "id", - "accountId", - "lifecycle", - "failureDetails", - "storageType", - "storageCapacity", - "vpcId", - "subnetIds", - "networkInterfaceIds", - "dnsName", - "kmsKeyId", - "arn", - "tags", - "deploymentType", - "endpointIpAddressRange", - "endpoints", - "minimumSsdIops", - "preferredSubnetId", - "routeTableIds", - "throughputCapacity", - "administrativeActions", - "diskIopsConfiguration" - ] - }, - "DiskIopsConfigurationSchema":{ - "type":"object", - "properties":{ - "Mode":{ - "type":"string", - "enum":[ - "AUTOMATIC", - "USER_PROVISIONED" - ] - }, - "Iops":{ - "type":"number" - } - } - }, - "UpdateFileSystemDto":{ - "type":"object", - "properties":{ - "throughputCapacity":{ - "type":"number", - "enum":[ - 128, - 256, - 512, - 1024, - 2048 - ] - }, - "diskIopsConfiguration":{ - "$ref":"#/components/schemas/DiskIopsConfigurationSchema" - }, - "storageCapacity":{ - "type":"number" - } - } - }, - "VpcResponse":{ - "type":"object", - "properties":{ - "vpcId":{ - "type":"string" - }, - "state":{ - "type":"string" - }, - "cidrBlock":{ - "type":"string" - }, - "tags":{ - "type":"array", - "items":{ - "type":"string" - } - }, - "default":{ - "type":"boolean" - }, - "subnets":{ - "type":"array", - "items":{ - "type":"string" - } - }, - "securityGroups":{ - "type":"array", - "items":{ - "type":"string" - } - }, - "tenancy":{ - "type":"string" - } - }, - "required":[ - "vpcId", - "state", - "cidrBlock", - "tags", - "default", - "subnets", - "securityGroups", - "tenancy" - ] - }, - "RouteTableResponse":{ - "type":"object", - "properties":{ - "id":{ - "type":"object" - }, - "vpcId":{ - "type":"object" - }, - "associations":{ - "type":"object" - }, - "tags":{ - "type":"object" - }, - "isMainTable":{ - "type":"object" - }, - "routes":{ - "type":"object" - }, - "subnets":{ - "type":"object" - } - }, - "required":[ - "id", - "vpcId", - "associations", - "tags", - "isMainTable", - "routes", - "subnets" - ] - }, - "EncryptionKeyResponse":{ - "type":"object", - "properties":{ - "alias":{ - "type":"object" - }, - "keyId":{ - "type":"string" - }, - "keyArn":{ - "type":"string" - }, - "validTo":{ - "type":"number" - }, - "origin":{ - "type":"string" - }, - "status":{ - "type":"string" - } - }, - "required":[ - "alias", - "keyId", - "keyArn", - "validTo", - "origin", - "status" - ] - }, - "AwsFsxRegion":{ - "type":"object", - "properties":{ - - } - } - } - }, - "paths":{ - "/aws-credentials/{accountId}":{ - "get":{ - "operationId":"AwsCredentialsController_getAllAwsCredentialsByAccount", - "summary":"", - "description":"Retrieves all the AWS credentials for a specific tenancy account.\n
    \n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"x-simulator", - "in":"header", - "schema":{ - "enum":[ - "true", - "false" - ], - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - } - ], - "responses":{ - "200":{ - "description":"", - "content":{ - "application/json":{ - "schema":{ - "type":"array", - "items":{ - "$ref":"#/components/schemas/AwsCredentialsDetails" - } - } - } - } - } - }, - "tags":[ - "AWS Credentials" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - }, - "post":{ - "operationId":"AwsCredentialsController_addAwsCredentials", - "summary":"", - "description":"DEPRECATED Create AWS Credentials
    \n

    Token usage: Cloud Manager user token.

    ", - "deprecated":true, - "parameters":[ - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"x-simulator", - "in":"header", - "schema":{ - "enum":[ - "true", - "false" - ], - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - } - ], - "requestBody":{ - "required":true, - "content":{ - "application/json":{ - "schema":{ - "$ref":"#/components/schemas/AddAwsCredentialsRequest" - } - } - } - }, - "responses":{ - "410":{ - "description":"" - } - }, - "tags":[ - "AWS Credentials" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - }, - "/working-environments/{accountId}":{ - "get":{ - "operationId":"WorkingEnvironmentsController_getWorkingEnvironments", - "summary":"", - "description":"Retrieves all working environments of a Cloud Volumes ONTAP instance for a specified account.\n
    You can filter by a specified workspace ID. Pass provider-details parameter to retrieve provider data. \n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - }, - { - "name":"workspace-id", - "required":false, - "in":"query", - "schema":{ - "type":"string" - } - }, - { - "name":"provider-details", - "required":false, - "in":"query", - "schema":{ - "enum":[ - "true", - "false" - ], - "type":"string" - } - } - ], - "responses":{ - "200":{ - "description":"", - "content":{ - "application/json":{ - "schema":{ - "type":"array", - "items":{ - "$ref":"#/components/schemas/WorkingEnvironmentResponse" - } - } - } - } - } - }, - "tags":[ - "Working Environments" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - }, - "post":{ - "operationId":"WorkingEnvironmentsController_createFileSystem", - "summary":"", - "description":"Creates an FSx ONTAP working environment on the required AWS account and region.\n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - } - ], - "requestBody":{ - "required":true, - "content":{ - "application/json":{ - "schema":{ - "$ref":"#/components/schemas/CreateFileSystemDto" - } - } - } - }, - "responses":{ - "201":{ - "description":"", - "content":{ - "application/json":{ - "schema":{ - "$ref":"#/components/schemas/FsxOntapFileSystem" - } - } - } - } - }, - "tags":[ - "Working Environments" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - }, - "/working-environments/{accountId}/discover":{ - "get":{ - "operationId":"WorkingEnvironmentsController_discover", - "summary":"", - "description":"Discovers all FSx ONTAP working environments of an AWS region by using specified credentials.\n 'inDifferentAccount' field in response indicates that a user is already assigned to a different Tenancy account. \n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - }, - { - "name":"region", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - }, - { - "name":"workspace-id", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - }, - { - "name":"credentials-id", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - } - ], - "responses":{ - "200":{ - "description":"", - "content":{ - "application/json":{ - "schema":{ - "type":"array", - "items":{ - "$ref":"#/components/schemas/DiscoverResponse" - } - } - } - } - } - }, - "tags":[ - "Working Environments" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - }, - "/working-environments/{accountId}/{workingEnvironmentId}/volumes":{ - "get":{ - "operationId":"WorkingEnvironmentsController_getVolumes", - "summary":"", - "description":"Describes all volumes of an FSx system.\n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - }, - { - "name":"workingEnvironmentId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - } - ], - "responses":{ - "200":{ - "description":"", - "content":{ - "application/json":{ - "schema":{ - "type":"array", - "items":{ - "$ref":"#/components/schemas/ServiceVolume" - } - } - } - } - } - }, - "tags":[ - "Working Environments" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - }, - "/working-environments/{accountId}/{workingEnvironmentId}/credentials":{ - "get":{ - "operationId":"WorkingEnvironmentsController_getOntapCredentials", - "summary":"", - "description":"Retrieves the ONTAP credentials of an FSx system.\n

    Token usage: Cloud Manager service token with the following scopes: occm-access.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - }, - { - "name":"workingEnvironmentId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - } - ], - "responses":{ - "200":{ - "description":"", - "content":{ - "application/json":{ - "schema":{ - "$ref":"#/components/schemas/FsxOntapCredentialsResponse" - } - } - } - } - }, - "tags":[ - "Working Environments" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - }, - "post":{ - "operationId":"WorkingEnvironmentsController_postOntapCredentials", - "summary":"", - "description":"Creates ONTAP credentials for an FSx system to be used to communicate with an ONTAP FSx file system.\n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - }, - { - "name":"workingEnvironmentId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - } - ], - "requestBody":{ - "required":true, - "content":{ - "application/json":{ - "schema":{ - "$ref":"#/components/schemas/FsxOntapCredentialsRequest" - } - } - } - }, - "responses":{ - "201":{ - "description":"" - } - }, - "tags":[ - "Working Environments" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - }, - "/working-environments/{accountId}/recover":{ - "post":{ - "operationId":"WorkingEnvironmentsController_recover", - "summary":"", - "description":"Recovers an unassigned FSx working environment related to a Tenancy account by using the `fsx:assigned` parameter.\n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - } - ], - "requestBody":{ - "required":true, - "content":{ - "application/json":{ - "schema":{ - "$ref":"#/components/schemas/RecoverRequestBody" - } - } - } - }, - "responses":{ - "201":{ - "description":"" - } - }, - "tags":[ - "Working Environments" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - }, - "/working-environments/{accountId}/{workingEnvironmentId}":{ - "get":{ - "operationId":"WorkingEnvironmentsController_getWorkingEnvironment", - "summary":"", - "description":"Retrieves FSx working environments by specifying the workingEnvironmentId parameter.\n
    Pass provider-details:'true' parameter to get provider data. \n
    Pass `volumes:'true'` parameter to retrieve volumes. \n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - }, - { - "name":"workingEnvironmentId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - }, - { - "name":"volumes", - "required":false, - "in":"query", - "schema":{ - "enum":[ - "true", - "false" - ], - "type":"string" - } - }, - { - "name":"provider-details", - "required":false, - "in":"query", - "schema":{ - "enum":[ - "true", - "false" - ], - "type":"string" - } - } - ], - "responses":{ - "200":{ - "description":"", - "content":{ - "application/json":{ - "schema":{ - "$ref":"#/components/schemas/WorkingEnvironmentResponse" - } - } - } - } - }, - "tags":[ - "Working Environments" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - }, - "delete":{ - "operationId":"WorkingEnvironmentsController_deleteFileSystem", - "summary":"", - "description":"Deletes an FSx ONTAP working environment.\n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - }, - { - "name":"workingEnvironmentId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - } - ], - "responses":{ - "200":{ - "description":"" - } - }, - "tags":[ - "Working Environments" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - }, - "/working-environments/{accountId}/{workingEnvironmentId}/workspace/{workspaceId}":{ - "delete":{ - "operationId":"WorkingEnvironmentsController_removeWEFromWorkspace", - "summary":"", - "description":"Removes working environments from a workspace.\n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - }, - { - "name":"workingEnvironmentId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - }, - { - "name":"workspaceId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - } - ], - "responses":{ - "200":{ - "description":"" - } - }, - "tags":[ - "Working Environments" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - }, - "/working-environments/{accountId}/{fileSystemId}":{ - "patch":{ - "operationId":"WorkingEnvironmentsController_updateFileSystem", - "summary":"", - "description":"Updates the throughput capacity of an FSx for ONTAP working environment.", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"fileSystemId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - } - ], - "requestBody":{ - "required":true, - "content":{ - "application/json":{ - "schema":{ - "$ref":"#/components/schemas/UpdateFileSystemDto" - } - } - } - }, - "responses":{ - "200":{ - "description":"", - "content":{ - "application/json":{ - "schema":{ - "$ref":"#/components/schemas/FsxOntapFileSystem" - } - } - } - } - }, - "tags":[ - "Working Environments" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - }, - "/aws/vpcs":{ - "get":{ - "operationId":"AwsOperationsController_getVpcs", - "summary":"", - "description":"Retrieves all VPCs by region by using the credentials.\n
    \n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"region", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - }, - { - "name":"account-id", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - }, - { - "name":"credentials-id", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - } - ], - "responses":{ - "200":{ - "description":"", - "content":{ - "application/json":{ - "schema":{ - "type":"array", - "items":{ - "$ref":"#/components/schemas/VpcResponse" - } - } - } - } - } - }, - "tags":[ - "AWS Operations" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - }, - "/aws/route-tables":{ - "get":{ - "operationId":"AwsOperationsController_getRouteTables", - "summary":"", - "description":"Retrieves all route tables for a specified region and VPC by using the credentials.\n
    \n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"vpc-id", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - }, - { - "name":"region", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - }, - { - "name":"account-id", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - }, - { - "name":"credentials-id", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - } - ], - "responses":{ - "200":{ - "description":"", - "content":{ - "application/json":{ - "schema":{ - "type":"array", - "items":{ - "$ref":"#/components/schemas/RouteTableResponse" - } - } - } - } - } - }, - "tags":[ - "AWS Operations" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - }, - "/aws/encryption-keys":{ - "get":{ - "operationId":"AwsOperationsController_getEncryptionKeys", - "summary":"", - "description":"Retrieves all encryption keys for a specified region and VPC by using the credentials.\n
    \n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"region", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - }, - { - "name":"account-id", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - }, - { - "name":"credentials-id", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - } - ], - "responses":{ - "200":{ - "description":"", - "content":{ - "application/json":{ - "schema":{ - "type":"array", - "items":{ - "$ref":"#/components/schemas/EncryptionKeyResponse" - } - } - } - } - } - }, - "tags":[ - "AWS Operations" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - }, - "/aws/supported-regions":{ - "get":{ - "operationId":"AwsOperationsController_getSupportedRegions", - "summary":"", - "description":"Retrieves all supported FSx regions by using the provided credentials.\n
    \n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"account-id", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - }, - { - "name":"credentials-id", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - }, - { - "name":"isGov", - "required":true, - "in":"query", - "schema":{ - "type":"boolean" - } - } - ], - "responses":{ - "200":{ - "description":"", - "content":{ - "application/json":{ - "schema":{ - "type":"array", - "items":{ - "$ref":"#/components/schemas/AwsFsxRegion" - } - } - } - } - } - }, - "tags":[ - "AWS Operations" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - }, - "/discovery/{accountId}/discover":{ - "get":{ - "operationId":"DiscoveryController_discover", - "summary":"", - "description":"Discovers all FSx ONTAP file systems. All the relevant AWS regions will be scanned during this operation. \n

    Token usage: Cloud Manager user token.

    ", - "parameters":[ - { - "name":"x-simulator", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"X-Service-Request-Id", - "in":"header", - "schema":{ - "type":"string" - } - }, - { - "name":"accountId", - "required":true, - "in":"path", - "schema":{ - "type":"string" - } - }, - { - "name":"workspace-id", - "required":true, - "in":"query", - "schema":{ - "type":"string" - } - } - ], - "responses":{ - "200":{ - "description":"", - "content":{ - "application/json":{ - "schema":{ - "$ref":"#/components/schemas/DiscoverResponse" - } - } - } - } - }, - "tags":[ - "FSx ONTAP discovery" - ], - "security":[ - { - "bearer":[ - - ] - } - ] - } - } - } -} \ No newline at end of file diff --git a/fsx/fsx_ontap_discovery_overview.adoc b/fsx/fsx_ontap_discovery_overview.adoc new file mode 100644 index 00000000..2cb098ba --- /dev/null +++ b/fsx/fsx_ontap_discovery_overview.adoc @@ -0,0 +1,19 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/fsx_ontap_discovery_overview.html' +summary: 'FSx ONTAP discovery endpoints in the Amazon FSx for NetApp ONTAP management REST API' +--- + += FSx ONTAP discovery endpoints in the Amazon FSx for NetApp ONTAP management REST API + + + ++++
    +++The discovery endpoints provide an API for discovering FSx ONTAP systems for a specified account in Cloud Manager. + +You can perform the following actions with the discovery endpoints: + +* Discover an FSx for ONTAP an account+++
    +++ + + diff --git a/fsx/get-aws-credentials-.adoc b/fsx/get-aws-credentials-.adoc new file mode 100644 index 00000000..c93fe665 --- /dev/null +++ b/fsx/get-aws-credentials-.adoc @@ -0,0 +1,55 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/get-aws-credentials-.html' +summary: 'Retrieve AWS credentials' +--- + += Retrieve AWS credentials + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws-credentials/{accountId}`# + + + +Retrieves all the AWS credentials for a specific tenancy account. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|X-Service-Request-Id +|string +|header +|False +a| + +|x-simulator +|string +|header +|False +a| + +|accountId +|string +|path +|True +a| + +|=== + +== Response + +``` +Status: 200, +``` + diff --git a/fsx/get-aws-encryption-keys.adoc b/fsx/get-aws-encryption-keys.adoc new file mode 100644 index 00000000..6ca078f3 --- /dev/null +++ b/fsx/get-aws-encryption-keys.adoc @@ -0,0 +1,122 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/get-aws-encryption-keys.html' +summary: 'Retrieve encryption keys' +--- + += Retrieve encryption keys + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/encryption-keys`# + + + +Retrieves all encryption keys for a specified region and VPC by using the credentials. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|region +|string +|query +|True +a| + +|account-id +|string +|query +|True +a| + +|credentials-id +|string +|query +|True +a| + +|=== + +== Response + +``` +Status: 200, +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|alias +|link:#alias[alias] +|True +a| + +|keyId +|string +|True +a| + +|keyArn +|string +|True +a| + +|validTo +|number +|True +a| + +|origin +|string +|True +a| + +|status +|string +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#alias] +[.api-collapsible-fifth-title] +alias + + +//end collapsible .Definitions block +==== diff --git a/fsx/get-aws-route-tables.adoc b/fsx/get-aws-route-tables.adoc new file mode 100644 index 00000000..1aa01d52 --- /dev/null +++ b/fsx/get-aws-route-tables.adoc @@ -0,0 +1,163 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/get-aws-route-tables.html' +summary: 'Retrieve route tables' +--- + += Retrieve route tables + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/route-tables`# + + + +Retrieves all route tables for a specified region and VPC by using the credentials. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|vpc-id +|string +|query +|True +a| + +|region +|string +|query +|True +a| + +|account-id +|string +|query +|True +a| + +|credentials-id +|string +|query +|True +a| + +|=== + +== Response + +``` +Status: 200, +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|link:#id[id] +|True +a| + +|vpcId +|link:#vpcId[vpcId] +|True +a| + +|associations +|link:#associations[associations] +|True +a| + +|tags +|link:#tags[tags] +|True +a| + +|isMainTable +|link:#isMainTable[isMainTable] +|True +a| + +|routes +|link:#routes[routes] +|True +a| + +|subnets +|link:#subnets[subnets] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#id] +[.api-collapsible-fifth-title] +id + + +[#vpcId] +[.api-collapsible-fifth-title] +vpcId + + +[#associations] +[.api-collapsible-fifth-title] +associations + + +[#tags] +[.api-collapsible-fifth-title] +tags + + +[#isMainTable] +[.api-collapsible-fifth-title] +isMainTable + + +[#routes] +[.api-collapsible-fifth-title] +routes + + +[#subnets] +[.api-collapsible-fifth-title] +subnets + + +//end collapsible .Definitions block +==== diff --git a/fsx/get-aws-supported-regions.adoc b/fsx/get-aws-supported-regions.adoc new file mode 100644 index 00000000..e6fef723 --- /dev/null +++ b/fsx/get-aws-supported-regions.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/get-aws-supported-regions.html' +summary: 'Retrieve supported regions' +--- + += Retrieve supported regions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/supported-regions`# + + + +Retrieves all supported FSx regions by using the provided credentials. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|account-id +|string +|query +|True +a| + +|credentials-id +|string +|query +|True +a| + +|isGov +|boolean +|query +|True +a| + +|=== + +== Response + +``` +Status: 200, +``` + diff --git a/fsx/get-aws-vpcs.adoc b/fsx/get-aws-vpcs.adoc new file mode 100644 index 00000000..afb2ef9d --- /dev/null +++ b/fsx/get-aws-vpcs.adoc @@ -0,0 +1,118 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/get-aws-vpcs.html' +summary: 'Retrieve VPCs' +--- + += Retrieve VPCs + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/aws/vpcs`# + + + +Retrieves all VPCs by region by using the credentials. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|region +|string +|query +|True +a| + +|account-id +|string +|query +|True +a| + +|credentials-id +|string +|query +|True +a| + +|=== + +== Response + +``` +Status: 200, +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|vpcId +|string +|True +a| + +|state +|string +|True +a| + +|cidrBlock +|string +|True +a| + +|tags +|array[string] +|True +a| + +|default +|boolean +|True +a| + +|subnets +|array[string] +|True +a| + +|securityGroups +|array[string] +|True +a| + +|tenancy +|string +|True +a| + +|=== + + diff --git a/fsx/get-discovery-discover.adoc b/fsx/get-discovery-discover.adoc new file mode 100644 index 00000000..35cacce3 --- /dev/null +++ b/fsx/get-discovery-discover.adoc @@ -0,0 +1,61 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/get-discovery-discover.html' +summary: 'Discover FSx ONTAP systems' +--- + += Discover FSx ONTAP systems + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/discovery/{accountId}/discover`# + + + +Discovers all FSx ONTAP file systems. All the relevant AWS regions will be scanned during this operation. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|accountId +|string +|path +|True +a| + +|workspace-id +|string +|query +|True +a| + +|=== + +== Response + +``` +Status: 200, +``` + diff --git a/fsx/get-working-environments--credentials.adoc b/fsx/get-working-environments--credentials.adoc new file mode 100644 index 00000000..9b58ad3e --- /dev/null +++ b/fsx/get-working-environments--credentials.adoc @@ -0,0 +1,128 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/get-working-environments--credentials.html' +summary: 'Retrieve ONTAP credentials' +--- + += Retrieve ONTAP credentials + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/working-environments/{accountId}/{workingEnvironmentId}/credentials`# + + + +Retrieves the ONTAP credentials of an FSx system. + +**Token usage:** Cloud Manager service token with the following scopes: occm-access. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Response + +``` +Status: 200, +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|credentials +|link:#FsxOntapCredentials[FsxOntapCredentials] +|True +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "credentials": { + "ip": "string", + "userName": "string", + "password": "string" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#FsxOntapCredentials] +[.api-collapsible-fifth-title] +FsxOntapCredentials + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ip +|string +|True +a| + +|userName +|string +|True +a| + +|password +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/fsx/get-working-environments--volumes.adoc b/fsx/get-working-environments--volumes.adoc new file mode 100644 index 00000000..9dbaad54 --- /dev/null +++ b/fsx/get-working-environments--volumes.adoc @@ -0,0 +1,166 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/get-working-environments--volumes.html' +summary: 'Retrieve volumes' +--- + += Retrieve volumes + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/working-environments/{accountId}/{workingEnvironmentId}/volumes`# + + + +Describes all volumes of an FSx system. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Response + +``` +Status: 200, +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|endpoints +|link:#endpoints[endpoints] +|True +a| + +|lifecycle +|string +|True +a| + +|name +|string +|True +a| + +|junctionPath +|string +|True +a| + +|sizeInMegabytes +|number +|True +a| + +|state +|string +|True +a| + +|storageEfficiency +|boolean +|True +a| + +|svmId +|string +|True +a| + +|tieringPolicy +|link:#tieringPolicy[tieringPolicy] +|True +a| + +|uuid +|string +|True +a| + +|arn +|string +|True +a| + +|tags +|array[string] +|True +a| + +|volumeType +|string +|True +a| + +|ontapVolumeType +|string +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#endpoints] +[.api-collapsible-fifth-title] +endpoints + + +[#tieringPolicy] +[.api-collapsible-fifth-title] +tieringPolicy + + +//end collapsible .Definitions block +==== diff --git a/fsx/get-working-environments-.adoc b/fsx/get-working-environments-.adoc new file mode 100644 index 00000000..c5ee35fd --- /dev/null +++ b/fsx/get-working-environments-.adoc @@ -0,0 +1,123 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/get-working-environments-.html' +summary: 'Retrieve working environments' +--- + += Retrieve working environments + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/working-environments/{accountId}`# + + + +Retrieves all working environments of a Cloud Volumes ONTAP instance for a specified account. + You can filter by a specified workspace ID. Pass provider-details parameter to retrieve provider data. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|accountId +|string +|path +|True +a| + +|workspace-id +|string +|query +|False +a| + +|provider-details +|string +|query +|False +a| + +|=== + +== Response + +``` +Status: 200, +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|name +|string +|True +a| + +|region +|string +|True +a| + +|deploymentType +|string +|True +a| + +|providerDetails +|link:#providerDetails[providerDetails] +|True +a| + +|volumes +|array[string] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#providerDetails] +[.api-collapsible-fifth-title] +providerDetails + + +//end collapsible .Definitions block +==== diff --git a/fsx/get-working-environments-discover.adoc b/fsx/get-working-environments-discover.adoc new file mode 100644 index 00000000..19148ed0 --- /dev/null +++ b/fsx/get-working-environments-discover.adoc @@ -0,0 +1,74 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/get-working-environments-discover.html' +summary: 'Discover working environments' +--- + += Discover working environments + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/working-environments/{accountId}/discover`# + + + +Discovers all FSx ONTAP working environments of an AWS region by using specified credentials. + 'inDifferentAccount' field in response indicates that a user is already assigned to a different Tenancy account. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|accountId +|string +|path +|True +a| + +|region +|string +|query +|True +a| + +|workspace-id +|string +|query +|True +a| + +|credentials-id +|string +|query +|True +a| + +|=== + +== Response + +``` +Status: 200, +``` + diff --git a/fsx/get-working-environments-id-.adoc b/fsx/get-working-environments-id-.adoc new file mode 100644 index 00000000..5f7ee9a6 --- /dev/null +++ b/fsx/get-working-environments-id-.adoc @@ -0,0 +1,130 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/get-working-environments-id-.html' +summary: 'Retrieve working environments by account' +--- + += Retrieve working environments by account + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/working-environments/{accountId}/{workingEnvironmentId}`# + + + +Retrieves FSx working environments by specifying the workingEnvironmentId parameter. + Pass provider-details:'true' parameter to get provider data. + Pass `volumes:'true'` parameter to retrieve volumes. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|volumes +|string +|query +|False +a| + +|provider-details +|string +|query +|False +a| + +|=== + +== Response + +``` +Status: 200, +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|name +|string +|True +a| + +|region +|string +|True +a| + +|deploymentType +|string +|True +a| + +|providerDetails +|link:#providerDetails[providerDetails] +|True +a| + +|volumes +|array[string] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#providerDetails] +[.api-collapsible-fifth-title] +providerDetails + + +//end collapsible .Definitions block +==== diff --git a/fsx/overview.adoc b/fsx/overview.adoc new file mode 100644 index 00000000..c702c153 --- /dev/null +++ b/fsx/overview.adoc @@ -0,0 +1,153 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/overview.html' +summary: 'Amazon FSx for NetApp ONTAP management REST API' +--- + += Amazon FSx for NetApp ONTAP management REST API + + + +Amazon FSx for NetApp ONTAP is a Cloud Manager service that enables you to create, operate, and delete Amazon FSx storage facilities for ONTAP systems. + +For more information about FSx for ONTAP, see https://docs.netapp.com/us-en/cloud-manager-fsx-ontap/index.html[Cloud Manager FSx ONTAP]. + +There are four categories of API endpoints defined within the FSx for ONTAP service: + +* AWS operations +* AWS credentials +* Working environments +* FSx ONTAP discovery + +References + +* https://docs.netapp.com/us-en/cloud-manager-fsx-ontap/start/task-getting-started-fsx.html[Quick start for FSx for ONTAP] +* https://docs.netapp.com/us-en/cloud-manager-fsx-ontap/requirements/task-setting-up-permissions-fsx.html[Permissions required to create FSx] + +''' + +== REST implementation + +=== HTTP methods + +|=== +| Method | Description + +| `POST` +| Create an object instance + +| `GET` +| Retrieve an object instance or collection + +| `PUT` +| Update specified properties of existing objects + +| `DELETE` +| Remove an existing object +|=== + +=== Request headers + +|=== +| Request Header | Description + +| `Authorization` +| Required. Contains a JWT access token + +| `X-Service-Request-Id` +| Request ID to use in logs + +| `x-simulator` +| Indicates whether this API call is simulated or real +|=== + +=== Query parameters + +You can use query parameters with endpoints in the following components: + +|=== +| Component | Query Parameter + +| `isGov` +| - Used to decide whether FSx storage is located in the governed location + +| `region` +| - The API will be executed in the specified region + +| `workspace-id` +| - The Cloud Manager workspace +|=== + +==== Path parameters + +You can use path parameters with endpoints. + +|=== +| Component | Query Parameter + +| `account-id` +| Tenancy account ID for this API + +| `workingEnvironmentId` +| FSx working environment ID used to execute this API +|=== + +=== Response headers + +This API uses the standard HTTP response headers common with all Cloud Manager APIs. See https://docs.netapp.com/us-en/console-automation/platform/concepts.html[REST implementation] for more information. + +=== HTTP status codes + +|=== +| HTTP Status Code | Description + +| `200` +| OK: Returned for successful operation completion + +| `400` +| Bad Request: Returned if the input is malformed and could not be parsed + +| `401` +| Unauthorized: Returned if user authentication failed or the token has expired + +| `403` +| Forbidden: Returned for authorization errors depending on the resource and token + +| `404` +| Not Found: Returned if the requested resource could not be found + +| `500` +| Processing Error: Returned if an error occurs on the server while processing the API call +|=== + +''' + +== Error handling + +There are three processes involved with error handling and processing: + +* The error is logged for supportability +* The error is returned to the caller for specific handling +* The database connection is rolled back + +''' + +== cURL examples + +=== Retrieve FSx working environments for a specified account ID + +This cURL example retrieves FSx working environments for a specified account ID. + +.... + + curl -X GET "https://staging.cloudmanager.cloud.netapp.com/fsx-ontap/working-environments/" + -H "accept: application/json" -H "authorization: " +.... + +''' + +{blank} + + + + + diff --git a/fsx/patch-working-environments-.adoc b/fsx/patch-working-environments-.adoc new file mode 100644 index 00000000..7df1320f --- /dev/null +++ b/fsx/patch-working-environments-.adoc @@ -0,0 +1,269 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/patch-working-environments-.html' +summary: 'Update FSx ONTAP systems' +--- + += Update FSx ONTAP systems + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/working-environments/{accountId}/{fileSystemId}`# + + + +Updates the throughput capacity of an FSx for ONTAP working environment. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|fileSystemId +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|throughputCapacity +|number +|False +a| + +|diskIopsConfiguration +|link:#DiskIopsConfigurationSchema[DiskIopsConfigurationSchema] +|False +a| + +|storageCapacity +|number +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "throughputCapacity": 128, + "diskIopsConfiguration": { + "Mode": "string" + } +} +==== + +== Response + +``` +Status: 200, +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|accountId +|string +|True +a| + +|lifecycle +|string +|True +a| + +|failureDetails +|string +|True +a| + +|storageType +|string +|True +a| + +|storageCapacity +|number +|True +a| + +|vpcId +|string +|True +a| + +|subnetIds +|array[string] +|True +a| + +|networkInterfaceIds +|array[string] +|True +a| + +|dnsName +|string +|True +a| + +|kmsKeyId +|string +|True +a| + +|arn +|string +|True +a| + +|tags +|array[string] +|True +a| + +|deploymentType +|string +|True +a| + +|endpointIpAddressRange +|string +|True +a| + +|endpoints +|link:#endpoints[endpoints] +|True +a| + +|minimumSsdIops +|number +|True +a| + +|preferredSubnetId +|string +|True +a| + +|routeTableIds +|array[string] +|True +a| + +|throughputCapacity +|number +|True +a| + +|administrativeActions +|link:#administrativeActions[administrativeActions] +|True +a| + +|diskIopsConfiguration +|link:#diskIopsConfiguration[diskIopsConfiguration] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#DiskIopsConfigurationSchema] +[.api-collapsible-fifth-title] +DiskIopsConfigurationSchema + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|Mode +|string +|False +a| + +|Iops +|number +|False +a| + +|=== + + +[#endpoints] +[.api-collapsible-fifth-title] +endpoints + + +[#administrativeActions] +[.api-collapsible-fifth-title] +administrativeActions + + +[#diskIopsConfiguration] +[.api-collapsible-fifth-title] +diskIopsConfiguration + + +//end collapsible .Definitions block +==== diff --git a/fsx/post-aws-credentials-.adoc b/fsx/post-aws-credentials-.adoc new file mode 100644 index 00000000..e9c18f74 --- /dev/null +++ b/fsx/post-aws-credentials-.adoc @@ -0,0 +1,98 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/post-aws-credentials-.html' +summary: 'Add AWS credentials' +--- + += Add AWS credentials + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/aws-credentials/{accountId}`# + + + +DEPRECATED Create AWS Credentials + +**Token usage:** Cloud Manager user token. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|X-Service-Request-Id +|string +|header +|False +a| + +|x-simulator +|string +|header +|False +a| + +|accountId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accessKey +|string +|True +a| + +|secretKey +|string +|True +a| + +|name +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accessKey": "string", + "secretKey": "string", + "name": "string" +} +==== + +== Error + +``` +Status: 410, +``` + diff --git a/fsx/post-working-environments--credentials.adoc b/fsx/post-working-environments--credentials.adoc new file mode 100644 index 00000000..4fca9412 --- /dev/null +++ b/fsx/post-working-environments--credentials.adoc @@ -0,0 +1,89 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/post-working-environments--credentials.html' +summary: 'Create ONTAP credentials' +--- + += Create ONTAP credentials + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/working-environments/{accountId}/{workingEnvironmentId}/credentials`# + + + +Creates ONTAP credentials for an FSx system to be used to communicate with an ONTAP FSx file system. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|accountId +|string +|path +|True +a| + +|workingEnvironmentId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|password +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "password": "string" +} +==== + +== Response + +``` +Status: 201, +``` + diff --git a/fsx/post-working-environments-.adoc b/fsx/post-working-environments-.adoc new file mode 100644 index 00000000..1f053e2f --- /dev/null +++ b/fsx/post-working-environments-.adoc @@ -0,0 +1,304 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/post-working-environments-.html' +summary: 'Create FSx for ONTAP working environments' +--- + += Create FSx for ONTAP working environments + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/working-environments/{accountId}`# + + + +Creates an FSx ONTAP working environment on the required AWS account and region. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|accountId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|credentialsId +|string +|True +a| + +|region +|string +|True +a| + +|workspaceId +|string +|True +a| + +|storageCapacity +|link:#storageCapacity[storageCapacity] +|True +a| + +|primarySubnetId +|string +|True +a| + +|throughputCapacity +|number +|True +a| + +|fsxAdminPassword +|string +|True +a| + +|deploymentType +|string +|True +a| + +|secondarySubnetId +|string +|False +a| + +|securityGroupIds +|array[string] +|False +a| + +|tags +|array[string] +|False +a| + +|kmsKeyId +|string +|False +a| + +|endpointIpAddressRange +|string +|False +a| + +|svmAdminPassword +|string +|False +a| + +|minimumSsdIops +|number +|False +a| + +|routeTableIds +|array[string] +|False +a| + +|=== + + +== Response + +``` +Status: 201, +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|True +a| + +|accountId +|string +|True +a| + +|lifecycle +|string +|True +a| + +|failureDetails +|string +|True +a| + +|storageType +|string +|True +a| + +|storageCapacity +|number +|True +a| + +|vpcId +|string +|True +a| + +|subnetIds +|array[string] +|True +a| + +|networkInterfaceIds +|array[string] +|True +a| + +|dnsName +|string +|True +a| + +|kmsKeyId +|string +|True +a| + +|arn +|string +|True +a| + +|tags +|array[string] +|True +a| + +|deploymentType +|string +|True +a| + +|endpointIpAddressRange +|string +|True +a| + +|endpoints +|link:#endpoints[endpoints] +|True +a| + +|minimumSsdIops +|number +|True +a| + +|preferredSubnetId +|string +|True +a| + +|routeTableIds +|array[string] +|True +a| + +|throughputCapacity +|number +|True +a| + +|administrativeActions +|link:#administrativeActions[administrativeActions] +|True +a| + +|diskIopsConfiguration +|link:#diskIopsConfiguration[diskIopsConfiguration] +|True +a| + +|=== + + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#storageCapacity] +[.api-collapsible-fifth-title] +storageCapacity + + +[#endpoints] +[.api-collapsible-fifth-title] +endpoints + + +[#administrativeActions] +[.api-collapsible-fifth-title] +administrativeActions + + +[#diskIopsConfiguration] +[.api-collapsible-fifth-title] +diskIopsConfiguration + + +//end collapsible .Definitions block +==== diff --git a/fsx/post-working-environments-recover.adoc b/fsx/post-working-environments-recover.adoc new file mode 100644 index 00000000..62f5a546 --- /dev/null +++ b/fsx/post-working-environments-recover.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/post-working-environments-recover.html' +summary: 'Recover working environments' +--- + += Recover working environments + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/working-environments/{accountId}/recover`# + + + +Recovers an unassigned FSx working environment related to a Tenancy account by using the `fsx:assigned` parameter. + +**Token usage:** Cloud Manager user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|x-simulator +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| + +|accountId +|string +|path +|True +a| + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workspaceId +|string +|True +a| + +|credentialsId +|string +|True +a| + +|region +|string +|True +a| + +|fileSystemId +|string +|True +a| + +|name +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "workspaceId": "string", + "credentialsId": "string", + "region": "string", + "fileSystemId": "string", + "name": "string" +} +==== + +== Response + +``` +Status: 201, +``` + diff --git a/fsx/sidebar.yml b/fsx/sidebar.yml deleted file mode 100644 index d83c8114..00000000 --- a/fsx/sidebar.yml +++ /dev/null @@ -1,3 +0,0 @@ -section: fsx -title: Amazon FSx for NetApp ONTAP management -generate: fsx diff --git a/fsx/working_environments_overview.adoc b/fsx/working_environments_overview.adoc new file mode 100644 index 00000000..58e01a1f --- /dev/null +++ b/fsx/working_environments_overview.adoc @@ -0,0 +1,19 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'fsx/working_environments_overview.html' +summary: 'Working environments endpoints in the Amazon FSx for NetApp ONTAP management REST API' +--- + += Working environments endpoints in the Amazon FSx for NetApp ONTAP management REST API + + + ++++
    +++The working environment endpoints manage operations made on working environments in Cloud Manager. + +You can perform the following actions with the working environment endpoints: + +* Create an FSx for ONTAP working environment * Retrieve FSx for ONTAP working environments by account * Discover an FSx for ONTAP working environment * Retrieve volume details for an FSx for ONTAP working environment * Retrieve ONTAP credentials for an FSx for ONTAP working environment * Create ONTAP credentials for an FSx for ONTAP working environment * Recover FSx for ONTAP as a working environment * Retrieve details for an FSx for ONTAP working environment * Delete an FSx for ONTAP working environment * Remove an FSx for ONTAP working environment from a workspace * Update the throughput capacity of an FSx for ONTAP working environment+++
    +++ + + diff --git a/index.adoc b/index.adoc new file mode 100644 index 00000000..65be93b6 --- /dev/null +++ b/index.adoc @@ -0,0 +1,91 @@ +--- +permalink: index.html +sidebar: sidebar +layout: landing-page +indexpage: + tiles: + - title: Get started + links: + - title: NetApp Console control plane + url: "/platform/overview.html" + - title: Common REST implementation + url: "/platform/concepts.html" + - title: Workflow processes and tasks + url: "/platform/workflows_tasks.html" + - title: Authentication and authorization + url: "/platform/aa_concepts.html" + - title: NetApp Console common workflows and tasks + url: "/platform/get_identifiers.html" + - title: Storage services + links: + - title: ONTAP management - Cloud Volumes ONTAP + url: "/cm/overview.html#cloud-volumes-ontap-operations" + - title: ONTAP management - On-premises ONTAP + url: "/cm/overview.html#cloud-volumes-ontap-operations" + - title: Amazon FSx for NetApp ONTAP management + url: "/fsx/overview.html" + - title: ONTAP management workflows + links: + - title: Cloud Volumes ONTAP typical deployment + url: "/cm/cvo_deployment.html" + - title: Cloud Volumes ONTAP AWS workflows + url: "/cm/wf_aws_cloud_create_we_capacity.html" + - title: Cloud Volumes ONTAP Azure workflows + url: "/cm/wf_azure_cloud_create_we_capacity.html" + - title: Cloud Volumes ONTAP Google Cloud workflows + url: "/cm/wf_gcp_cloud_create_we_capacity.html" + - title: On-premises ONTAP workflows + url: "/cm/wf_onprem_before.html" + - title: Common workflows + url: "/cm/wf_common_before.html" + - title: Platform services + links: + - title: Accounts (tenancy) + url: "/tenancy/overview.html" + - title: Audit + url: "/audit/overview.html" + - title: Backup and Recovery + url: "/cbs/overview.html" + - title: Copy and Sync + url: "/copysync/overview.html" + - title: Credentials + url: "/credential/overview.html" + - title: Licenses and subscriptions + url: "/dw/overview.html" + - title: Federation + url: "/federation/overview.html" + - title: IPA + url: "/ipa/overview.html" + - title: Identity and access management + url: "/tenancyv4/overview.html" + - title: More resources + links: + - title: NetApp Console solutions + url: https://www.netapp.com/cloud-services/ + - title: NetApp Console automation hub + url: https://docs.netapp.com/us-en/netapp-automation/solutions/bac-overview.html + - title: ONTAP 9 documentation + url: https://docs.netapp.com/us-en/ontap/ + - title: Additional resources + url: "/support/additional_resources.html" +lead: The NetApp Console provides centralized management of NetApp storage and data + services across on-premises and cloud environments at enterprise grade. It delivers + real-time insights, faster workflows, and simplified administration that is highly + secure and compliant. The Console is composed of distinct services, each of which + exposes an associated REST API that enables you to automate the administration of + your cloud-based and on-premises resources. +summary: The NetApp Console provides centralized management of NetApp storage and + data services across on-premises and cloud environments at enterprise grade. It + delivers real-time insights, faster workflows, and simplified administration that + is highly secure and compliant. The Console is composed of distinct services, each + of which exposes an associated REST API that enables you to automate the administration + of your cloud-based and on-premises resources. +keywords: automation, automating, bluexp, netapp, console + +--- += NetApp Console API documentation +:hardbreaks: +:nofooter: +:icons: font +:linkattrs: +:imagesdir: ./media/ diff --git a/ipa/delete-ipa-account-nss-key-.adoc b/ipa/delete-ipa-account-nss-key-.adoc new file mode 100644 index 00000000..03113870 --- /dev/null +++ b/ipa/delete-ipa-account-nss-key-.adoc @@ -0,0 +1,103 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/delete-ipa-account-nss-key-.html' +summary: 'Delete NetApp Support Site key credentials' +--- + += Delete NetApp Support Site key credentials + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/ipa/account/{accountId}/nss-key/{nssKeyId}`# + + + +Deletes NetApp Support Site key credentials. + + + + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|nssKeyId +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/get-ipa-account-nss-key-.adoc b/ipa/get-ipa-account-nss-key-.adoc new file mode 100644 index 00000000..acf6120c --- /dev/null +++ b/ipa/get-ipa-account-nss-key-.adoc @@ -0,0 +1,152 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/get-ipa-account-nss-key-.html' +summary: 'Retrieve NetApp Support Site key credentials' +--- + += Retrieve NetApp Support Site key credentials + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/ipa/account/{accountId}/nss-key/{nssKeyId}`# + + + +Retrieves the NetApp Support Site key credentials for a specified NetApp Support Site ID. + + + + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|nssKeyId +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|username +|string +|False +a| + +|resources +|array[string] +|False +a| + +|credentialType +|string +|False +a| + +|passwordDeprecated +|boolean +|False +a| + +|status +| +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "string", + "username": "string", + "resources": [ + "string" + ], + "credentialType": "string", + "status": "EXPIRED" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/get-ipa-account-nss-key-nss-data.adoc b/ipa/get-ipa-account-nss-key-nss-data.adoc new file mode 100644 index 00000000..adb38b75 --- /dev/null +++ b/ipa/get-ipa-account-nss-key-nss-data.adoc @@ -0,0 +1,138 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/get-ipa-account-nss-key-nss-data.html' +summary: 'Retrieve NetApp Support Site data for an account and key ID' +--- + += Retrieve NetApp Support Site data for an account and key ID + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/ipa/account/{accountId}/nss-key/{nssKeyId}/nss-data`# + + + +Retrieves NetApp Support Site data associated with an account ID and NetApp Support Site key ID. + + + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|nssKeyId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|username +|string +|False +a| + +|email +|string +|False +a| + +|status +| +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "string", + "username": "string", + "email": "string", + "status": "EXPIRED" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/get-ipa-account-nss-key-resource-.adoc b/ipa/get-ipa-account-nss-key-resource-.adoc new file mode 100644 index 00000000..d1e57e73 --- /dev/null +++ b/ipa/get-ipa-account-nss-key-resource-.adoc @@ -0,0 +1,126 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/get-ipa-account-nss-key-resource-.html' +summary: 'Retrieve NetApp Support Site credentials' +--- + += Retrieve NetApp Support Site credentials + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/ipa/account/{accountId}/nss-key/resource/{resourceId}`# + + + +Retrieves NetApp Support Site credentials for a specified resource ID and validates them if the validateKey field is true. + + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|validateKey +|boolean +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|resourceId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "string" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/get-ipa-account-nss-keys.adoc b/ipa/get-ipa-account-nss-keys.adoc new file mode 100644 index 00000000..c527aee2 --- /dev/null +++ b/ipa/get-ipa-account-nss-keys.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/get-ipa-account-nss-keys.html' +summary: 'Retrieve a list of NetApp Support Site key credentials' +--- + += Retrieve a list of NetApp Support Site key credentials + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/ipa/account/{accountId}/nss-keys`# + + + +Retrieves a list of NetApp Support Site key credentials associated with an account. You can optionally choose to include the resource data associated with a NetApp Support Site ID. + + + + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|includeResources +|boolean +|query +|False +a| + +|userNss +|boolean +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/get-ipa-accounts-nss-data.adoc b/ipa/get-ipa-accounts-nss-data.adoc new file mode 100644 index 00000000..78e7fff2 --- /dev/null +++ b/ipa/get-ipa-accounts-nss-data.adoc @@ -0,0 +1,84 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/get-ipa-accounts-nss-data.html' +summary: 'Retrieve NetApp Support Site data for accounts' +--- + += Retrieve NetApp Support Site data for accounts + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/ipa/accounts/nss-data`# + + + +Retrieves NetApp Support Site data associated with the NetApp Console accounts. + + + + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/get-ipa-nss-key-access-token.adoc b/ipa/get-ipa-nss-key-access-token.adoc new file mode 100644 index 00000000..d5a73eb4 --- /dev/null +++ b/ipa/get-ipa-nss-key-access-token.adoc @@ -0,0 +1,115 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/get-ipa-nss-key-access-token.html' +summary: 'Retrieve an access token' +--- + += Retrieve an access token + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/ipa/nss-key/{nssKeyId}/access-token`# + + + +Retrieves a NetApp Support Site user B2C access token. + + + + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|nssKeyId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|access_token +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "access_token": "string" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/get-ipa-support-case-details.adoc b/ipa/get-ipa-support-case-details.adoc new file mode 100644 index 00000000..8d1a4f06 --- /dev/null +++ b/ipa/get-ipa-support-case-details.adoc @@ -0,0 +1,255 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/get-ipa-support-case-details.html' +summary: 'Retrieve support case details' +--- + += Retrieve support case details + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/ipa/support/case/{caseNumber}/details`# + + + +Retrieves support case details. + + + + +*Token usage:* Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|nssKeyId +|string +|query +|True +a| + +|accountId +|string +|query +|True +a| + +|fetchAttachments +| +|query +|False +a| + +|caseNumber +|integer +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|caseNumber +|string +|False +a| + +|priority +| +|False +a| + +|dateOpened +|string +|False +a| + +|createdBy +|string +|False +a| + +|clusterName +|string +|False +a| + +|workingEnvironment +|string +|False +a| + +|status +| +|False +a| + +|dateUpdated +|string +|False +a| + +|contractSupportOffering +|string +|False +a| + +|systemSerialNumber +|string +|False +a| + +|textDetails +|string +|False +a| + +|bugNumber +|string +|False +a| + +|symptom +|string +|False +a| + +|longSymptom +|string +|False +a| + +|attachedFiles +|array[link:#attachedFiles[attachedFiles]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "caseNumber": "string", + "priority": "Low", + "dateOpened": "string", + "createdBy": "string", + "clusterName": "string", + "workingEnvironment": "string", + "status": "Unassigned", + "dateUpdated": "string", + "contractSupportOffering": "string", + "systemSerialNumber": "string", + "textDetails": "string", + "bugNumber": "string", + "symptom": "string", + "longSymptom": "string", + "attachedFiles": [ + { + "attachmentFileName": "string", + "attachmentFileDescription": "string" + } + ] +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#attachedFiles] +[.api-collapsible-fifth-title] +attachedFiles + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|attachmentFileName +|string +|False +a| + +|attachmentFileDescription +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/ipa/get-ipa-support-case-file-upload-url.adoc b/ipa/get-ipa-support-case-file-upload-url.adoc new file mode 100644 index 00000000..11876f67 --- /dev/null +++ b/ipa/get-ipa-support-case-file-upload-url.adoc @@ -0,0 +1,133 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/get-ipa-support-case-file-upload-url.html' +summary: 'Retrieve a temporary URL for file attachment' +--- + += Retrieve a temporary URL for file attachment + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/ipa/support/case/{caseNumber}/file/{fileName}/upload-url`# + + + +Retrieves a temporary URL for uploading an attachment file. + + + + +*Token usage:* Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|nssKeyId +|string +|query +|True +a| + +|accountId +|string +|query +|True +a| + +|fileName +|string +|path +|True +a| + +|caseNumber +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uploadUrl +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "uploadUrl": "string" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/get-ipa-support-case-notes-.adoc b/ipa/get-ipa-support-case-notes-.adoc new file mode 100644 index 00000000..8e0f3d34 --- /dev/null +++ b/ipa/get-ipa-support-case-notes-.adoc @@ -0,0 +1,237 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/get-ipa-support-case-notes-.html' +summary: 'Retrieve a list of case notes' +--- + += Retrieve a list of case notes + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/ipa/support/case-notes/{caseNumber}`# + + + +Retrieves a list of case notes. + + + + +*Token usage:* Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|nssKeyId +|string +|query +|True +a| + +|accountId +|string +|query +|True +a| + +|fetchEmail +|string +|query +|False +a| + +|latestEmailInThread +|string +|query +|False +a| + +|numberOfResults +|integer +|query +|False +a| + +|offset +|integer +|query +|False +a| + +|caseNumber +|integer +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|caseNumber +|string +|False +a| + +|totalResults +|string +|False +a| + +|caseNotes +|array[link:#caseNotes[caseNotes]] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "caseNumber": "string", + "totalResults": "string", + "caseNotes": [ + { + "noteType": "string", + "transactionDescription": "string", + "transactionID": "string", + "transactionAssignedTo": "string", + "transactionStatus": "string", + "textDetails": "string", + "createdOnDateTime": "string", + "createdBy": "string" + } + ] +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#caseNotes] +[.api-collapsible-fifth-title] +caseNotes + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|noteType +|string +|False +a| + +|transactionDescription +|string +|False +a| + +|transactionID +|string +|False +a| + +|transactionAssignedTo +|string +|False +a| + +|transactionStatus +|string +|False +a| + +|textDetails +|string +|False +a| + +|createdOnDateTime +|string +|False +a| + +|createdBy +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/ipa/get-ipa-support-case-search.adoc b/ipa/get-ipa-support-case-search.adoc new file mode 100644 index 00000000..7f11184d --- /dev/null +++ b/ipa/get-ipa-support-case-search.adoc @@ -0,0 +1,294 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/get-ipa-support-case-search.html' +summary: 'Retrieve support cases' +--- + += Retrieve support cases + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/ipa/support/case-search`# + + + +Retrieves a list of support cases according to the filter parameters. + + + + +*Token usage:* Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|nssKeyId +|string +|query +|True +a| + +|accountId +|string +|query +|True +a| + +|numberOfResults +|integer +|query +|False +a| + +|offset +|integer +|query +|False +a| + +|dateStart +|string +|query +|False +a| + +|dateEnd +|string +|query +|False +a| + +|systemSerialNumber +|string +|query +|False +a| + +|referenceNumber +|string +|query +|False +a| + +|caseStatus +| +|query +|False +a| + +|caseNumber +|integer +|query +|False +a| + +|allCasesByOwnerCompany +| +|query +|False +a| + +|allCasesByCaseContact +| +|query +|False +a| + +|systemCloudID +|string +|query +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|caseList +|array[link:#caseList[caseList]] +|False +a| + +|totalResultsNumber +|integer +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "caseList": [ + { + "caseNumber": "string", + "symptom": "string", + "systemSerialNumber": "string", + "dateOpened": "string", + "dateUpdated": "string", + "priority": "Low", + "status": "Unassigned", + "clusterName": "string", + "caseAssignedToContact": "string", + "caseOwnerCompany": "string", + "caseContact": "string" + } + ] +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#caseList] +[.api-collapsible-fifth-title] +caseList + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|caseNumber +|string +|False +a| + +|symptom +|string +|False +a| + +|systemSerialNumber +|string +|False +a| + +|dateOpened +|string +|False +a| + +|dateUpdated +|string +|False +a| + +|priority +| +|False +a| + +|status +| +|False +a| + +|clusterName +|string +|False +a| + +|caseAssignedToContact +|string +|False +a| + +|caseOwnerCompany +|string +|False +a| + +|caseContact +|string +|False +a| + +|numberOfResults +|integer +|False +a| + +|offset +|integer +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/ipa/ipa-x-doc.json b/ipa/ipa-x-doc.json deleted file mode 100644 index 061cca1d..00000000 --- a/ipa/ipa-x-doc.json +++ /dev/null @@ -1,353 +0,0 @@ -{ - "overview": "In-Product Automation REST API for the NetApp Console", - "permalink": "overview.html", - "paths": { - "/ipa/account/{accountId}/serial-number/{serialNumber}/register": { - "post": { - "x-doc": { - "title": "Register a license", - "category": "License", - "filename": "post-ipa-account-serial-number-register.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/serial-number/{serialNumber}/deregister": { - "post": { - "x-doc": { - "title": "Deregister a license", - "category": "License", - "filename": "post-ipa-serial-number-deregister.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/serial-number/{serialNumber}/registration-status": { - "post": { - "x-doc": { - "title": "Retrieve license status", - "category": "License", - "filename": "post-ipa-serial-number-registration-status.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/account/{accountId}/serial-number/{serialNumber}/status/v5": { - "post": { - "x-doc": { - "title": "Retrieve IPA license status (v5)", - "category": "License", - "filename": "post-ipa-account-serial-number-status-v5.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/authenticate/v5": { - "post": { - "x-doc": { - "title": "Authenticate an IPA license (v5)", - "category": "License", - "filename": "post-ipa-authenticate-v5.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/account/{accountId}/serial-number/{serialNumber}/status/v6": { - "post": { - "x-doc": { - "title": "Retrieve IPA license status (v6)", - "category": "License", - "filename": "post-ipa-account-serial-number-status-v6.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/services/account/{accountId}/sn-lookup-token": { - "post": { - "x-doc": { - "title": "Retrieve an IPA serial number token", - "category": "Services", - "filename": "post-ipa-services-account-sn-lookup-token.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/services/sn-lookup": { - "post": { - "x-doc": { - "title": "Retrieve an IPA serial number", - "category": "Services", - "filename": "post-ipa-services-sn-lookup.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/account/{accountId}/nss-key/{nssKeyId}": { - "get": { - "x-doc": { - "title": "Retrieve NetApp Support Site key credentials", - "category": "NSS", - "filename": "get-ipa-account-nss-key-.html", - "subcategory": null, - "explorer": false - } - }, - "put": { - "x-doc": { - "title": "Update NetApp Support Site key credentials", - "category": "NSS", - "filename": "put-ipa-account-nss-key-.html", - "subcategory": null, - "explorer": false - } - }, - "delete": { - "x-doc": { - "title": "Delete NetApp Support Site key credentials", - "category": "NSS", - "filename": "delete-ipa-account-nss-key-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/account/{accountId}/nss-keys": { - "get": { - "x-doc": { - "title": "Retrieve a list of NetApp Support Site key credentials", - "category": "NSS", - "filename": "get-ipa-account-nss-keys.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/account/{accountId}/nss-key": { - "post": { - "x-doc": { - "title": "Create NetApp Support Site key credentials", - "category": "NSS", - "filename": "post-ipa-account-nss-key.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/account/{accountId}/idaas-key": { - "post": { - "x-doc": { - "title": "Create an IDaaS NetApp Support Site key credential", - "category": "NSS", - "filename": "post-ipa-account-idaas-key.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/account/{accountId}/nss-key/{nssKeyId}/associate": { - "post": { - "x-doc": { - "title": "Associate a resource", - "category": "NSS", - "filename": "post-ipa-account-nss-key-associate.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/account/{accountId}/nss-key/{nssKeyId}/disassociate": { - "post": { - "x-doc": { - "title": "Disassociate a resource", - "category": "NSS", - "filename": "post-ipa-account-nss-key-disassociate.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/account/{accountId}/src-nss-key/{srcNssKeyId}/dst-nss_key/{dstNssKeyId}/resource/{resourceId}": { - "post": { - "x-doc": { - "title": "Update a resource NetApp Support Site key", - "category": "NSS", - "filename": "post-ipa-account-src-nss-key-dst-nss_key-resource-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/account/{accountId}/nss-key/resource/{resourceId}": { - "get": { - "x-doc": { - "title": "Retrieve NetApp Support Site credentials", - "category": "NSS", - "filename": "get-ipa-account-nss-key-resource-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/account/{accountId}/migrate": { - "post": { - "x-doc": { - "title": "Migrate NetApp Support Site keys", - "category": "NSS", - "filename": "post-ipa-account-migrate.html", - "explorer": false - } - } - }, - "/ipa/nss-key/{nssKeyId}/access-token": { - "get": { - "x-doc": { - "title": "Retrieve an access token", - "category": "NSS", - "filename": "get-ipa-nss-key-access-token.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/accounts/nss-data": { - "get": { - "x-doc": { - "title": "Retrieve NetApp Support Site data for accounts", - "category": "NSS", - "filename": "get-ipa-accounts-nss-data.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/account/{accountId}/nss-key/{nssKeyId}/nss-data": { - "get": { - "x-doc": { - "title": "Retrieve NetApp Support Site data for an account and key ID", - "category": "NSS", - "filename": "get-ipa-account-nss-key-nss-data.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/support/case/system-entitlements": { - "post": { - "x-doc": { - "title": "Check system entitlements", - "category": "Support", - "filename": "post-ipa-support-case-system-entitlements.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/support/case/create": { - "post": { - "x-doc": { - "title": "Create a support case", - "category": "Support", - "filename": "post-ipa-support-case-create.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/support/case/{caseNumber}/upload": { - "post": { - "x-doc": { - "title": "Upload an attachment for a support case", - "category": "Support", - "filename": "post-ipa-support-case-upload.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/support/case/{caseNumber}/file/{fileName}/upload-url": { - "get": { - "x-doc": { - "title": "Retrieve a temporary URL for file attachment", - "category": "Support", - "filename": "get-ipa-support-case-file-upload-url.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/support/case-search": { - "get": { - "x-doc": { - "title": "Retrieve support cases", - "category": "Support", - "filename": "get-ipa-support-case-search.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/support/case/{caseNumber}/details": { - "get": { - "x-doc": { - "title": "Retrieve support case details", - "category": "Support", - "filename": "get-ipa-support-case-details.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/support/case/{caseNumber}": { - "put": { - "x-doc": { - "title": "Update support case notes or status", - "category": "Support", - "filename": "put-ipa-support-case-.html", - "subcategory": null, - "explorer": false - } - } - }, - "/ipa/support/case-notes/{caseNumber}": { - "get": { - "x-doc": { - "title": "Retrieve a list of case notes", - "category": "Support", - "filename": "get-ipa-support-case-notes-.html", - "subcategory": null, - "explorer": false - } - } - } - }, - "categories": [ - { - "id": "license", - "title": "License endpoints in the In-Product Automation REST API for the NetApp Console", - "permalink": "license_overview.html" - }, - { - "id": "services", - "title": "Services endpoints in the In-Product Automation REST API for the NetApp Console", - "permalink": "services_overview.html" - }, - { - "id": "nss", - "title": "NetApp Support Site endpoints in the In-Product Automation REST API for the NetApp Console", - "permalink": "nss_overview.html" - }, - { - "id": "support", - "title": "Support endpoints in the In-Product Automation REST API for the NetApp Console", - "permalink": "support_overview.html" - } - ] -} \ No newline at end of file diff --git a/ipa/ipa.json b/ipa/ipa.json deleted file mode 100644 index cdb1abd9..00000000 --- a/ipa/ipa.json +++ /dev/null @@ -1,2727 +0,0 @@ -{ - "openapi": "3.0.3", - "info": { - "title": "IPA service REST API reference", - "description": "
    Overview\n

    In-Product Automation (IPA) is a core NetApp Console platform service enabling license enforcement and policy-driven operational control for a variety of software licensing models. It supports several different NetApp product families, including ONTAP (AFF, FAS, Cloud Volumes ONTAP), E-Series, StorageGRID, SolidFire as well as additional host-based solutions such as OnCommand Insight. IPA provides a REST API you can use to access the features available with the service.

    \n

    The NetApp Console IPA service orchestrates the overall IPA configuration to facilitate the management of licenses, services, and NetApp Support Site user data. It provides streamlined orchestration of Cloud Volumes ONTAP system management of IPA functions.

    \n

    The IPA service provides secure and granular role-based access control (RBAC) for the resources available through the NetApp Console control plane. The service operates within the context of a NetApp Console account. The identity of the API caller and the account are established using a user or service token.

    \n

    There are four components defined within the IPA service that expose REST endpoints.

    \n
      \n
    • License
      • \n
    • Services
      • \n
    • NetApp Support Site (NSS)
      • \n
    • Support
      • \n
    \n

    The IPA service has two modes of operation:

    \n
      \n
    • Legacy password-based authentication mode
      • \n
    • Current token-based authentication mode
      • \n
    \n

    The operational mode used depends on how the license is registered for a given serial number. Token-based authentication is preferred. If a license is registered with a password, the legacy Oracle password-based authentication mode is used.

    \n

    The key benefits of the IPA service include:

    \n
      \n
    • A consistent user experience for all the IPA-related features (such as license and NSS)
      • \n
    • An intuitive REST API to manage the IPA-related features which can be used to return a license, service, and NetApp Support site user within the same context
      • \n
    \n

    All IPA service API calls are short-lived and run synchronously. Asynchronous processing and internal process tracking are not supported.

    \n

    Note: Before using the API reference documentation, review the Get started section for the NetApp Console APIs.
    \nFor more information about the security tokens and identifiers you’ll need when using the API, review the Common workflows and tasks section.

    \n
    \n
    \n
    \nREST implementation\n

    HTTP methods

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    MethodDescription
    POSTCreate an object instance
    GETRetrieve an object instance or collection
    PUTUpdate an existing object's specified properties
    DELETERemove an existing object
    \n

    Request headers

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Request HeaderDescription
    AuthorizationRequired. Contains the JWT token (user/service)
    X-service-request-idUsed to tag a request with application-specific keys for improved supportability. Free-text string
    \n

    Query parameters

    \n

    You can use query parameters with endpoints in the following components:

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ComponentQuery Parameter
    NetApp Support SiteaccountId (required)
    nssKeyId (required)
    resourceId (required)
    \n

    Response headers

    \n

    This API uses the standard HTTP response headers common with all NetApp Console APIs. See REST implementation for more information.

    \n

    HTTP status codes

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    HTTP Status CodeDescription
    200OK: Returned for successful operation completion
    400Bad Request: Returned if the input is malformed and could not be parsed
    401Unauthorized: Returned if user authentication failed or the token has expired
    403Forbidden: Returned for authorization errors depending on the resource and token
    404Not Found: Returned if the requested resource could not be found
    500Processing Error: Returned if an error occurs on the server while processing the API call
    \n
    \n
    \n
    \nError handling\n

    There are three processes involved with error handling and processing:

    \n
      \n
    • The error is logged for supportability
      • \n
    • The error is returned to the caller for specific handling
      • \n
    • The database connection is rolled back
      • \n
    \n
    \n
    \n
    \ncURL examples\n

    Retrieve NetApp Support Site data for a specified account

    \n

    This cURL example retrieves NetApp Support Site data by using a specified account ID and NetApp Support Site key ID.
    \nThe NetApp Support Site data contains the NetApp Support Site ID, username, and email ID.

    \n
    curl -X GET "https://cloudmanager.cloud.netapp.com/ipa/account/<accountId>/nss-key/<nssKeyId>/nss-data\n" -H  "accept: application/json" -H  "authorization: <user token>"\n
    \n
    \n
    \n

    ", - "version": "1.0.0" - }, - "components": { - "securitySchemes": { - "authorization": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "JWT", - "description": "JWT access token to authorize the request, sent on the request header." - } - }, - "schemas": { - "def-0": { - "title": "Authorization", - "type": "object", - "properties": { - "X-Service-Request-Id": { - "description": "Request identifier", - "type": "string" - } - } - }, - "def-1": { - "title": "AuthorizationUser", - "type": "object", - "properties": { - "X-Service-Request-Id": { - "description": "Request identifier", - "type": "string" - } - } - }, - "def-2": { - "title": "Error", - "type": "object", - "description": "Error response", - "properties": { - "error": { - "description": "Error code/category", - "type": "string" - }, - "message": { - "description": "Error description message", - "type": "string" - } - } - } - } - }, - "paths": { - "/ipa/account/{accountId}/serial-number/{serialNumber}/register": { - "post": { - "tags": [ - "License" - ], - "description": "Registers a license with IPA.\n
    \n
    Token usage: NetApp Console service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nssKeyId": { - "type": "string" - }, - "instanceID": { - "type": "string" - }, - "cloudAccountId": { - "type": "string" - }, - "startDate": { - "type": "string" - } - }, - "required": [ - "nssKeyId", - "instanceID", - "cloudAccountId", - "startDate" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string", - "pattern": "^[0-9]{1,20}$" - }, - "in": "path", - "name": "serialNumber", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/serial-number/{serialNumber}/deregister": { - "post": { - "tags": [ - "License" - ], - "description": "Deregisters a license from IPA.\n
    \n
    Token usage: NetApp Console service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cloudAccountId": { - "type": "string" - } - }, - "required": [ - "cloudAccountId" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string", - "pattern": "^[0-9]{1,20}$" - }, - "in": "path", - "name": "serialNumber", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/serial-number/{serialNumber}/registration-status": { - "post": { - "tags": [ - "License" - ], - "description": "Retrieves the license registration status.\n
    \n
    Token usage: NetApp Console user token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - } - } - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string", - "pattern": "^[0-9]{1,20}$" - }, - "in": "path", - "name": "serialNumber", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "statusDescription": { - "type": "string" - }, - "contractEndDate": { - "type": "string" - }, - "contractStartDate": { - "type": "string" - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/account/{accountId}/serial-number/{serialNumber}/status/v5": { - "post": { - "tags": [ - "License" - ], - "description": "Retrieves an IPA license status (V5).\n
    \n
    Token usage: NetApp Console service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nssKeyId": { - "type": "string" - }, - "version": { - "type": "integer", - "default": 1 - }, - "op": { - "type": "string", - "default": "get" - }, - "package": { - "type": "string", - "default": "CLOUD" - }, - "product": { - "type": "string" - } - }, - "required": [ - "nssKeyId" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string", - "pattern": "^[0-9]{1,20}$" - }, - "in": "path", - "name": "serialNumber", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "statusDescription": { - "type": "string" - }, - "contractEndDate": { - "type": "string" - }, - "statusResp": { - "type": "string" - }, - "capacity": { - "type": "integer" - }, - "serialNumber": { - "type": "string" - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/authenticate/v5": { - "post": { - "tags": [ - "License" - ], - "description": "Authenticates an IPA license (V5).\n
    \n
    Token usage: NetApp Console user token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nssUsername": { - "type": "string" - } - }, - "required": [ - "nssUsername" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/account/{accountId}/serial-number/{serialNumber}/status/v6": { - "post": { - "tags": [ - "License" - ], - "description": "Retrieves an IPA license status (V6).\n
    \n
    Token usage: NetApp Console service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nssKeyId": { - "type": "string" - }, - "version": { - "type": "integer", - "default": 1 - }, - "op": { - "type": "string", - "default": "get" - }, - "package": { - "type": "string" - }, - "source": { - "type": "string", - "default": "occm" - }, - "hostId": { - "type": "string" - }, - "requestType": { - "type": "string", - "default": "Download" - }, - "product": { - "type": "string" - } - }, - "required": [ - "nssKeyId", - "package" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string", - "pattern": "^[0-9]{1,20}$" - }, - "in": "path", - "name": "serialNumber", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/services/account/{accountId}/sn-lookup-token": { - "post": { - "tags": [ - "Services" - ], - "description": "Retrieves an IPA serial number token.\n
    \n
    Token usage: NetApp Console service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "grantType": { - "type": "string" - }, - "scope": { - "type": "string" - }, - "nssKeyId": { - "type": "string" - } - }, - "required": [ - "grantType", - "scope", - "nssKeyId" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Successful serial number lookup token response", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Successful serial number lookup token response", - "properties": { - "expires_in": { - "type": "integer" - }, - "token_type": { - "type": "string" - }, - "refresh_token": { - "type": "string" - }, - "access_token": { - "type": "string" - } - } - } - } - } - }, - "4XX": { - "description": "Client error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Client error response" - } - } - } - }, - "5XX": { - "description": "Server error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Server error response" - } - } - } - } - } - } - }, - "/ipa/services/sn-lookup": { - "post": { - "tags": [ - "Services" - ], - "description": "Retrieves an IPA serial number.\n
    \n
    Token usage: NetApp Console service token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "snLookupAccessToken": { - "type": "string" - }, - "serialNumber": { - "type": "string" - }, - "licensesLicenseProtocol": { - "type": "string" - }, - "licensesType": { - "type": "string" - }, - "hostId": { - "type": "string" - }, - "licensesPackage": { - "type": "string" - } - }, - "required": [ - "snLookupAccessToken" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "4XX": { - "description": "Client error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Client error response" - } - } - } - }, - "5XX": { - "description": "Server error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Server error response" - } - } - } - } - } - } - }, - "/ipa/account/{accountId}/nss-key/{nssKeyId}": { - "get": { - "tags": [ - "NSS" - ], - "description": "Retrieves the NetApp Support Site key credentials for a specified NetApp Support Site ID. \n
    \n
    Token usage: NetApp Console user token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "nssKeyId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - }, - "resources": { - "type": "array", - "items": { - "type": "string" - } - }, - "credentialType": { - "type": "string" - }, - "passwordDeprecated": { - "type": "boolean" - }, - "status": { - "enum": [ - "EXPIRED", - "UPDATE", - "ABOUT_TO_EXPIRE" - ] - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - }, - "put": { - "tags": [ - "NSS" - ], - "description": "Updates NetApp Support Site key credentials.\n
    \n
    Token usage: NetApp Console user token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - } - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "nssKeyId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - }, - "delete": { - "tags": [ - "NSS" - ], - "description": "Deletes NetApp Support Site key credentials.\n
    \n
    Token usage: NetApp Console user token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "userNss": { - "type": "boolean" - } - } - }, - { - "type": "null" - } - ] - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "nssKeyId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/account/{accountId}/nss-keys": { - "get": { - "tags": [ - "NSS" - ], - "description": "Retrieves a list of NetApp Support Site key credentials associated with an account. You can optionally choose to include the resource data associated with a NetApp Support Site ID.\n

    Token usage: NetApp Console user token.", - "parameters": [ - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "includeResources", - "required": false - }, - { - "schema": { - "type": "boolean", - "default": false - }, - "in": "query", - "name": "userNss", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - }, - "resources": { - "type": "array", - "items": { - "type": "string" - } - }, - "credentialType": { - "type": "string" - }, - "passwordDeprecated": { - "type": "boolean" - }, - "status": { - "enum": [ - "EXPIRED", - "ACTIVE", - "ABOUT_TO_EXPIRE" - ] - } - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/account/{accountId}/nss-key": { - "post": { - "tags": [ - "NSS" - ], - "description": "Creates NetApp Support Site key credentials.\n
    \n
    Token usage: NetApp Console user token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "username": { - "type": "string" - } - }, - "required": [ - "username" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/account/{accountId}/idaas-key": { - "post": { - "tags": [ - "NSS" - ], - "description": "Creates an identity-as-a-service (IDaaS) NetApp Support Site key credential.\n
    \n
    Token usage: NetApp Console user token.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "userNss": { - "type": "boolean", - "default": false - } - } - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "ssoId": { - "type": "string" - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/account/{accountId}/nss-key/{nssKeyId}/associate": { - "post": { - "tags": [ - "NSS" - ], - "description": "Associates a resource with a specified NetApp Support Site key.

    Token usage: NetApp Console user token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "resourceId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "nssKeyId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/account/{accountId}/nss-key/{nssKeyId}/disassociate": { - "post": { - "tags": [ - "NSS" - ], - "description": "Disassociates a resource from a specified NetApp Support Site key.\n
    \n
    Token usage: NetApp Console user token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "resourceId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "nssKeyId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/account/{accountId}/src-nss-key/{srcNssKeyId}/dst-nss_key/{dstNssKeyId}/resource/{resourceId}": { - "post": { - "tags": [ - "NSS" - ], - "description": "Transfers the source NetApp Support Site data to the destination NetApp Support Site key of the associated resource.\n
    Token usage: NetApp Console user token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "srcNssKeyId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "dstNssKeyId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "resourceId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/account/{accountId}/nss-key/resource/{resourceId}": { - "get": { - "tags": [ - "NSS" - ], - "description": "Retrieves NetApp Support Site credentials for a specified resource ID and validates them if the validateKey field is true.\n
    Token usage: NetApp Console user token.", - "parameters": [ - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "validateKey", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "resourceId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/nss-key/{nssKeyId}/access-token": { - "get": { - "tags": [ - "NSS" - ], - "description": "Retrieves a NetApp Support Site user B2C access token.\n
    \n
    Token usage: NetApp Console service token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "nssKeyId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_token": { - "type": "string" - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/accounts/nss-data": { - "get": { - "tags": [ - "NSS" - ], - "description": "Retrieves NetApp Support Site data associated with the NetApp Console accounts. \n
    \n
    Token usage: NetApp Console service token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "nss": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ssoId": { - "type": "string" - }, - "idaas": { - "type": "boolean" - } - } - } - } - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/account/{accountId}/nss-key/{nssKeyId}/nss-data": { - "get": { - "tags": [ - "NSS" - ], - "description": "Retrieves NetApp Support Site data associated with an account ID and NetApp Support Site key ID.

    Token usage: NetApp Console user token.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "nssKeyId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - }, - "email": { - "type": "string" - }, - "status": { - "enum": [ - "EXPIRED", - "ACTIVE", - "ABOUT_TO_EXPIRE" - ] - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/support/case/system-entitlements": { - "post": { - "tags": [ - "Support" - ], - "description": "Checks system entitlements for a specified serial number. This checks whether a user is entitled to create a case for the requested serial number.\n
    \n
    Token usage: Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "serialNumber": { - "type": "string" - }, - "email": { - "type": "string" - }, - "nssKeyId": { - "type": "string" - }, - "accountId": { - "type": "string" - } - }, - "required": [ - "serialNumber" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ntapUID": { - "type": "string" - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/support/case/create": { - "post": { - "tags": [ - "Support" - ], - "description": "Creates a support case.\n
    \n
    Token usage: Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "additionalEmail": { - "type": "string" - }, - "attributeMap": { - "type": "object" - }, - "caseDescription": { - "type": "string", - "minLength": 1, - "maxLength": 66560 - }, - "priority": { - "enum": [ - "P1", - "P2", - "P3", - "P4" - ] - }, - "caseTitle": { - "type": "string", - "minLength": 1, - "maxLength": 40 - }, - "serialNumber": { - "type": "string" - }, - "nssKeyId": { - "type": "string" - }, - "category1": { - "type": "integer" - }, - "category2": { - "type": "integer" - }, - "node": { - "type": "string" - } - }, - "required": [ - "serialNumber", - "accountId", - "nssKeyId" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "caseNumber": { - "type": "string" - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/support/case/{caseNumber}/upload": { - "post": { - "tags": [ - "Support" - ], - "description": "Uploads an attachment file to a support case.\n
    \n
    Token usage: Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nssKeyId": { - "type": "string" - }, - "accountId": { - "type": "string" - }, - "fileName": { - "description": "Case attachment file", - "type": "string", - "maxLength": 80 - }, - "fileDescription": { - "description": "Case attachment file description", - "type": "string", - "maxLength": 160 - } - }, - "required": [ - "fileName", - "fileDescription", - "nssKeyId", - "accountId" - ] - } - } - }, - "required": true - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "caseNumber", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uploadStatus": { - "type": "string" - }, - "fileName": { - "type": "string" - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/support/case/{caseNumber}/file/{fileName}/upload-url": { - "get": { - "tags": [ - "Support" - ], - "description": "Retrieves a temporary URL for uploading an attachment file.\n
    \n
    Token usage: Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "nssKeyId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string", - "maxLength": 80 - }, - "in": "path", - "name": "fileName", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "caseNumber", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "uploadUrl": { - "type": "string" - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/support/case-search": { - "get": { - "tags": [ - "Support" - ], - "description": "Retrieves a list of support cases according to the filter parameters.\n
    \n
    Token usage: Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "nssKeyId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "integer", - "default": 20 - }, - "in": "query", - "name": "numberOfResults", - "required": false - }, - { - "schema": { - "type": "integer", - "default": 0 - }, - "in": "query", - "name": "offset", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "dateStart", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "dateEnd", - "required": false - }, - { - "schema": { - "type": "string", - "minLength": 2, - "maxLength": 20 - }, - "in": "query", - "name": "systemSerialNumber", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "referenceNumber", - "required": false - }, - { - "schema": { - "enum": [ - "Open", - "Closed", - "All" - ] - }, - "in": "query", - "name": "caseStatus", - "required": false - }, - { - "schema": { - "type": "integer" - }, - "in": "query", - "name": "caseNumber", - "required": false - }, - { - "schema": { - "enum": [ - "Yes", - "No" - ] - }, - "in": "query", - "name": "allCasesByOwnerCompany", - "required": false - }, - { - "schema": { - "enum": [ - "Yes", - "No" - ] - }, - "in": "query", - "name": "allCasesByCaseContact", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "systemCloudID", - "required": false - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "caseList": { - "type": "array", - "items": { - "type": "object", - "properties": { - "caseNumber": { - "type": "string" - }, - "symptom": { - "type": "string" - }, - "systemSerialNumber": { - "type": "string" - }, - "dateOpened": { - "type": "string" - }, - "dateUpdated": { - "type": "string" - }, - "priority": { - "enum": [ - "Low", - "Medium", - "High", - "Critical" - ] - }, - "status": { - "enum": [ - "Unassigned", - "Active", - "Pending Customer", - "Solution Proposed", - "Pending Closed", - "Closed" - ] - }, - "clusterName": { - "type": "string" - }, - "caseAssignedToContact": { - "type": "string" - }, - "caseOwnerCompany": { - "type": "string" - }, - "caseContact": { - "type": "string" - }, - "numberOfResults": { - "type": "integer" - }, - "offset": { - "type": "integer" - } - } - } - }, - "totalResultsNumber": { - "type": "integer" - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/support/case/{caseNumber}/details": { - "get": { - "tags": [ - "Support" - ], - "description": "Retrieves support case details.\n
    \n
    Token usage: Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "nssKeyId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "accountId", - "required": true - }, - { - "schema": { - "enum": [ - "Yes", - "No" - ], - "default": "Yes" - }, - "in": "query", - "name": "fetchAttachments", - "required": false - }, - { - "schema": { - "type": "integer" - }, - "in": "path", - "name": "caseNumber", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "caseNumber": { - "type": "string" - }, - "priority": { - "enum": [ - "Low", - "Medium", - "High", - "Critical" - ] - }, - "dateOpened": { - "type": "string" - }, - "createdBy": { - "type": "string" - }, - "clusterName": { - "type": "string" - }, - "workingEnvironment": { - "type": "string" - }, - "status": { - "enum": [ - "Unassigned", - "Active", - "Pending Customer", - "Solution Proposed", - "Pending Closed", - "Closed" - ] - }, - "dateUpdated": { - "type": "string" - }, - "contractSupportOffering": { - "type": "string" - }, - "systemSerialNumber": { - "type": "string" - }, - "textDetails": { - "type": "string" - }, - "bugNumber": { - "type": "string" - }, - "symptom": { - "type": "string" - }, - "longSymptom": { - "type": "string" - }, - "attachedFiles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "attachmentFileName": { - "type": "string" - }, - "attachmentFileDescription": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/support/case/{caseNumber}": { - "put": { - "tags": [ - "Support" - ], - "description": "Updates the support case notes or status.\n
    \n
    Token usage: Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nssKeyId": { - "type": "string" - }, - "accountId": { - "type": "string" - }, - "caseNote": { - "type": "string" - }, - "changeCaseStatus": { - "enum": [ - "close" - ] - } - }, - "anyOf": [ - { - "allOf": [ - { - "required": [ - "nssKeyId" - ] - }, - { - "required": [ - "accountId" - ] - }, - { - "required": [ - "caseNote" - ] - } - ] - }, - { - "allOf": [ - { - "required": [ - "nssKeyId" - ] - }, - { - "required": [ - "accountId" - ] - }, - { - "required": [ - "caseNote" - ] - }, - { - "required": [ - "changeCaseStatus" - ] - } - ] - } - ] - } - } - } - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "path", - "name": "caseNumber", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Success response", - "content": { - "application/json": { - "schema": { - "description": "Success response", - "type": "string", - "example": "OK" - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - }, - "/ipa/support/case-notes/{caseNumber}": { - "get": { - "tags": [ - "Support" - ], - "description": "Retrieves a list of case notes.\n
    \n
    Token usage: Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'.", - "parameters": [ - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "nssKeyId", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "accountId", - "required": true - }, - { - "schema": { - "type": "string", - "enum": [ - "ALL", - "NONE", - "FILTERED" - ], - "default": "NONE" - }, - "in": "query", - "name": "fetchEmail", - "required": false - }, - { - "schema": { - "type": "string", - "enum": [ - "Yes", - "No" - ], - "default": "No" - }, - "in": "query", - "name": "latestEmailInThread", - "required": false - }, - { - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 20, - "default": 10 - }, - "in": "query", - "name": "numberOfResults", - "required": false - }, - { - "schema": { - "type": "integer", - "default": 0 - }, - "in": "query", - "name": "offset", - "required": false - }, - { - "schema": { - "type": "integer", - "minimum": 0, - "maximum": 9999999999 - }, - "in": "path", - "name": "caseNumber", - "required": true - }, - { - "schema": { - "type": "string" - }, - "in": "header", - "name": "X-Service-Request-Id", - "required": false, - "description": "Request identifier" - } - ], - "responses": { - "200": { - "description": "Default Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "caseNumber": { - "type": "string" - }, - "totalResults": { - "type": "string" - }, - "caseNotes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "noteType": { - "type": "string" - }, - "transactionDescription": { - "type": "string" - }, - "transactionID": { - "type": "string" - }, - "transactionAssignedTo": { - "type": "string" - }, - "transactionStatus": { - "type": "string" - }, - "textDetails": { - "type": "string" - }, - "createdOnDateTime": { - "type": "string" - }, - "createdBy": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "4XX": { - "description": "Error response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/def-2", - "description": "Error response" - } - } - } - } - } - } - } - }, - "servers": [ - { - "url": "https://dev.cloudmanager.cloud.netapp.com" - } - ], - "security": [ - { - "authorization": [] - } - ], - "tags": [ - { - "name": "License", - "description": "
    \nOverview\n

    The license endpoints in the IPA service provide license management to the IPA. License management includes license registration, deregistration, and status checks to the NetApp-wide IPA.

    \n

    The registration and deregistration API endpoints register and deregister the NetApp Console license to the IPA service.
    \nBased on the various versions of the IPA service, there are several versions of the NetApp Console license registration and deregistration endpoints.

    \n

    Similarly, the license status check endpoint has different versions that relate to different IPA service versions.

    \n

    The following describes the mapping between the NetApp Console IPA licensing endpoints and the IPA product registration endpoints:

    \n
      \n
    • Registration and deregistration maps to /IPA/v2/prodregister
      • \n
    • Status check maps to /IPA/v2/prodstatus
      • \n
    • IPA version-5 (IPA v5) status maps to /entitlement/IPA/v4/prodstatus
      • \n
    • IPA v5 authentication maps to /entitlement/IPA/v4/authenticate
      • \n
    • IPA v6 status maps to /entitlement/IPA/v6/prodstatus
      • \n
    \n

    For the credentials required for license management, the license endpoints map to cred_service_endpoint/accounts/:accountId/credentials.

    \n

    You can perform the following operations by using IPA license endpoints across various versions of the IPA service:

    \n
      \n
    • Registration
      • \n
    • Deregistration
      • \n
    • Registration status check
      • \n
    \n
    \n" - }, - { - "name": "Services", - "description": "
    \nOverview\n

    The services endpoint performs the NetApp IPA serial number (sn) lookup and serial number token lookup operations.
    \nYou need a serial number lookup token to retrieve a serial number. You can retrieve both a serial number and a lookup token by using this endpoint.

    \n

    To retrieve a serial number token (sn-token), the NetApp Console IPA services endpoint consults the sn-lookup-service endpoint.
    \nTo retrieve a serial number (sn-lookup), the NetApp Console IPA services endpoint consults the sn-service endpoint.

    \n

    You can perform the following operations with the IPA services endpoint:

    \n
      \n
    • Retrieve a serial number lookup token
      • \n
    • Retrieve a serial number
      • \n
    \n
    \n" - }, - { - "name": "NSS", - "description": "
    \nOverview\n

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    \n

    A NetApp Support Site key is a collection of the following:

    \n
      \n
    • Public identifier
      • \n
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • \n
    • Account ID (such as account-NJ1nCpW5)
      • \n
    • Resource class (such as ON_PREM, VSA, S3)
      • \n
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • \n
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • \n
    \n

    You can perform the following actions with the NetApp Support Site endpoints:

    \n
      \n
    • NetApp Support Site key management (retrieve, update, delete)
      • \n
    • Associate or disassociate a NetApp Support Site key
      • \n
    • Update a NetApp Support Site key of a resource
      • \n
    • Migrate a NetApp Support Site key and associate it with a resource
      • \n
    • Retrieve an access token (required for registration)
      • \n
    • Retrieve a NetApp Support Site username and email address
      • \n
    \n
    \n" - }, - { - "name": "Support", - "description": "
    \nOverview\n

    The support endpoint performs the case system entitlements and case creation operations.

    \n

    You can perform the following operations with the IPA support endpoint:

    \n
      \n
    • Check system entitlements for serial number - this checks if the user is entitled to create a case for the requested serial number.
      • \n
    • Create a support case
      • \n
    \n
    \n" - } - ], - "externalDocs": { - "url": "https://docs.netapp.com/us-en/cloud-manager-automation/cm/introduction.html", - "description": "Learn more about the BlueXP REST APIs." - } -} \ No newline at end of file diff --git a/ipa/license_overview.adoc b/ipa/license_overview.adoc new file mode 100644 index 00000000..d95c3096 --- /dev/null +++ b/ipa/license_overview.adoc @@ -0,0 +1,36 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/license_overview.html' +summary: 'License endpoints in the In-Product Automation REST API for the NetApp Console' +--- + += License endpoints in the In-Product Automation REST API for the NetApp Console + + + +The license endpoints in the IPA service provide license management to the IPA. License management includes license registration, deregistration, and status checks to the NetApp-wide IPA. + +The registration and deregistration API endpoints register and deregister the NetApp Console license to the IPA service. + +Based on the various versions of the IPA service, there are several versions of the NetApp Console license registration and deregistration endpoints. + +Similarly, the license status check endpoint has different versions that relate to different IPA service versions. + +The following describes the mapping between the NetApp Console IPA licensing endpoints and the IPA product registration endpoints: + +* Registration and deregistration maps to ++++++/IPA/v2/prodregister++++++ +* Status check maps to ++++++/IPA/v2/prodstatus++++++ +* IPA version-5 (IPA v5) status maps to ++++++/entitlement/IPA/v4/prodstatus++++++ +* IPA v5 authentication maps to ++++++/entitlement/IPA/v4/authenticate++++++ +* IPA v6 status maps to ++++++/entitlement/IPA/v6/prodstatus++++++ + +For the credentials required for license management, the license endpoints map to cred_service_endpoint/accounts/:accountId/credentials. + +You can perform the following operations by using IPA license endpoints across various versions of the IPA service: + +* Registration +* Deregistration +* Registration status check + + diff --git a/ipa/nss_overview.adoc b/ipa/nss_overview.adoc new file mode 100644 index 00000000..9c5051fe --- /dev/null +++ b/ipa/nss_overview.adoc @@ -0,0 +1,33 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/nss_overview.html' +summary: 'NetApp Support Site endpoints in the In-Product Automation REST API for the NetApp Console' +--- + += NetApp Support Site endpoints in the In-Product Automation REST API for the NetApp Console + + + +NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval. + +A NetApp Support Site key is a collection of the following: + +* Public identifier +* Resource identifier -- used internally (such as VsaWorkingEnvironment-6iEs02vL) +* Account ID (such as account-NJ1nCpW5) +* Resource class (such as ON_PREM, VSA, S3) +* NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c) +* NetApp Support Site username - the name used to make a NetApp Support Site registration + +You can perform the following actions with the NetApp Support Site endpoints: + +* NetApp Support Site key management (retrieve, update, delete) +* Associate or disassociate a NetApp Support Site key +* Update a NetApp Support Site key of a resource +* Migrate a NetApp Support Site key and associate it with a resource +* Retrieve an access token (required for registration) +* Retrieve a NetApp Support Site username and email address + + diff --git a/ipa/overview.adoc b/ipa/overview.adoc new file mode 100644 index 00000000..745da0c6 --- /dev/null +++ b/ipa/overview.adoc @@ -0,0 +1,151 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/overview.html' +summary: 'In-Product Automation REST API for the NetApp Console' +--- + += In-Product Automation REST API for the NetApp Console + + + +In-Product Automation (IPA) is a core NetApp Console platform service enabling license enforcement and policy-driven operational control for a variety of software licensing models. It supports several different NetApp product families, including ONTAP (AFF, FAS, Cloud Volumes ONTAP), E-Series, StorageGRID, SolidFire as well as additional host-based solutions such as OnCommand Insight. IPA provides a REST API you can use to access the features available with the service. + +The NetApp Console IPA service orchestrates the overall IPA configuration to facilitate the management of licenses, services, and NetApp Support Site user data. It provides streamlined orchestration of Cloud Volumes ONTAP system management of IPA functions. + +The IPA service provides secure and granular role-based access control (RBAC) for the resources available through the NetApp Console control plane. The service operates within the context of a NetApp Console account. The identity of the API caller and the account are established using a user or service token. + +There are four components defined within the IPA service that expose REST endpoints. + +* License +* Services +* NetApp Support Site (NSS) +* Support + +The IPA service has two modes of operation: + +* Legacy password-based authentication mode +* Current token-based authentication mode + +The operational mode used depends on how the license is registered for a given serial number. Token-based authentication is preferred. If a license is registered with a password, the legacy Oracle password-based authentication mode is used. + +The key benefits of the IPA service include: + +* A consistent user experience for all the IPA-related features (such as license and NSS) +* An intuitive REST API to manage the IPA-related features which can be used to return a license, service, and NetApp Support site user within the same context + +All IPA service API calls are short-lived and run synchronously. Asynchronous processing and internal process tracking are not supported. + +**Note:** Before using the API reference documentation, review the https://docs.netapp.com/us-en/console-automation/platform/overview.html[Get started] section for the NetApp Console APIs. + +For more information about the security tokens and identifiers you'll need when using the API, review the https://docs.netapp.com/us-en/console-automation/platform/get_identifiers.html[Common workflows and tasks] section. + +''' + +== REST implementation + +=== HTTP methods + +|=== +| Method | Description + +| `POST` +| Create an object instance + +| `GET` +| Retrieve an object instance or collection + +| `PUT` +| Update an existing object's specified properties + +| `DELETE` +| Remove an existing object +|=== + +=== Request headers + +|=== +| Request Header | Description + +| `Authorization` +| Required. Contains the JWT token (user/service) + +| `X-service-request-id` +| Used to tag a request with application-specific keys for improved supportability. Free-text string +|=== + +=== Query parameters + +You can use query parameters with endpoints in the following components: + +|=== +| Component | Query Parameter + +| NetApp Support Site +| accountId (required) + +nssKeyId (required) + +resourceId (required) + +| +| +|=== + +=== Response headers + +This API uses the standard HTTP response headers common with all NetApp Console APIs. See https://docs.netapp.com/us-en/cloud-manager-automation/platform/http_details.html#response-headers[REST implementation] for more information. + +=== HTTP status codes + +|=== +| HTTP Status Code | Description + +| `200` +| OK: Returned for successful operation completion + +| `400` +| Bad Request: Returned if the input is malformed and could not be parsed + +| `401` +| Unauthorized: Returned if user authentication failed or the token has expired + +| `403` +| Forbidden: Returned for authorization errors depending on the resource and token + +| `404` +| Not Found: Returned if the requested resource could not be found + +| `500` +| Processing Error: Returned if an error occurs on the server while processing the API call +|=== + +''' + +== Error handling + +There are three processes involved with error handling and processing: + +* The error is logged for supportability +* The error is returned to the caller for specific handling +* The database connection is rolled back + +''' + +== cURL examples + +=== Retrieve NetApp Support Site data for a specified account + +This cURL example retrieves NetApp Support Site data by using a specified account ID and NetApp Support Site key ID. + +The NetApp Support Site data contains the NetApp Support Site ID, username, and email ID. + +.... + + curl -X GET "https://cloudmanager.cloud.netapp.com/ipa/account//nss-key//nss-data +" -H "accept: application/json" -H "authorization: " +.... + +''' + +{blank} + + + + + diff --git a/ipa/post-ipa-account-idaas-key.adoc b/ipa/post-ipa-account-idaas-key.adoc new file mode 100644 index 00000000..4081fecc --- /dev/null +++ b/ipa/post-ipa-account-idaas-key.adoc @@ -0,0 +1,154 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-account-idaas-key.html' +summary: 'Create an IDaaS NetApp Support Site key credential' +--- + += Create an IDaaS NetApp Support Site key credential + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/account/{accountId}/idaas-key`# + + + +Creates an identity-as-a-service (IDaaS) NetApp Support Site key credential. + + + + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|code +|string +|False +a| + +|userNss +|boolean +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "code": "string" +} +==== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|ssoId +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "string", + "ssoId": "string" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-account-nss-key-associate.adoc b/ipa/post-ipa-account-nss-key-associate.adoc new file mode 100644 index 00000000..33c3c00b --- /dev/null +++ b/ipa/post-ipa-account-nss-key-associate.adoc @@ -0,0 +1,103 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-account-nss-key-associate.html' +summary: 'Associate a resource' +--- + += Associate a resource + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/account/{accountId}/nss-key/{nssKeyId}/associate`# + + + +Associates a resource with a specified NetApp Support Site key. + + + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resourceId +|string +|query +|True +a| + +|nssKeyId +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-account-nss-key-disassociate.adoc b/ipa/post-ipa-account-nss-key-disassociate.adoc new file mode 100644 index 00000000..8abb90d3 --- /dev/null +++ b/ipa/post-ipa-account-nss-key-disassociate.adoc @@ -0,0 +1,104 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-account-nss-key-disassociate.html' +summary: 'Disassociate a resource' +--- + += Disassociate a resource + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/account/{accountId}/nss-key/{nssKeyId}/disassociate`# + + + +Disassociates a resource from a specified NetApp Support Site key. + + + + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resourceId +|string +|query +|True +a| + +|nssKeyId +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-account-nss-key.adoc b/ipa/post-ipa-account-nss-key.adoc new file mode 100644 index 00000000..e57433ea --- /dev/null +++ b/ipa/post-ipa-account-nss-key.adoc @@ -0,0 +1,143 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-account-nss-key.html' +summary: 'Create NetApp Support Site key credentials' +--- + += Create NetApp Support Site key credentials + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/account/{accountId}/nss-key`# + + + +Creates NetApp Support Site key credentials. + + + + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "username": "string" +} +==== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "string" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-account-serial-number-register.adoc b/ipa/post-ipa-account-serial-number-register.adoc new file mode 100644 index 00000000..b470cd47 --- /dev/null +++ b/ipa/post-ipa-account-serial-number-register.adoc @@ -0,0 +1,144 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-account-serial-number-register.html' +summary: 'Register a license' +--- + += Register a license + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/account/{accountId}/serial-number/{serialNumber}/register`# + + + +Registers a license with IPA. + + + + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|serialNumber +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nssKeyId +|string +|True +a| + +|instanceID +|string +|True +a| + +|cloudAccountId +|string +|True +a| + +|startDate +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nssKeyId": "string", + "instanceID": "string", + "cloudAccountId": "string", + "startDate": "string" +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-account-serial-number-status-v5.adoc b/ipa/post-ipa-account-serial-number-status-v5.adoc new file mode 100644 index 00000000..e7e99f6d --- /dev/null +++ b/ipa/post-ipa-account-serial-number-status-v5.adoc @@ -0,0 +1,201 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-account-serial-number-status-v5.html' +summary: 'Retrieve IPA license status (v5)' +--- + += Retrieve IPA license status (v5) + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/account/{accountId}/serial-number/{serialNumber}/status/v5`# + + + +Retrieves an IPA license status (V5). + + + + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|serialNumber +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nssKeyId +|string +|True +a| + +|version +|integer +|False +a| + +|op +|string +|False +a| + +|package +|string +|False +a| + +|product +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nssKeyId": "string", + "op": "string", + "package": "string", + "product": "string" +} +==== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|statusDescription +|string +|False +a| + +|contractEndDate +|string +|False +a| + +|statusResp +|string +|False +a| + +|capacity +|integer +|False +a| + +|serialNumber +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "statusDescription": "string", + "contractEndDate": "string", + "statusResp": "string", + "serialNumber": "string" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-account-serial-number-status-v6.adoc b/ipa/post-ipa-account-serial-number-status-v6.adoc new file mode 100644 index 00000000..ffb2f3f5 --- /dev/null +++ b/ipa/post-ipa-account-serial-number-status-v6.adoc @@ -0,0 +1,159 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-account-serial-number-status-v6.html' +summary: 'Retrieve IPA license status (v6)' +--- + += Retrieve IPA license status (v6) + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/account/{accountId}/serial-number/{serialNumber}/status/v6`# + + + +Retrieves an IPA license status (V6). + + + + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|serialNumber +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nssKeyId +|string +|True +a| + +|version +|integer +|False +a| + +|op +|string +|False +a| + +|package +|string +|True +a| + +|source +|string +|False +a| + +|hostId +|string +|False +a| + +|requestType +|string +|False +a| + +|product +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nssKeyId": "string", + "op": "string", + "package": "string", + "source": "string", + "hostId": "string", + "requestType": "string", + "product": "string" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-account-src-nss-key-dst-nss_key-resource-.adoc b/ipa/post-ipa-account-src-nss-key-dst-nss_key-resource-.adoc new file mode 100644 index 00000000..e813cc91 --- /dev/null +++ b/ipa/post-ipa-account-src-nss-key-dst-nss_key-resource-.adoc @@ -0,0 +1,109 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-account-src-nss-key-dst-nss_key-resource-.html' +summary: 'Update a resource NetApp Support Site key' +--- + += Update a resource NetApp Support Site key + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/account/{accountId}/src-nss-key/{srcNssKeyId}/dst-nss_key/{dstNssKeyId}/resource/{resourceId}`# + + + +Transfers the source NetApp Support Site data to the destination NetApp Support Site key of the associated resource. + + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|srcNssKeyId +|string +|path +|True +a| + +|dstNssKeyId +|string +|path +|True +a| + +|resourceId +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-authenticate-v5.adoc b/ipa/post-ipa-authenticate-v5.adoc new file mode 100644 index 00000000..63371514 --- /dev/null +++ b/ipa/post-ipa-authenticate-v5.adoc @@ -0,0 +1,106 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-authenticate-v5.html' +summary: 'Authenticate an IPA license (v5)' +--- + += Authenticate an IPA license (v5) + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/authenticate/v5`# + + + +Authenticates an IPA license (V5). + + + + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nssUsername +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nssUsername": "string" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-serial-number-deregister.adoc b/ipa/post-ipa-serial-number-deregister.adoc new file mode 100644 index 00000000..1daae434 --- /dev/null +++ b/ipa/post-ipa-serial-number-deregister.adoc @@ -0,0 +1,120 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-serial-number-deregister.html' +summary: 'Deregister a license' +--- + += Deregister a license + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/serial-number/{serialNumber}/deregister`# + + + +Deregisters a license from IPA. + + + + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|serialNumber +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudAccountId +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "cloudAccountId": "string" +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-serial-number-registration-status.adoc b/ipa/post-ipa-serial-number-registration-status.adoc new file mode 100644 index 00000000..f729ea90 --- /dev/null +++ b/ipa/post-ipa-serial-number-registration-status.adoc @@ -0,0 +1,161 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-serial-number-registration-status.html' +summary: 'Retrieve license status' +--- + += Retrieve license status + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/serial-number/{serialNumber}/registration-status`# + + + +Retrieves the license registration status. + + + + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|serialNumber +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountId": "string" +} +==== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|status +|string +|False +a| + +|statusDescription +|string +|False +a| + +|contractEndDate +|string +|False +a| + +|contractStartDate +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "status": "string", + "statusDescription": "string", + "contractEndDate": "string", + "contractStartDate": "string" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-services-account-sn-lookup-token.adoc b/ipa/post-ipa-services-account-sn-lookup-token.adoc new file mode 100644 index 00000000..2dc1b169 --- /dev/null +++ b/ipa/post-ipa-services-account-sn-lookup-token.adoc @@ -0,0 +1,211 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-services-account-sn-lookup-token.html' +summary: 'Retrieve an IPA serial number token' +--- + += Retrieve an IPA serial number token + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/services/account/{accountId}/sn-lookup-token`# + + + +Retrieves an IPA serial number token. + + + + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|grantType +|string +|True +a| + +|scope +|string +|True +a| + +|nssKeyId +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "grantType": "string", + "scope": "string", + "nssKeyId": "string" +} +==== + +== Response + +``` +Status: 200, Successful serial number lookup token response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|expires_in +|integer +|False +a| + +|token_type +|string +|False +a| + +|refresh_token +|string +|False +a| + +|access_token +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "token_type": "string", + "refresh_token": "string", + "access_token": "string" +} +==== + +== Response + +``` +Status: 4xx, Client error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + +== Response + +``` +Status: 5xx, Server error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-services-sn-lookup.adoc b/ipa/post-ipa-services-sn-lookup.adoc new file mode 100644 index 00000000..8faf4231 --- /dev/null +++ b/ipa/post-ipa-services-sn-lookup.adoc @@ -0,0 +1,175 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-services-sn-lookup.html' +summary: 'Retrieve an IPA serial number' +--- + += Retrieve an IPA serial number + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/services/sn-lookup`# + + + +Retrieves an IPA serial number. + + + + +*Token usage:* NetApp Console service token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|snLookupAccessToken +|string +|True +a| + +|serialNumber +|string +|False +a| + +|licensesLicenseProtocol +|string +|False +a| + +|licensesType +|string +|False +a| + +|hostId +|string +|False +a| + +|licensesPackage +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "snLookupAccessToken": "string", + "serialNumber": "string", + "licensesLicenseProtocol": "string", + "licensesType": "string", + "hostId": "string", + "licensesPackage": "string" +} +==== + +== Response + +``` +Status: 4xx, Client error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + +== Response + +``` +Status: 5xx, Server error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-support-case-create.adoc b/ipa/post-ipa-support-case-create.adoc new file mode 100644 index 00000000..56f31c6e --- /dev/null +++ b/ipa/post-ipa-support-case-create.adoc @@ -0,0 +1,208 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-support-case-create.html' +summary: 'Create a support case' +--- + += Create a support case + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/support/case/create`# + + + +Creates a support case. + + + + +*Token usage:* Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|True +a| + +|additionalEmail +|string +|False +a| + +|attributeMap +|link:#attributeMap[attributeMap] +|False +a| + +|caseDescription +|string +|False +a| + +|priority +| +|False +a| + +|caseTitle +|string +|False +a| + +|serialNumber +|string +|True +a| + +|nssKeyId +|string +|True +a| + +|category1 +|integer +|False +a| + +|category2 +|integer +|False +a| + +|node +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountId": "string", + "additionalEmail": "string", + "caseDescription": "string", + "priority": "P1", + "caseTitle": "string", + "serialNumber": "string", + "nssKeyId": "string", + "node": "string" +} +==== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|caseNumber +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "caseNumber": "string" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#attributeMap] +[.api-collapsible-fifth-title] +attributeMap + + +//end collapsible .Definitions block +==== diff --git a/ipa/post-ipa-support-case-system-entitlements.adoc b/ipa/post-ipa-support-case-system-entitlements.adoc new file mode 100644 index 00000000..dbb03a34 --- /dev/null +++ b/ipa/post-ipa-support-case-system-entitlements.adoc @@ -0,0 +1,155 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-support-case-system-entitlements.html' +summary: 'Check system entitlements' +--- + += Check system entitlements + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/support/case/system-entitlements`# + + + +Checks system entitlements for a specified serial number. This checks whether a user is entitled to create a case for the requested serial number. + + + + +*Token usage:* Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serialNumber +|string +|True +a| + +|email +|string +|False +a| + +|nssKeyId +|string +|False +a| + +|accountId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serialNumber": "string", + "email": "string", + "nssKeyId": "string", + "accountId": "string" +} +==== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|ntapUID +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "ntapUID": "string" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/post-ipa-support-case-upload.adoc b/ipa/post-ipa-support-case-upload.adoc new file mode 100644 index 00000000..5f80d1bd --- /dev/null +++ b/ipa/post-ipa-support-case-upload.adoc @@ -0,0 +1,169 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/post-ipa-support-case-upload.html' +summary: 'Upload an attachment for a support case' +--- + += Upload an attachment for a support case + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/ipa/support/case/{caseNumber}/upload`# + + + +Uploads an attachment file to a support case. + + + + +*Token usage:* Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|caseNumber +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nssKeyId +|string +|True +a| + +|accountId +|string +|True +a| + +|fileName +|string +|True +a|Case attachment file + + +|fileDescription +|string +|True +a|Case attachment file description + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nssKeyId": "string", + "accountId": "string", + "fileName": "string", + "fileDescription": "string" +} +==== + +== Response + +``` +Status: 200, Default Response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|uploadStatus +|string +|False +a| + +|fileName +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "uploadStatus": "string", + "fileName": "string" +} +==== + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/put-ipa-account-nss-key-.adoc b/ipa/put-ipa-account-nss-key-.adoc new file mode 100644 index 00000000..a357fe4c --- /dev/null +++ b/ipa/put-ipa-account-nss-key-.adoc @@ -0,0 +1,132 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/put-ipa-account-nss-key-.html' +summary: 'Update NetApp Support Site key credentials' +--- + += Update NetApp Support Site key credentials + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/ipa/account/{accountId}/nss-key/{nssKeyId}`# + + + +Updates NetApp Support Site key credentials. + + + + +*Token usage:* NetApp Console user token. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|nssKeyId +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|username +|string +|False +a| + +|password +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "username": "string", + "password": "string" +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/put-ipa-support-case-.adoc b/ipa/put-ipa-support-case-.adoc new file mode 100644 index 00000000..0a7d7880 --- /dev/null +++ b/ipa/put-ipa-support-case-.adoc @@ -0,0 +1,138 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/put-ipa-support-case-.html' +summary: 'Update support case notes or status' +--- + += Update support case notes or status + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/ipa/support/case/{caseNumber}`# + + + +Updates the support case notes or status. + + + + +*Token usage:* Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|caseNumber +|string +|path +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|nssKeyId +|string +|False +a| + +|accountId +|string +|False +a| + +|caseNote +|string +|False +a| + +|changeCaseStatus +| +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "nssKeyId": "string", + "accountId": "string", + "caseNote": "string", + "changeCaseStatus": "close" +} +==== + +== Response + +``` +Status: 200, Success response +``` + + + +== Response + +``` +Status: 4xx, Error response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|error +|string +|False +a|Error code/category + + +|message +|string +|False +a|Error description message + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "error": "string", + "message": "string" +} +==== + diff --git a/ipa/services_overview.adoc b/ipa/services_overview.adoc new file mode 100644 index 00000000..4340ee39 --- /dev/null +++ b/ipa/services_overview.adoc @@ -0,0 +1,24 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/services_overview.html' +summary: 'Services endpoints in the In-Product Automation REST API for the NetApp Console' +--- + += Services endpoints in the In-Product Automation REST API for the NetApp Console + + + +The services endpoint performs the NetApp IPA serial number (sn) lookup and serial number token lookup operations. + +You need a serial number lookup token to retrieve a serial number. You can retrieve both a serial number and a lookup token by using this endpoint. + +To retrieve a serial number token (sn-token), the NetApp Console IPA services endpoint consults the `sn-lookup-service` endpoint. + +To retrieve a serial number (sn-lookup), the NetApp Console IPA services endpoint consults the `sn-service` endpoint. + +You can perform the following operations with the IPA services endpoint: + +* Retrieve a serial number lookup token +* Retrieve a serial number + + diff --git a/ipa/sidebar.yml b/ipa/sidebar.yml deleted file mode 100644 index e3f66027..00000000 --- a/ipa/sidebar.yml +++ /dev/null @@ -1,3 +0,0 @@ -section: ipa -title: IPA -generate: ipa diff --git a/ipa/support_overview.adoc b/ipa/support_overview.adoc new file mode 100644 index 00000000..8a806066 --- /dev/null +++ b/ipa/support_overview.adoc @@ -0,0 +1,20 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'ipa/support_overview.html' +summary: 'Support endpoints in the In-Product Automation REST API for the NetApp Console' +--- + += Support endpoints in the In-Product Automation REST API for the NetApp Console + + + +The support endpoint performs the case system entitlements and case creation operations. + +You can perform the following operations with the IPA support endpoint: + +* Check system entitlements for serial number - this checks if the user is entitled to create a case for the requested serial number. +* Create a support case + + diff --git a/media/console-menu.png b/media/console-menu.png deleted file mode 100644 index 79c2998b..00000000 Binary files a/media/console-menu.png and /dev/null differ diff --git a/media/icon-agent.png b/media/icon-agent.png deleted file mode 100644 index 961c2e4a..00000000 Binary files a/media/icon-agent.png and /dev/null differ diff --git a/platform/get_identifiers.adoc b/platform/get_identifiers.adoc index d0dd557d..5266d7bd 100644 --- a/platform/get_identifiers.adoc +++ b/platform/get_identifiers.adoc @@ -19,7 +19,7 @@ In addition to the Console web user interface, you can also obtain the ID values == Get the Console agent identifier -Every Console agent is assigned a unique identifier. You can retrieve system the ID for a Console agent and include it in the `x-agent-id` HTTP request header with each REST API call. +Every Console agent is assigned a unique identifier. You can retrieve the system ID for a Console agent and include it in the `x-agent-id` HTTP request header with each REST API call. .Before you begin @@ -35,20 +35,17 @@ link:https://console.netapp.com/[https://console.netapp.com^] . Select *Administration > Support > Agents*. + -You can find the console agent system ID at the top of the page. +You can find the Console agent system ID at the top of the page. -. You can optionally derive the associated client ID by removing the `clients` suffix. This ID applies when accessing the agent directly in _local mode_ and not through the SaaS interface. -+ -*Example* -`uzJbMFKEnuzi2ryLaENbCP52KBTXx0aI` +. Hover and select the ID to copy it. .After you finish -You can use the agent ID in the `x-agent-id` request header to properly route the request. See the curl examples in the workflows for more information. +You can use the Console agent system ID in the `x-agent-id` request header to properly route the request. See the curl examples in the workflows for more information. == Get the account identifier -Several of the workflows require the account identifier. The following steps show how to obtain the unique identifier for an account. +Several of the workflows require the account identifier. The steps needed to obtain the unique identifier for an account are presented below. .About this task @@ -66,8 +63,6 @@ link:https://console.netapp.com/[https://console.netapp.com^] . Sign in using your account credentials for the Console. -. Select the image:./console-menu.png[hamburger] icon at the top left of the page. +. Click the *Account* drop-down and click *Manage Account* for the selected account. -. Select *Administration* and then select *Identity and access*. -+ -Your account ID is shown at the top of the *Organization* page. +. In the *Overview* section copy the *Account ID* value. diff --git a/platform/grant_types.adoc b/platform/grant_types.adoc index 07bfdddc..89b140ac 100644 --- a/platform/grant_types.adoc +++ b/platform/grant_types.adoc @@ -18,6 +18,12 @@ There are several OAuth 2.0 grant types available when requesting an access toke [TIP] The refresh token grant is the most secure option when requesting a user access token. It can be used in both a federated and non-federated authentication environment. +== Authentication endpoint + +All grant types use the following authentication endpoint to request an access token: + +`POST \https://netapp-cloud-account.auth0.com/oauth/token` + == Refresh token This grant type generates a token used with either federated or non-federated authentication. You need to provide the OAuth2-compliant refresh token to the authentication endpoint to generate a long-lived access token. The generated token can be used to access resources across multiple domains. Here is an example of the JSON input used when requesting the token with a description of each parameter. @@ -79,9 +85,11 @@ This grant type generates a token used with non-federated authentication to acce |The client ID issued when you registered the application. |=== -== Client credentials +== Client credentials using a NetApp Console service account -In some cases, static clients or applications need to acquire an access token to perform operations on behalf of a user. Applications need to obtain an access token for their own service account without user intervention. In these situations you can use the client credentials grant type. Here is an example of the JSON input used when requesting the token with a description of each parameter. +In some cases, static clients or applications need to acquire an access token to perform operations on behalf of a user. Applications need to obtain an access token for their own service account without user intervention. In these situations you can use the client credentials grant type. To use client credentials, you must create a service account to obtain the client ID and secret. Refer to link:../platform/register_service.html[Register a service with the NetApp Console]. + +The following is a JSON input example for requesting the token with a description of each parameter. [source,json,%autofill] --------------------------------------------------------------------- @@ -109,3 +117,5 @@ In some cases, static clients or applications need to acquire an access token to |=== The OAuth2 server verifies the application through the client ID with client secret and returns an access token in the response. + +// 2026 April 03, GH 9 \ No newline at end of file diff --git a/platform/overview.adoc b/platform/overview.adoc index c22854a2..edab54e8 100644 --- a/platform/overview.adoc +++ b/platform/overview.adoc @@ -13,7 +13,9 @@ summary: The NetApp Console enables you to build, protect, and govern your hybri :imagesdir: ../media/ [.lead] -The NetApp Console enables you to build, protect, and govern your hybrid multi-cloud data from a single control plane. It is composed of several distinct services, each of which exposes an associated REST API. Collectively these services and APIs form a flexible and extensible development platform you can use to administer your cloud-based and on-premises resources. There are several benefits when using the Console REST APIs. +The NetApp Console provides centralized management of NetApp storage and data services across on-premises and cloud environments at enterprise grade. It delivers real-time insights, faster workflows, and simplified administration that is highly secure and compliant. + +The Console is composed of several distinct services, each of which exposes an associated REST API. Collectively these services and APIs form a flexible and extensible development platform you can use to administer your cloud-based and on-premises resources. There are several benefits when using the Console REST APIs. .Built on REST technology and design principles The Console APIs have been designed based on REST technology and current best practices. The core technologies include HTTP and JSON. diff --git a/platform/register_service.adoc b/platform/register_service.adoc index fcbae6ac..85d03462 100644 --- a/platform/register_service.adoc +++ b/platform/register_service.adoc @@ -4,20 +4,19 @@ permalink: platform/register_service.html keywords: generate, user, token, bluexp, rest, apis, account, create, application, netapp, console summary: You can register a service with the NetApp Console and use the associated credentials to create a service token. --- - = Register a service with the NetApp Console :hardbreaks: :nofooter: :icons: font :linkattrs: -:imagesdir: ../media/ +:imagesdir: ./media/ [.lead] You can register a service with the NetApp Console and use the associated credentials to create a service token. The steps you follow depend on whether you want to create a service token using client secret authentication or private key JWT authentication. .Before you begin -* You must have an account for the Console. You created this account when you first logged in to the Console website and it was displayed at the top of the Console user interface. +* You must have an account for the Console. You created this account when you first logged in to the Console website and it was displayed at the top of the Console user interface. See, https://docs.netapp.com/us-en/console-setup-admin/task-sign-up-saas.html[Sign up or log in to NetApp Console^]. * If you plan to use private key JWT authentication to create a service access token, you must have already generated your private/public RSA key or certificate/private key pair. You need to upload the public file during this task. .Steps @@ -28,7 +27,7 @@ link:https://console.netapp.com[https://console.netapp.com^] . Sign in using your NetApp Console credentials or your NetApp Support Site credentials. -. Select the image:./console-menu.png[hamburger] icon at the top left of the page. +. Select the button at the top left of the page to expand the menu options. . Select *Administration* and then select *Identity and access*. @@ -42,7 +41,11 @@ link:https://console.netapp.com[https://console.netapp.com^] -- .. Enter the service account name. -.. Select *Create* to register the application. +.. Provide the following details : +* Choose an organization, folder, or project for the service account +* Select the category +* Select the role +.. Select *Add* to register the application. .. After successfully completing the registration, the associated client ID and client secret are displayed. -- .Use private key JWT authentication @@ -52,7 +55,12 @@ link:https://console.netapp.com[https://console.netapp.com^] .. Upload a valid X.509 certificate or RSA public key. + NOTE: You need to set an expiration date if you upload an RSA public key. The maximum expiration date you can enter is 13 months from the date of upload. If you upload a certificate, the certificate expiration date is automatically extracted. -.. Select *Create* to register the application. + +.. Provide the following details : + +* Choose an organization, folder, or project for the service account +* Select the category +* Select the role .. After successfully completing the registration, the associated client ID and audience values are displayed. -- diff --git a/project.yml b/project.yml index fc8a20cf..89840505 100644 --- a/project.yml +++ b/project.yml @@ -1,365 +1,21034 @@ -settings: - name: API - internal: - pdf_enabled: false - api_enabled: true - api_standardize: false - api_preserve_adoc: true - prod: - pdf_enabled: false - api_enabled: true - harmony_enabled: false - api_standardize: false - api_preserve_adoc: true -sidebar: - entries: - - title: NetApp Console API docs - url: /index.html - - section: platform - - section: workflows - - title: ONTAP management - entries: - - title: Get started - entries: - - title: Learn about the ONTAP management REST APIs - url: /cm/overview.html - - title: Prepare - url: /cm/prepare.html - - title: Your first API call - url: /cm/your_api_call.html - - title: Workflow processes - url: /cm/workflow_processes.html - - title: Cloud Volumes ONTAP workflows - entries: - - title: Prepare to use the workflows - url: /cm/wf_cvo_before.html - - title: Typical deployment - url: /cm/cvo_deployment.html - - title: AWS workflows - entries: - - - title: Systems - entries: - - title: Create a system with a capacity-based license - url: /cm/wf_aws_cloud_create_we_capacity.html - - title: Create a system with PAYGO (node-based) - url: /cm/wf_aws_cloud_create_we_paygo.html - - title: Create a system with BYOL (node-based) - url: /cm/wf_aws_cloud_create_we_byol.html - - title: Get systems - url: /cm/wf_aws_cloud_get_wes.html - - title: Delete a system - url: /cm/wf_aws_cloud_delete_we.html - - title: Create a CIFS server configuration - url: /cm/wf_aws_ontap_create_cifs.html - - title: Get CIFS configurations - url: /cm/wf_aws_ontap_get_cifs.html - - title: Delete a CIFS server configuration - url: /cm/wf_aws_ontap_delete_cifs.html - - title: Aggregates - entries: - - title: Add a capacity to an EV aggregate - url: /cm/wf_aws_cloud_add_capacity.html - - title: Get aggregates - url: /cm/wf_aws_ontap_get_aggrs.html - - title: Create an aggregate - url: /cm/wf_aws_ontap_create_aggr.html - - title: Add disks to an aggregate - url: /cm/wf_aws_ontap_add_disks_aggr.html - - title: Delete an aggregate - url: /cm/wf_aws_ontap_delete_aggr.html - - title: Volumes - entries: - - title: Create a volume using NFS - url: /cm/wf_aws_ontap_create_vol_nfs.html - - title: Create a volume using CIFS - url: /cm/wf_aws_ontap_create_vol_cifs.html - - title: Create a volume using iSCSI - url: /cm/wf_aws_ontap_create_vol_iscsi.html - - title: Get volumes - url: /cm/wf_aws_ontap_get_volumes.html - - title: Modify a volume - url: /cm/wf_aws_ontap_modify_volume.html - - title: Delete a volume - url: /cm/wf_aws_ontap_delete_volume.html - - title: Create a quote - url: /cm/wf_aws_ontap_create_quote.html - - title: Get iGroups - url: /cm/wf_aws_ontap_get_igroups.html - - title: Metadata - entries: - - title: Get regions - url: /cm/wf_aws_cloud_md_get_regions.html - - title: Get permutations - url: /cm/wf_aws_cloud_md_get_permutations.html - - title: Get virtual private clouds - url: /cm/wf_aws_cloud_md_get_vpcs.html - - title: Get EBS volume types - url: /cm/wf_aws_cloud_md_get_ebs_vol_types.html - - title: Get packages - url: /cm/wf_aws_cloud_md_get_packages.html - - title: Get route tables - url: /cm/wf_aws_cloud_md_get_route_tables.html - - title: Get key pairs - url: /cm/wf_aws_cloud_md_get_key_pairs.html - - title: Miscellaneous - entries: - - title: Create an AWS cloud provider account - url: /cm/wf_aws_cloud_md_create_account.html - - title: Azure workflows - entries: - - - title: Systems - entries: - - title: Create a system with a capacity-based license - url: /cm/wf_azure_cloud_create_we_capacity.html - - title: Create a system with PAYGO (node-based) - url: /cm/wf_azure_cloud_create_we_paygo.html - - title: Create a system with BYOL (node-based) - url: /cm/wf_azure_cloud_create_we_byol.html - - title: Get systems - url: /cm/wf_azure_cloud_get_wes.html - - title: Delete a system - url: /cm/wf_azure_cloud_delete_we.html - - title: Create a CIFS server configuration - url: /cm/wf_azure_ontap_create_cifs.html - - title: Get CIFS configurations - url: /cm/wf_azure_ontap_get_cifs.html - - title: Delete a CIFS server configuration - url: /cm/wf_azure_ontap_delete_cifs.html - - title: Aggregates - entries: - - title: Get aggregates - url: /cm/wf_azure_ontap_get_aggrs.html - - title: Create an aggregate - url: /cm/wf_azure_ontap_create_aggr.html - - title: Add disks to an aggregate - url: /cm/wf_azure_ontap_add_disks_aggr.html - - title: Delete an aggregate - url: /cm/wf_azure_ontap_delete_aggr.html - - title: Volumes - entries: - - title: Create a volume using NFS - url: /cm/wf_azure_ontap_create_vol_nfs.html - - title: Create a volume using CIFS - url: /cm/wf_azure_ontap_create_vol_cifs.html - - title: Create a volume using iSCSI - url: /cm/wf_azure_ontap_create_vol_iscsi.html - - title: Get volumes - url: /cm/wf_azure_ontap_get_volumes.html - - title: Modify a volume - url: /cm/wf_azure_ontap_modify_volume.html - - title: Delete a volume - url: /cm/wf_azure_ontap_delete_volume.html - - title: Create a quote - url: /cm/wf_azure_ontap_create_quote.html - - title: Get iGroups - url: /cm/wf_azure_ontap_get_igroups.html - - title: Metadata - entries: - - title: Get Azure regions - url: /cm/wf_azure_cloud_md_get_regions.html - - title: Get Azure permutations - url: /cm/wf_azure_cloud_md_get_permutations.html - - title: Get Azure storage account types - url: /cm/wf_azure_cloud_md_get_storage_account_types.html - - title: Get Azure VNets - url: /cm/wf_azure_cloud_md_get_vnets.html - - title: Get Azure availability zones - url: /cm/wf_azure_cloud_md_get_availability_zones.html - - title: Get Azure packages - url: /cm/wf_azure_cloud_md_get_packages.html - - title: Miscellaneous - entries: - - title: Create an Azure cloud provider account - url: /cm/wf_azure_cloud_md_create_account.html - - title: Google Cloud workflows - entries: - - - title: Systems - entries: - - title: Create a system with a capacity-based license - url: /cm/wf_gcp_cloud_create_we_capacity.html - - title: Create a system with PAYGO (node-based) - url: /cm/wf_gcp_cloud_create_we_paygo.html - - title: Create a system with BYOL (node-based) - url: /cm/wf_gcp_cloud_create_we_byol.html - - title: Get systems - url: /cm/wf_gcp_cloud_get_wes.html - - title: Delete a system - url: /cm/wf_gcp_cloud_delete_we.html - - title: Create a CIFS server configuration - url: /cm/wf_gcp_ontap_create_cifs.html - - title: Get CIFS server configurations - url: /cm/wf_gcp_ontap_get_cifs.html - - title: Delete a CIFS server configuration - url: /cm/wf_gcp_ontap_delete_cifs.html - - title: Aggregates - entries: - - title: Get aggregates - url: /cm/wf_gcp_ontap_get_aggrs.html - - title: Create an aggregate - url: /cm/wf_gcp_ontap_create_aggr.html - - title: Add disks to an aggregate - url: /cm/wf_gcp_ontap_add_disks_aggr.html - - title: Delete an aggregate - url: /cm/wf_gcp_ontap_delete_aggr.html - - title: Volumes - entries: - - title: Create a volume using NFS - url: /cm/wf_gcp_ontap_create_vol_nfs.html - - title: Create a volume using CIFS - url: /cm/wf_gcp_ontap_create_vol_cifs.html - - title: Create a volume using iSCSI - url: /cm/wf_gcp_ontap_create_vol_iscsi.html - - title: Get volumes - url: /cm/wf_gcp_ontap_get_volumes.html - - title: Modify a volume - url: /cm/wf_gcp_ontap_modify_volume.html - - title: Delete a volume - url: /cm/wf_gcp_ontap_delete_volume.html - - title: Create a quote - url: /cm/wf_gcp_ontap_create_quote.html - - title: Get iGroups - url: /cm/wf_gcp_ontap_get_igroups.html - - title: Metadata - entries: - - title: Get Google Cloud regions - url: /cm/wf_gcp_cloud_md_get_regions.html - - title: Get permutations - url: /cm/wf_gcp_cloud_md_get_permutations.html - - title: Get tag keys - url: /cm/wf_gcp_cloud_md_get_tag_keys.html - - title: Create buckets - url: /cm/wf_gcp_cloud_md_create_buckets.html - - title: Get buckets - url: /cm/wf_gcp_cloud_md_get_buckets.html - - title: Get Google Cloud packages - url: /cm/wf_gcp_cloud_md_get_packages.html - - title: Get snapshot policies - url: /cm/wf_gcp_cloud_md_snapshot_policies.html - - title: Get supported features - url: /cm/wf_gcp_cloud_md_get_supported_features.html - - title: Get supported capacity tiers - url: /cm/wf_gcp_cloud_md_get_supported_tiers.html - - title: Get service accounts - url: /cm/wf_gcp_cloud_md_get_service_accounts.html - - title: Get projects - url: /cm/wf_gcp_cloud_md_get_projects.html - - title: Get Google Cloud encryption keys - url: /cm/wf_gcp_cloud_md_get_encryption_keys.html - - title: Get disk types - url: /cm/wf_gcp_cloud_md_get_disk_types.html - - title: Get instance types - url: /cm/wf_gcp_cloud_md_get_instance_type_nosupport.html - - title: Get VPCs - url: /cm/wf_gcp_cloud_md_get_vpcs.html - - title: Get zones - url: /cm/wf_gcp_cloud_md_get_zones.html - - title: On-premises ONTAP cluster workflows - entries: - - title: Prepare to use the workflows - url: /cm/wf_onprem_before.html - - title: Systems - entries: - - title: Get systems - url: /cm/wf_onprem_get_wes.html - - title: Discover systems - url: /cm/wf_onprem_discover_wes.html - - title: Volumes - entries: - - title: Create a volume using NFS - url: /cm/wf_onprem_ontap_create_vol_nfs.html - - title: Create a volume using CIFS - url: /cm/wf_onprem_ontap_create_vol_cifs.html - - title: Create a volume using iSCSI - url: /cm/wf_onprem_ontap_create_vol_iscsi.html - - title: Create a FlexGroup volume - url: /cm/wf_onprem_flexgroup_ontap_create_vol.html - - title: Get volumes - url: /cm/wf_onprem_ontap_get_volumes.html - - title: Modify a volume - url: /cm/wf_onprem_ontap_modify_volume.html - - title: Delete a volume - url: /cm/wf_onprem_ontap_delete_volume.html - - title: Aggregates - entries: - - title: Get aggregates - url: /cm/wf_onprem_ontap_get_aggrs.html - - - title: ONTAP management common workflows - entries: - - title: Prepare to use the workflows - url: /cm/wf_common_before.html - - title: Identity and access - entries: - - title: Get supported services - url: /cm/wf_common_identity_get_supported_srv.html - - title: Get cloud provider accounts - url: /cm/wf_common_identity_get_provider_accounts.html - - title: Get tenants - url: /cm/wf_common_identity_get_tenants.html - - title: SaaS marketplace - entries: - - title: Get SaaS marketplace account - url: /cm/wf_common_identity_get_saas_mp.html - - title: Attach a subscription - url: /cm/wf_common_occm_attach_subscription.html - - title: NetApp Support Site - entries: - - title: Create an NSS ID - url: /cm/wf_common_identity_create_nss_key.html - - title: Get an NSS ID - url: /cm/wf_common_identity_get_nss_key.html - - title: Get an NSS IDs - url: /cm/wf_common_identity_get_nss_keys.html - - title: Delete an NSS ID - url: /cm/wf_common_identity_delete_nss_key.html - - title: Internal tasks and support - entries: - - title: Get an active task - url: /cm/wf_common_occm_get_task.html - - title: SnapMirror replication - entries: - - title: Create a relationship - url: /cm/wf_common_ontap_repl_create_repl.html - - title: Update a relationship - url: /cm/wf_common_ontap_repl_update_repl.html - - title: Delete a relationship - url: /cm/wf_common_ontap_repl_delete_repl.html - - title: Get relationships - url: /cm/wf_common_ontap_repl_get_sm_rels.html - - title: Get the relationships status - url: /cm/wf_common_ontap_repl_get_rel_status.html - - title: Get relationship status for a system - url: /cm/wf_common_ontap_repl_get_rel_we_status.html - - title: Get intercluster LIFs - url: /cm/wf_common_ontap_repl_get_ic_lifs.html - - title: Get schedules for a system - url: /cm/wf_common_ontap_repl_get_we_schedules.html - - title: Get SnapMirror policies - url: /cm/wf_common_ontap_md_get_snapmirror_policies.html - - title: Get SnapMirror SVM policies - url: /cm/wf_common_ontap_md_get_snapmirror_svm_policies.html - - section: cvo - - section: tenancy - - section: fsx - - section: audit - - section: cbs - - section: copysync - - section: credential - - section: dw - - section: federation - - section: ipa - - section: tenancyv4 - - section: automate - - section: support - - title: Legal notices - url: /legal-notices.html -product-family: - name: NetApp Console - repo: console-family - - - - +--- +settings: + name: API + internal: + pdf_enabled: false + prod: + pdf_enabled: false + harmony_enabled: false +sidebar: + entries: + - title: NetApp Console API docs + url: "/index.html" + - section: platform + - section: workflows + - title: ONTAP management + entries: + - title: Get started + entries: + - title: Learn about the ONTAP management REST APIs + url: "/cm/overview.html" + - title: Prepare + url: "/cm/prepare.html" + - title: Your first API call + url: "/cm/your_api_call.html" + - title: Workflow processes + url: "/cm/workflow_processes.html" + - title: Cloud Volumes ONTAP workflows + entries: + - title: Prepare to use the workflows + url: "/cm/wf_cvo_before.html" + - title: Typical deployment + url: "/cm/cvo_deployment.html" + - title: AWS workflows + entries: + - title: Systems + entries: + - title: Create a system with a capacity-based license + url: "/cm/wf_aws_cloud_create_we_capacity.html" + - title: Create a system with PAYGO (node-based) + url: "/cm/wf_aws_cloud_create_we_paygo.html" + - title: Create a system with BYOL (node-based) + url: "/cm/wf_aws_cloud_create_we_byol.html" + - title: Get systems + url: "/cm/wf_aws_cloud_get_wes.html" + - title: Delete a system + url: "/cm/wf_aws_cloud_delete_we.html" + - title: Create a CIFS server configuration + url: "/cm/wf_aws_ontap_create_cifs.html" + - title: Get CIFS configurations + url: "/cm/wf_aws_ontap_get_cifs.html" + - title: Delete a CIFS server configuration + url: "/cm/wf_aws_ontap_delete_cifs.html" + - title: Aggregates + entries: + - title: Add a capacity to an EV aggregate + url: "/cm/wf_aws_cloud_add_capacity.html" + - title: Get aggregates + url: "/cm/wf_aws_ontap_get_aggrs.html" + - title: Create an aggregate + url: "/cm/wf_aws_ontap_create_aggr.html" + - title: Add disks to an aggregate + url: "/cm/wf_aws_ontap_add_disks_aggr.html" + - title: Delete an aggregate + url: "/cm/wf_aws_ontap_delete_aggr.html" + - title: Volumes + entries: + - title: Create a volume using NFS + url: "/cm/wf_aws_ontap_create_vol_nfs.html" + - title: Create a volume using CIFS + url: "/cm/wf_aws_ontap_create_vol_cifs.html" + - title: Create a volume using iSCSI + url: "/cm/wf_aws_ontap_create_vol_iscsi.html" + - title: Get volumes + url: "/cm/wf_aws_ontap_get_volumes.html" + - title: Modify a volume + url: "/cm/wf_aws_ontap_modify_volume.html" + - title: Delete a volume + url: "/cm/wf_aws_ontap_delete_volume.html" + - title: Create a quote + url: "/cm/wf_aws_ontap_create_quote.html" + - title: Get iGroups + url: "/cm/wf_aws_ontap_get_igroups.html" + - title: Metadata + entries: + - title: Get regions + url: "/cm/wf_aws_cloud_md_get_regions.html" + - title: Get permutations + url: "/cm/wf_aws_cloud_md_get_permutations.html" + - title: Get virtual private clouds + url: "/cm/wf_aws_cloud_md_get_vpcs.html" + - title: Get EBS volume types + url: "/cm/wf_aws_cloud_md_get_ebs_vol_types.html" + - title: Get packages + url: "/cm/wf_aws_cloud_md_get_packages.html" + - title: Get route tables + url: "/cm/wf_aws_cloud_md_get_route_tables.html" + - title: Get key pairs + url: "/cm/wf_aws_cloud_md_get_key_pairs.html" + - title: Miscellaneous + entries: + - title: Create an AWS cloud provider account + url: "/cm/wf_aws_cloud_md_create_account.html" + - title: Azure workflows + entries: + - title: Systems + entries: + - title: Create a system with a capacity-based license + url: "/cm/wf_azure_cloud_create_we_capacity.html" + - title: Create a system with PAYGO (node-based) + url: "/cm/wf_azure_cloud_create_we_paygo.html" + - title: Create a system with BYOL (node-based) + url: "/cm/wf_azure_cloud_create_we_byol.html" + - title: Get systems + url: "/cm/wf_azure_cloud_get_wes.html" + - title: Delete a system + url: "/cm/wf_azure_cloud_delete_we.html" + - title: Create a CIFS server configuration + url: "/cm/wf_azure_ontap_create_cifs.html" + - title: Get CIFS configurations + url: "/cm/wf_azure_ontap_get_cifs.html" + - title: Delete a CIFS server configuration + url: "/cm/wf_azure_ontap_delete_cifs.html" + - title: Aggregates + entries: + - title: Get aggregates + url: "/cm/wf_azure_ontap_get_aggrs.html" + - title: Create an aggregate + url: "/cm/wf_azure_ontap_create_aggr.html" + - title: Add disks to an aggregate + url: "/cm/wf_azure_ontap_add_disks_aggr.html" + - title: Delete an aggregate + url: "/cm/wf_azure_ontap_delete_aggr.html" + - title: Volumes + entries: + - title: Create a volume using NFS + url: "/cm/wf_azure_ontap_create_vol_nfs.html" + - title: Create a volume using CIFS + url: "/cm/wf_azure_ontap_create_vol_cifs.html" + - title: Create a volume using iSCSI + url: "/cm/wf_azure_ontap_create_vol_iscsi.html" + - title: Get volumes + url: "/cm/wf_azure_ontap_get_volumes.html" + - title: Modify a volume + url: "/cm/wf_azure_ontap_modify_volume.html" + - title: Delete a volume + url: "/cm/wf_azure_ontap_delete_volume.html" + - title: Create a quote + url: "/cm/wf_azure_ontap_create_quote.html" + - title: Get iGroups + url: "/cm/wf_azure_ontap_get_igroups.html" + - title: Metadata + entries: + - title: Get Azure regions + url: "/cm/wf_azure_cloud_md_get_regions.html" + - title: Get Azure permutations + url: "/cm/wf_azure_cloud_md_get_permutations.html" + - title: Get Azure storage account types + url: "/cm/wf_azure_cloud_md_get_storage_account_types.html" + - title: Get Azure VNets + url: "/cm/wf_azure_cloud_md_get_vnets.html" + - title: Get Azure availability zones + url: "/cm/wf_azure_cloud_md_get_availability_zones.html" + - title: Get Azure packages + url: "/cm/wf_azure_cloud_md_get_packages.html" + - title: Miscellaneous + entries: + - title: Create an Azure cloud provider account + url: "/cm/wf_azure_cloud_md_create_account.html" + - title: Google Cloud workflows + entries: + - title: Systems + entries: + - title: Create a system with a capacity-based license + url: "/cm/wf_gcp_cloud_create_we_capacity.html" + - title: Create a system with PAYGO (node-based) + url: "/cm/wf_gcp_cloud_create_we_paygo.html" + - title: Create a system with BYOL (node-based) + url: "/cm/wf_gcp_cloud_create_we_byol.html" + - title: Get systems + url: "/cm/wf_gcp_cloud_get_wes.html" + - title: Delete a system + url: "/cm/wf_gcp_cloud_delete_we.html" + - title: Create a CIFS server configuration + url: "/cm/wf_gcp_ontap_create_cifs.html" + - title: Get CIFS server configurations + url: "/cm/wf_gcp_ontap_get_cifs.html" + - title: Delete a CIFS server configuration + url: "/cm/wf_gcp_ontap_delete_cifs.html" + - title: Aggregates + entries: + - title: Get aggregates + url: "/cm/wf_gcp_ontap_get_aggrs.html" + - title: Create an aggregate + url: "/cm/wf_gcp_ontap_create_aggr.html" + - title: Add disks to an aggregate + url: "/cm/wf_gcp_ontap_add_disks_aggr.html" + - title: Delete an aggregate + url: "/cm/wf_gcp_ontap_delete_aggr.html" + - title: Volumes + entries: + - title: Create a volume using NFS + url: "/cm/wf_gcp_ontap_create_vol_nfs.html" + - title: Create a volume using CIFS + url: "/cm/wf_gcp_ontap_create_vol_cifs.html" + - title: Create a volume using iSCSI + url: "/cm/wf_gcp_ontap_create_vol_iscsi.html" + - title: Get volumes + url: "/cm/wf_gcp_ontap_get_volumes.html" + - title: Modify a volume + url: "/cm/wf_gcp_ontap_modify_volume.html" + - title: Delete a volume + url: "/cm/wf_gcp_ontap_delete_volume.html" + - title: Create a quote + url: "/cm/wf_gcp_ontap_create_quote.html" + - title: Get iGroups + url: "/cm/wf_gcp_ontap_get_igroups.html" + - title: Metadata + entries: + - title: Get Google Cloud regions + url: "/cm/wf_gcp_cloud_md_get_regions.html" + - title: Get permutations + url: "/cm/wf_gcp_cloud_md_get_permutations.html" + - title: Get tag keys + url: "/cm/wf_gcp_cloud_md_get_tag_keys.html" + - title: Create buckets + url: "/cm/wf_gcp_cloud_md_create_buckets.html" + - title: Get buckets + url: "/cm/wf_gcp_cloud_md_get_buckets.html" + - title: Get Google Cloud packages + url: "/cm/wf_gcp_cloud_md_get_packages.html" + - title: Get snapshot policies + url: "/cm/wf_gcp_cloud_md_snapshot_policies.html" + - title: Get supported features + url: "/cm/wf_gcp_cloud_md_get_supported_features.html" + - title: Get supported capacity tiers + url: "/cm/wf_gcp_cloud_md_get_supported_tiers.html" + - title: Get service accounts + url: "/cm/wf_gcp_cloud_md_get_service_accounts.html" + - title: Get projects + url: "/cm/wf_gcp_cloud_md_get_projects.html" + - title: Get Google Cloud encryption keys + url: "/cm/wf_gcp_cloud_md_get_encryption_keys.html" + - title: Get disk types + url: "/cm/wf_gcp_cloud_md_get_disk_types.html" + - title: Get instance types + url: "/cm/wf_gcp_cloud_md_get_instance_type_nosupport.html" + - title: Get VPCs + url: "/cm/wf_gcp_cloud_md_get_vpcs.html" + - title: Get zones + url: "/cm/wf_gcp_cloud_md_get_zones.html" + - title: On-premises ONTAP cluster workflows + entries: + - title: Prepare to use the workflows + url: "/cm/wf_onprem_before.html" + - title: Systems + entries: + - title: Get systems + url: "/cm/wf_onprem_get_wes.html" + - title: Discover systems + url: "/cm/wf_onprem_discover_wes.html" + - title: Volumes + entries: + - title: Create a volume using NFS + url: "/cm/wf_onprem_ontap_create_vol_nfs.html" + - title: Create a volume using CIFS + url: "/cm/wf_onprem_ontap_create_vol_cifs.html" + - title: Create a volume using iSCSI + url: "/cm/wf_onprem_ontap_create_vol_iscsi.html" + - title: Create a FlexGroup volume + url: "/cm/wf_onprem_flexgroup_ontap_create_vol.html" + - title: Get volumes + url: "/cm/wf_onprem_ontap_get_volumes.html" + - title: Modify a volume + url: "/cm/wf_onprem_ontap_modify_volume.html" + - title: Delete a volume + url: "/cm/wf_onprem_ontap_delete_volume.html" + - title: Aggregates + entries: + - title: Get aggregates + url: "/cm/wf_onprem_ontap_get_aggrs.html" + - title: ONTAP management common workflows + entries: + - title: Prepare to use the workflows + url: "/cm/wf_common_before.html" + - title: Identity and access + entries: + - title: Get supported services + url: "/cm/wf_common_identity_get_supported_srv.html" + - title: Get cloud provider accounts + url: "/cm/wf_common_identity_get_provider_accounts.html" + - title: Get tenants + url: "/cm/wf_common_identity_get_tenants.html" + - title: SaaS marketplace + entries: + - title: Get SaaS marketplace account + url: "/cm/wf_common_identity_get_saas_mp.html" + - title: Attach a subscription + url: "/cm/wf_common_occm_attach_subscription.html" + - title: NetApp Support Site + entries: + - title: Create an NSS ID + url: "/cm/wf_common_identity_create_nss_key.html" + - title: Get an NSS ID + url: "/cm/wf_common_identity_get_nss_key.html" + - title: Get an NSS IDs + url: "/cm/wf_common_identity_get_nss_keys.html" + - title: Delete an NSS ID + url: "/cm/wf_common_identity_delete_nss_key.html" + - title: Internal tasks and support + entries: + - title: Get an active task + url: "/cm/wf_common_occm_get_task.html" + - title: SnapMirror replication + entries: + - title: Create a relationship + url: "/cm/wf_common_ontap_repl_create_repl.html" + - title: Update a relationship + url: "/cm/wf_common_ontap_repl_update_repl.html" + - title: Delete a relationship + url: "/cm/wf_common_ontap_repl_delete_repl.html" + - title: Get relationships + url: "/cm/wf_common_ontap_repl_get_sm_rels.html" + - title: Get the relationships status + url: "/cm/wf_common_ontap_repl_get_rel_status.html" + - title: Get relationship status for a system + url: "/cm/wf_common_ontap_repl_get_rel_we_status.html" + - title: Get intercluster LIFs + url: "/cm/wf_common_ontap_repl_get_ic_lifs.html" + - title: Get schedules for a system + url: "/cm/wf_common_ontap_repl_get_we_schedules.html" + - title: Get SnapMirror policies + url: "/cm/wf_common_ontap_md_get_snapmirror_policies.html" + - title: Get SnapMirror SVM policies + url: "/cm/wf_common_ontap_md_get_snapmirror_svm_policies.html" + - title: ONTAP management API reference + entries: + - title: AWS aggregates (HA) + entries: + - title: Add capacity to an elastic volume aggregate + url: "/cvo/post-aws-ha-aggregates--add-capacity.html" + swagger-title: POST /aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}/add-capacity + data-api-method: POST + data-api-path: "/aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}/add-capacity" + data-summary: Add capacity to an elastic volume aggregate + data-deprecated: false + data-category: AWS aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve aggregates + url: "/cvo/get-aws-ha-aggregates.html" + swagger-title: GET /aws/ha/aggregates + data-api-method: GET + data-api-path: "/aws/ha/aggregates" + data-summary: Retrieve aggregates + data-deprecated: false + data-category: AWS aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new aggregate + url: "/cvo/post-aws-ha-aggregates.html" + swagger-title: POST /aws/ha/aggregates + data-api-method: POST + data-api-path: "/aws/ha/aggregates" + data-summary: Create a new aggregate + data-deprecated: false + data-category: AWS aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete an aggregate + url: "/cvo/delete-aws-ha-aggregates-.html" + swagger-title: DELETE /aws/ha/aggregates/{workingEnvironmentId}/{aggregateName} + data-api-method: DELETE + data-api-path: "/aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}" + data-summary: Delete an aggregate + data-deprecated: false + data-category: AWS aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Add disks to an existing aggregate + url: "/cvo/post-aws-ha-aggregates--disks.html" + swagger-title: POST /aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks + data-api-method: POST + data-api-path: "/aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks" + data-summary: Add disks to an existing aggregate + data-deprecated: false + data-category: AWS aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: AWS aggregates (single-node) + entries: + - title: Add the capacity to an existing elastic volume aggregate + url: "/cvo/post-vsa-aggregates--add-capacity.html" + swagger-title: POST /vsa/aggregates/{workingEnvironmentId}/{aggregateName}/add-capacity + data-api-method: POST + data-api-path: "/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/add-capacity" + data-summary: Add the capacity to an existing elastic volume aggregate + data-deprecated: false + data-category: AWS aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve aggregates + url: "/cvo/get-vsa-aggregates.html" + swagger-title: GET /vsa/aggregates + data-api-method: GET + data-api-path: "/vsa/aggregates" + data-summary: Retrieve aggregates + data-deprecated: false + data-category: AWS aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new aggregate + url: "/cvo/post-vsa-aggregates.html" + swagger-title: POST /vsa/aggregates + data-api-method: POST + data-api-path: "/vsa/aggregates" + data-summary: Create a new aggregate + data-deprecated: false + data-category: AWS aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete an existing aggregate + url: "/cvo/delete-vsa-aggregates-.html" + swagger-title: DELETE /vsa/aggregates/{workingEnvironmentId}/{aggregateName} + data-api-method: DELETE + data-api-path: "/vsa/aggregates/{workingEnvironmentId}/{aggregateName}" + data-summary: Delete an existing aggregate + data-deprecated: false + data-category: AWS aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Add disks to an existing aggregate + url: "/cvo/post-vsa-aggregates--disks.html" + swagger-title: POST /vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks + data-api-method: POST + data-api-path: "/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks" + data-summary: Add disks to an existing aggregate + data-deprecated: false + data-category: AWS aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: AWS system discovery (HA) + entries: + - title: Retrieve a list of discovered systems + url: "/cvo/get-aws-ha-discovery-discover.html" + swagger-title: GET /aws/ha/discovery/discover + data-api-method: GET + data-api-path: "/aws/ha/discovery/discover" + data-summary: Retrieve a list of discovered systems + data-deprecated: false + data-category: AWS system discovery (HA) + data-tag-description: '' + data-introduced: '' + - title: Save a previously discovered system + url: "/cvo/post-aws-ha-discovery-recover.html" + swagger-title: POST /aws/ha/discovery/recover + data-api-method: POST + data-api-path: "/aws/ha/discovery/recover" + data-summary: Save a previously discovered system + data-deprecated: false + data-category: AWS system discovery (HA) + data-tag-description: '' + data-introduced: '' + - title: AWS system discovery (single-node) + entries: + - title: Retrieve a list of discovered systems + url: "/cvo/get-vsa-discover.html" + swagger-title: GET /vsa/discover + data-api-method: GET + data-api-path: "/vsa/discover" + data-summary: Retrieve a list of discovered systems + data-deprecated: false + data-category: AWS system discovery (single-node) + data-tag-description: '' + data-introduced: '' + - title: Save a previously discovered Cloud Volumes ONTAP system + url: "/cvo/post-vsa-recover.html" + swagger-title: POST /vsa/recover + data-api-method: POST + data-api-path: "/vsa/recover" + data-summary: Save a previously discovered Cloud Volumes ONTAP system + data-deprecated: false + data-category: AWS system discovery (single-node) + data-tag-description: '' + data-introduced: '' + - title: AWS system encryption (HA) + entries: + - title: Update the key manager CA certificate on a system + url: "/cvo/post-aws-ha-encryption-update-key-manager-ca-certificate.html" + swagger-title: POST /aws/ha/encryption/{workingEnvironmentId}/update-key-manager-ca-certificate + data-api-method: POST + data-api-path: "/aws/ha/encryption/{workingEnvironmentId}/update-key-manager-ca-certificate" + data-summary: Update the key manager CA certificate on a system + data-deprecated: false + data-category: AWS system encryption (HA) + data-tag-description: '' + data-introduced: '' + - title: Update client certificate on a system + url: "/cvo/post-aws-ha-encryption-update-client-certificate.html" + swagger-title: POST /aws/ha/encryption/{workingEnvironmentId}/update-client-certificate + data-api-method: POST + data-api-path: "/aws/ha/encryption/{workingEnvironmentId}/update-client-certificate" + data-summary: Update client certificate on a system + data-deprecated: false + data-category: AWS system encryption (HA) + data-tag-description: '' + data-introduced: '' + - title: Add a key manager to a system + url: "/cvo/post-aws-ha-encryption-key-managers-.html" + swagger-title: POST /aws/ha/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp} + data-api-method: POST + data-api-path: "/aws/ha/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}" + data-summary: Add a key manager to a system + data-deprecated: false + data-category: AWS system encryption (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete a key manager from a system + url: "/cvo/delete-aws-ha-encryption-key-managers-.html" + swagger-title: DELETE /aws/ha/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp} + data-api-method: DELETE + data-api-path: "/aws/ha/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}" + data-summary: Delete a key manager from a system + data-deprecated: false + data-category: AWS system encryption (HA) + data-tag-description: '' + data-introduced: '' + - title: AWS system encryption (single-node) + entries: + - title: Update the key manager CA certificate + url: "/cvo/post-vsa-encryption-update-key-manager-ca-certificate.html" + swagger-title: POST /vsa/encryption/{workingEnvironmentId}/update-key-manager-ca-certificate + data-api-method: POST + data-api-path: "/vsa/encryption/{workingEnvironmentId}/update-key-manager-ca-certificate" + data-summary: Update the key manager CA certificate + data-deprecated: false + data-category: AWS system encryption (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the client certificate + url: "/cvo/post-vsa-encryption-update-client-certificate.html" + swagger-title: POST /vsa/encryption/{workingEnvironmentId}/update-client-certificate + data-api-method: POST + data-api-path: "/vsa/encryption/{workingEnvironmentId}/update-client-certificate" + data-summary: Update the client certificate + data-deprecated: false + data-category: AWS system encryption (single-node) + data-tag-description: '' + data-introduced: '' + - title: Add a key manager + url: "/cvo/post-vsa-encryption-key-managers-.html" + swagger-title: POST /vsa/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp} + data-api-method: POST + data-api-path: "/vsa/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}" + data-summary: Add a key manager + data-deprecated: false + data-category: AWS system encryption (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete a key manager + url: "/cvo/delete-vsa-encryption-key-managers-.html" + swagger-title: DELETE /vsa/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp} + data-api-method: DELETE + data-api-path: "/vsa/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}" + data-summary: Delete a key manager + data-deprecated: false + data-category: AWS system encryption (single-node) + data-tag-description: '' + data-introduced: '' + - title: AWS system metadata (HA) + entries: + - title: Retrieve route tables per VPC and their subnet associations + url: "/cvo/get-aws-ha-metadata-route-tables.html" + swagger-title: GET /aws/ha/metadata/route-tables + data-api-method: GET + data-api-path: "/aws/ha/metadata/route-tables" + data-summary: Retrieve route tables per VPC and their subnet associations + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Validate HA floating IP addresses + url: "/cvo/post-aws-ha-metadata-validate-floating-ips.html" + swagger-title: POST /aws/ha/metadata/validate-floating-ips + data-api-method: POST + data-api-path: "/aws/ha/metadata/validate-floating-ips" + data-summary: Validate HA floating IP addresses + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all system configurations + url: "/cvo/get-aws-ha-metadata-permutations.html" + swagger-title: GET /aws/ha/metadata/permutations + data-api-method: GET + data-api-path: "/aws/ha/metadata/permutations" + data-summary: Retrieve all system configurations + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the minimum number of required IP addresses + url: "/cvo/get-aws-ha-metadata-network-requirements.html" + swagger-title: GET /aws/ha/metadata/network-requirements + data-api-method: GET + data-api-path: "/aws/ha/metadata/network-requirements" + data-summary: Retrieve the minimum number of required IP addresses + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve AWS encryption keys by region + url: "/cvo/get-aws-ha-metadata-aws-encryption-keys.html" + swagger-title: GET /aws/ha/metadata/aws-encryption-keys + data-api-method: GET + data-api-path: "/aws/ha/metadata/aws-encryption-keys" + data-summary: Retrieve AWS encryption keys by region + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Confirm the current user subscription + url: "/cvo/post-aws-ha-metadata-validate-subscribed-to-ontap-cloud.html" + swagger-title: POST /aws/ha/metadata/validate-subscribed-to-ontap-cloud + data-api-method: POST + data-api-path: "/aws/ha/metadata/validate-subscribed-to-ontap-cloud" + data-summary: Confirm the current user subscription + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all S3 buckets with additional information + url: "/cvo/get-aws-ha-metadata-get-buckets-details.html" + swagger-title: GET /aws/ha/metadata/get-buckets-details + data-api-method: GET + data-api-path: "/aws/ha/metadata/get-buckets-details" + data-summary: Retrieve all S3 buckets with additional information + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the S3 buckets policy status and tiering level + url: "/cvo/post-aws-ha-metadata-get-buckets-application-info.html" + swagger-title: POST /aws/ha/metadata/get-buckets-application-info + data-api-method: POST + data-api-path: "/aws/ha/metadata/get-buckets-application-info" + data-summary: Retrieve the S3 buckets policy status and tiering level + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve AWS user key pairs by region + url: "/cvo/get-aws-ha-metadata-key-pairs.html" + swagger-title: GET /aws/ha/metadata/key-pairs + data-api-method: GET + data-api-path: "/aws/ha/metadata/key-pairs" + data-summary: Retrieve AWS user key pairs by region + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve AWS user key pairs for all regions + url: "/cvo/get-aws-ha-metadata-key-pairs-by-region.html" + swagger-title: GET /aws/ha/metadata/key-pairs-by-region + data-api-method: GET + data-api-path: "/aws/ha/metadata/key-pairs-by-region" + data-summary: Retrieve AWS user key pairs for all regions + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve AWS instance profiles + url: "/cvo/get-aws-ha-metadata-instance-profiles.html" + swagger-title: GET /aws/ha/metadata/instance-profiles + data-api-method: GET + data-api-path: "/aws/ha/metadata/instance-profiles" + data-summary: Retrieve AWS instance profiles + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all NetApp Console manifests + url: "/cvo/get-aws-ha-metadata-manifests.html" + swagger-title: GET /aws/ha/metadata/manifests + data-api-method: GET + data-api-path: "/aws/ha/metadata/manifests" + data-summary: Retrieve all NetApp Console manifests + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve VPCs + url: "/cvo/get-aws-ha-metadata-vpcs.html" + swagger-title: GET /aws/ha/metadata/vpcs + data-api-method: GET + data-api-path: "/aws/ha/metadata/vpcs" + data-summary: Retrieve VPCs + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve S3 buckets summary + url: "/cvo/get-aws-ha-metadata-s3-summary.html" + swagger-title: GET /aws/ha/metadata/s3-summary + data-api-method: GET + data-api-path: "/aws/ha/metadata/s3-summary" + data-summary: Retrieve S3 buckets summary + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all S3 buckets + url: "/cvo/get-aws-ha-metadata-buckets.html" + swagger-title: GET /aws/ha/metadata/buckets + data-api-method: GET + data-api-path: "/aws/ha/metadata/buckets" + data-summary: Retrieve all S3 buckets + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported capacity tiers for EBS volume types + url: "/cvo/get-aws-ha-metadata-supported-capacity-tiers.html" + swagger-title: GET /aws/ha/metadata/supported-capacity-tiers + data-api-method: GET + data-api-path: "/aws/ha/metadata/supported-capacity-tiers" + data-summary: Retrieve supported capacity tiers for EBS volume types + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new S3 bucket + url: "/cvo/post-aws-ha-metadata-create-bucket.html" + swagger-title: POST /aws/ha/metadata/create-bucket + data-api-method: POST + data-api-path: "/aws/ha/metadata/create-bucket" + data-summary: Create a new S3 bucket + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported EBS volume types + url: "/cvo/get-aws-ha-metadata-ebs-volume-types.html" + swagger-title: GET /aws/ha/metadata/ebs-volume-types + data-api-method: GET + data-api-path: "/aws/ha/metadata/ebs-volume-types" + data-summary: Retrieve supported EBS volume types + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all tag names + url: "/cvo/get-aws-ha-metadata-tag-keys.html" + swagger-title: GET /aws/ha/metadata/tag-keys + data-api-method: GET + data-api-path: "/aws/ha/metadata/tag-keys" + data-summary: Retrieve all tag names + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve AWS regions + url: "/cvo/get-aws-ha-metadata-regions.html" + swagger-title: GET /aws/ha/metadata/regions + data-api-method: GET + data-api-path: "/aws/ha/metadata/regions" + data-summary: Retrieve AWS regions + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve default snapshot policies available on a cluster + url: "/cvo/get-aws-ha-metadata-default-snapshot-policies.html" + swagger-title: GET /aws/ha/metadata/default-snapshot-policies + data-api-method: GET + data-api-path: "/aws/ha/metadata/default-snapshot-policies" + data-summary: Retrieve default snapshot policies available on a cluster + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve unsupported instance types for acceleration and capacity + tiering + url: "/cvo/get-aws-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html" + swagger-title: GET /aws/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering + data-api-method: GET + data-api-path: "/aws/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering" + data-summary: Retrieve unsupported instance types for acceleration and capacity + tiering + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported features + url: "/cvo/get-aws-ha-metadata-supported-features.html" + swagger-title: GET /aws/ha/metadata/supported-features + data-api-method: GET + data-api-path: "/aws/ha/metadata/supported-features" + data-summary: Retrieve supported features + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve packages configuration + url: "/cvo/get-aws-ha-metadata-packages.html" + swagger-title: GET /aws/ha/metadata/packages + data-api-method: GET + data-api-path: "/aws/ha/metadata/packages" + data-summary: Retrieve packages configuration + data-deprecated: false + data-category: AWS system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: AWS system metadata (single-node) + entries: + - title: Retrieve all Cloud Volumes ONTAP configurations + url: "/cvo/get-vsa-metadata-permutations.html" + swagger-title: GET /vsa/metadata/permutations + data-api-method: GET + data-api-path: "/vsa/metadata/permutations" + data-summary: Retrieve all Cloud Volumes ONTAP configurations + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the minimum number of required IP addresses + url: "/cvo/get-vsa-metadata-network-requirements.html" + swagger-title: GET /vsa/metadata/network-requirements + data-api-method: GET + data-api-path: "/vsa/metadata/network-requirements" + data-summary: Retrieve the minimum number of required IP addresses + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve AWS encryption keys by region + url: "/cvo/get-vsa-metadata-aws-encryption-keys.html" + swagger-title: GET /vsa/metadata/aws-encryption-keys + data-api-method: GET + data-api-path: "/vsa/metadata/aws-encryption-keys" + data-summary: Retrieve AWS encryption keys by region + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Comfirm that the current user is subscribed + url: "/cvo/post-vsa-metadata-validate-subscribed-to-ontap-cloud.html" + swagger-title: POST /vsa/metadata/validate-subscribed-to-ontap-cloud + data-api-method: POST + data-api-path: "/vsa/metadata/validate-subscribed-to-ontap-cloud" + data-summary: Comfirm that the current user is subscribed + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all S3 buckets + url: "/cvo/get-vsa-metadata-get-buckets-details.html" + swagger-title: GET /vsa/metadata/get-buckets-details + data-api-method: GET + data-api-path: "/vsa/metadata/get-buckets-details" + data-summary: Retrieve all S3 buckets + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve S3 buckets policy status and tiering level + url: "/cvo/post-vsa-metadata-get-buckets-application-info.html" + swagger-title: POST /vsa/metadata/get-buckets-application-info + data-api-method: POST + data-api-path: "/vsa/metadata/get-buckets-application-info" + data-summary: Retrieve S3 buckets policy status and tiering level + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve AWS user key pairs by region + url: "/cvo/get-vsa-metadata-key-pairs.html" + swagger-title: GET /vsa/metadata/key-pairs + data-api-method: GET + data-api-path: "/vsa/metadata/key-pairs" + data-summary: Retrieve AWS user key pairs by region + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve AWS user key pairs for all regions + url: "/cvo/get-vsa-metadata-key-pairs-by-region.html" + swagger-title: GET /vsa/metadata/key-pairs-by-region + data-api-method: GET + data-api-path: "/vsa/metadata/key-pairs-by-region" + data-summary: Retrieve AWS user key pairs for all regions + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve AWS instance profiles + url: "/cvo/get-vsa-metadata-instance-profiles.html" + swagger-title: GET /vsa/metadata/instance-profiles + data-api-method: GET + data-api-path: "/vsa/metadata/instance-profiles" + data-summary: Retrieve AWS instance profiles + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all NetApp Console manifests + url: "/cvo/get-vsa-metadata-manifests.html" + swagger-title: GET /vsa/metadata/manifests + data-api-method: GET + data-api-path: "/vsa/metadata/manifests" + data-summary: Retrieve all NetApp Console manifests + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve VPCs + url: "/cvo/get-vsa-metadata-vpcs.html" + swagger-title: GET /vsa/metadata/vpcs + data-api-method: GET + data-api-path: "/vsa/metadata/vpcs" + data-summary: Retrieve VPCs + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve S3 buckets summary + url: "/cvo/get-vsa-metadata-s3-summary.html" + swagger-title: GET /vsa/metadata/s3-summary + data-api-method: GET + data-api-path: "/vsa/metadata/s3-summary" + data-summary: Retrieve S3 buckets summary + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all S3 buckets + url: "/cvo/get-vsa-metadata-buckets.html" + swagger-title: GET /vsa/metadata/buckets + data-api-method: GET + data-api-path: "/vsa/metadata/buckets" + data-summary: Retrieve all S3 buckets + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported capacity tiers for EBS volume types + url: "/cvo/get-vsa-metadata-supported-capacity-tiers.html" + swagger-title: GET /vsa/metadata/supported-capacity-tiers + data-api-method: GET + data-api-path: "/vsa/metadata/supported-capacity-tiers" + data-summary: Retrieve supported capacity tiers for EBS volume types + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new S3 bucket + url: "/cvo/post-vsa-metadata-create-bucket.html" + swagger-title: POST /vsa/metadata/create-bucket + data-api-method: POST + data-api-path: "/vsa/metadata/create-bucket" + data-summary: Create a new S3 bucket + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported EBS volume types + url: "/cvo/get-vsa-metadata-ebs-volume-types.html" + swagger-title: GET /vsa/metadata/ebs-volume-types + data-api-method: GET + data-api-path: "/vsa/metadata/ebs-volume-types" + data-summary: Retrieve supported EBS volume types + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all tag names + url: "/cvo/get-vsa-metadata-tag-keys.html" + swagger-title: GET /vsa/metadata/tag-keys + data-api-method: GET + data-api-path: "/vsa/metadata/tag-keys" + data-summary: Retrieve all tag names + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve AWS regions + url: "/cvo/get-vsa-metadata-regions.html" + swagger-title: GET /vsa/metadata/regions + data-api-method: GET + data-api-path: "/vsa/metadata/regions" + data-summary: Retrieve AWS regions + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve default snapshot policies available on a cluster + url: "/cvo/get-vsa-metadata-default-snapshot-policies.html" + swagger-title: GET /vsa/metadata/default-snapshot-policies + data-api-method: GET + data-api-path: "/vsa/metadata/default-snapshot-policies" + data-summary: Retrieve default snapshot policies available on a cluster + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve unsupported instance types for acceleration and capacity + tiering + url: "/cvo/get-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html" + swagger-title: GET /vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering + data-api-method: GET + data-api-path: "/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering" + data-summary: Retrieve unsupported instance types for acceleration and capacity + tiering + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported features + url: "/cvo/get-vsa-metadata-supported-features.html" + swagger-title: GET /vsa/metadata/supported-features + data-api-method: GET + data-api-path: "/vsa/metadata/supported-features" + data-summary: Retrieve supported features + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve package configurations + url: "/cvo/get-vsa-metadata-packages.html" + swagger-title: GET /vsa/metadata/packages + data-api-method: GET + data-api-path: "/vsa/metadata/packages" + data-summary: Retrieve package configurations + data-deprecated: false + data-category: AWS system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: AWS systems (HA) + entries: + - title: Retrieve Cloud Volumes ONTAP systems + url: "/cvo/get-aws-ha-working-environments.html" + swagger-title: GET /aws/ha/working-environments + data-api-method: GET + data-api-path: "/aws/ha/working-environments" + data-summary: Retrieve Cloud Volumes ONTAP systems + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new AWS HA Cloud Volumes ONTAP system + url: "/cvo/post-aws-ha-working-environments.html" + swagger-title: POST /aws/ha/working-environments + data-api-method: POST + data-api-path: "/aws/ha/working-environments" + data-summary: Create a new AWS HA Cloud Volumes ONTAP system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the route tables for an HA system + url: "/cvo/put-aws-ha-working-environments-route-tables.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/route-tables + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/route-tables" + data-summary: Update the route tables for an HA system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the mediator for a system + url: "/cvo/post-aws-ha-working-environments-update-mediator.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/update-mediator + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/update-mediator" + data-summary: Update the mediator for a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Check for non-persistent locks held on CIFS sessions + url: "/cvo/get-aws-ha-working-environments-cifs-locks-exist.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist" + data-summary: Check for non-persistent locks held on CIFS sessions + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve an HA system + url: "/cvo/get-aws-ha-working-environments-.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}" + data-summary: Retrieve an HA system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete an existing system + url: "/cvo/delete-aws-ha-working-environments-.html" + swagger-title: DELETE /aws/ha/working-environments/{workingEnvironmentId} + data-api-method: DELETE + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}" + data-summary: Delete an existing system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the CIFS configuration for a system + url: "/cvo/get-aws-ha-working-environments-cifs.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/cifs + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/cifs" + data-summary: Retrieve the CIFS configuration for a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new CIFS configuration for a system + url: "/cvo/post-aws-ha-working-environments-cifs.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/cifs + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/cifs" + data-summary: Create a new CIFS configuration for a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete the CIFS configuration for a system + url: "/cvo/post-aws-ha-working-environments-delete-cifs.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/delete-cifs + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/delete-cifs" + data-summary: Delete the CIFS configuration for a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Validate prerequisites for converting a system + url: "/cvo/get-aws-ha-working-environments-validate-byol-to-capacity.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity" + data-summary: Validate prerequisites for converting a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Set the writing speed for a system + url: "/cvo/put-aws-ha-working-environments-writing-speed.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/writing-speed + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/writing-speed" + data-summary: Set the writing speed for a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all license types and their associated instance types + url: "/cvo/get-aws-ha-working-environments-license-instance-type.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/license-instance-type + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/license-instance-type" + data-summary: Retrieve all license types and their associated instance types + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Set the instance type + url: "/cvo/put-aws-ha-working-environments-license-instance-type.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/license-instance-type + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/license-instance-type" + data-summary: Set the instance type + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve images already installed on system + url: "/cvo/get-aws-ha-working-environments-ontap-available-images.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/ontap-available-images + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/ontap-available-images" + data-summary: Retrieve images already installed on system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Perform a complete image update operation + url: "/cvo/post-aws-ha-working-environments-update-image.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/update-image + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/update-image" + data-summary: Perform a complete image update operation + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the eligibility support status of a system + url: "/cvo/get-aws-ha-working-environments-update-eligibility.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/update-eligibility + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/update-eligibility" + data-summary: Retrieve the eligibility support status of a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of upgrade versions + url: "/cvo/get-aws-ha-working-environments-occm-provided-upgrade-versions.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions" + data-summary: Retrieve a list of upgrade versions + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Upload a cloud license file + url: "/cvo/post-aws-ha-working-environments-upload-license-file.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/upload-license-file + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/upload-license-file" + data-summary: Upload a cloud license file + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Upload cloud license file content + url: "/cvo/post-aws-ha-working-environments-upload-licenses.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/upload-licenses + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/upload-licenses" + data-summary: Upload cloud license file content + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Activate an off-box configuration + url: "/cvo/put-aws-ha-working-environments-offbox.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/offbox + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/offbox" + data-summary: Activate an off-box configuration + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Modify the network port broadcast domain MTU + url: "/cvo/put-aws-ha-working-environments-networkoptimization.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/networkOptimization + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/networkOptimization" + data-summary: Modify the network port broadcast domain MTU + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve action parameters + url: "/cvo/get-aws-ha-working-environments-create-request-parameters.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/create-request-parameters + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/create-request-parameters" + data-summary: Retrieve action parameters + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Enable capacity tiering + url: "/cvo/post-aws-ha-working-environments-enable-capacity-tiering.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering" + data-summary: Enable capacity tiering + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the system cost and usage + url: "/cvo/get-aws-ha-working-environments-cost-and-usage.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/cost-and-usage + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/cost-and-usage" + data-summary: Retrieve the system cost and usage + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve systems ONTAP savings + url: "/cvo/get-aws-ha-working-environments-ontap-saving.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/ontap-saving + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/ontap-saving" + data-summary: Retrieve systems ONTAP savings + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve extra capacity licenses + url: "/cvo/get-aws-ha-working-environments-extra-capacity-licenses.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Retrieve extra capacity licenses + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update an extra capacity license + url: "/cvo/put-aws-ha-working-environments-extra-capacity-licenses.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Update an extra capacity license + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Register an extra capacity license + url: "/cvo/post-aws-ha-working-environments-extra-capacity-licenses.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Register an extra capacity license + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update extra capacity license serial numbers + url: "/cvo/put-aws-ha-working-environments-extra-capacity-serials.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Update extra capacity license serial numbers + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Register extra capacity license serial numbers + url: "/cvo/post-aws-ha-working-environments-extra-capacity-serials.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Register extra capacity license serial numbers + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete extra capacity licenses using the serial number + url: "/cvo/delete-aws-ha-working-environments-extra-capacity-serials.html" + swagger-title: DELETE /aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: DELETE + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Delete extra capacity licenses using the serial number + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Trigger subscription synchronization + url: "/cvo/post-aws-ha-working-environments-sync-subscription.html" + swagger-title: POST /aws/ha/working-environments/sync-subscription + data-api-method: POST + data-api-path: "/aws/ha/working-environments/sync-subscription" + data-summary: Trigger subscription synchronization + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the default Vscan file operation profile + url: "/cvo/put-aws-ha-working-environments-vscan-file-op.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/vscan-file-op + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/vscan-file-op" + data-summary: Update the default Vscan file operation profile + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update a BYOL license to a capacity-based license + url: "/cvo/put-aws-ha-working-environments-byol-to-capacity.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/byol-to-capacity + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/byol-to-capacity" + data-summary: Update a BYOL license to a capacity-based license + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Enable SnapLock for a system + url: "/cvo/put-aws-ha-working-environments-enable-worm.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/enable-worm + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/enable-worm" + data-summary: Enable SnapLock for a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Set up an NTP server + url: "/cvo/post-aws-ha-working-environments-ntp.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/ntp + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/ntp" + data-summary: Set up an NTP server + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Start a specific instance + url: "/cvo/post-aws-ha-working-environments-start.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/start + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/start" + data-summary: Start a specific instance + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Stop a specific instance + url: "/cvo/post-aws-ha-working-environments-stop.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/stop + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/stop" + data-summary: Stop a specific instance + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the support registration status of a system + url: "/cvo/get-aws-ha-working-environments-support-registration.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/support-registration + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/support-registration" + data-summary: Retrieve the support registration status of a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Register a system with NetApp + url: "/cvo/post-aws-ha-working-environments-support-registration.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/support-registration + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/support-registration" + data-summary: Register a system with NetApp + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: List the start/stop schedules for a system + url: "/cvo/get-aws-ha-working-environments-schedules.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/schedules + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/schedules" + data-summary: List the start/stop schedules for a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Set the schedules for a system + url: "/cvo/put-aws-ha-working-environments-schedules.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/schedules + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/schedules" + data-summary: Set the schedules for a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Modify the SVM name of a system + url: "/cvo/put-aws-ha-working-environments-svm.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/svm + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/svm" + data-summary: Modify the SVM name of a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Activate FPolicy for ransomware files + url: "/cvo/put-aws-ha-working-environments-activate-fpolicy.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/activate-fpolicy + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/activate-fpolicy" + data-summary: Activate FPolicy for ransomware files + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Disable FPolicy for ransomware files + url: "/cvo/put-aws-ha-working-environments-disable-fpolicy.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/disable-fpolicy + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/disable-fpolicy" + data-summary: Disable FPolicy for ransomware files + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete FPolicy for ransomware files + url: "/cvo/delete-aws-ha-working-environments-fpolicy.html" + swagger-title: DELETE /aws/ha/working-environments/{workingEnvironmentId}/fpolicy + data-api-method: DELETE + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/fpolicy" + data-summary: Delete FPolicy for ransomware files + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the NetApp Console password + url: "/cvo/put-aws-ha-working-environments-update-credentials.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/update-credentials + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/update-credentials" + data-summary: Update the NetApp Console password + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the tier level + url: "/cvo/post-aws-ha-working-environments-change-tier-level.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/change-tier-level + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/change-tier-level" + data-summary: Update the tier level + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Parse an uploaded cloud license file + url: "/cvo/post-aws-ha-working-environments-parse-license-file.html" + swagger-title: POST /aws/ha/working-environments/parse-license-file + data-api-method: POST + data-api-path: "/aws/ha/working-environments/parse-license-file" + data-summary: Parse an uploaded cloud license file + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve editable tags for cloud resources + url: "/cvo/get-aws-ha-working-environments-user-tags.html" + swagger-title: GET /aws/ha/working-environments/{workingEnvironmentId}/user-tags + data-api-method: GET + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/user-tags" + data-summary: Retrieve editable tags for cloud resources + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Modify user tags for cloud resources + url: "/cvo/put-aws-ha-working-environments-user-tags.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/user-tags + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/user-tags" + data-summary: Modify user tags for cloud resources + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Activate snapshot policy assignment for all unprotected read/write + volumes + url: "/cvo/put-aws-ha-working-environments-activate-snapshot-policy.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy" + data-summary: Activate snapshot policy assignment for all unprotected read/write + volumes + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot policy + url: "/cvo/post-aws-ha-working-environments-snapshot-policy.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/snapshot-policy + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/snapshot-policy" + data-summary: Create a snapshot policy + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the serial number of a system + url: "/cvo/post-aws-ha-working-environments-change-serial.html" + swagger-title: POST /aws/ha/working-environments/{workingEnvironmentId}/change-serial + data-api-method: POST + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/change-serial" + data-summary: Update the serial number of a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Set the cluster password for a system + url: "/cvo/put-aws-ha-working-environments-set-password.html" + swagger-title: PUT /aws/ha/working-environments/{workingEnvironmentId}/set-password + data-api-method: PUT + data-api-path: "/aws/ha/working-environments/{workingEnvironmentId}/set-password" + data-summary: Set the cluster password for a system + data-deprecated: false + data-category: AWS systems (HA) + data-tag-description: '' + data-introduced: '' + - title: AWS systems (single-node) + entries: + - title: Retrieve a CIFS configuration for a system + url: "/cvo/get-vsa-working-environments-cifs.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId}/cifs + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/cifs" + data-summary: Retrieve a CIFS configuration for a system + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set up a new CIFS configuration + url: "/cvo/post-vsa-working-environments-cifs.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/cifs + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/cifs" + data-summary: Set up a new CIFS configuration + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete the CIFS configuration for a system + url: "/cvo/post-vsa-working-environments-delete-cifs.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/delete-cifs + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/delete-cifs" + data-summary: Delete the CIFS configuration for a system + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Validate prerequisites for converting a system + url: "/cvo/get-vsa-working-environments-validate-byol-to-capacity.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity" + data-summary: Validate prerequisites for converting a system + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a Cloud Volumes ONTAP system + url: "/cvo/get-vsa-working-environments-.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}" + data-summary: Retrieve a Cloud Volumes ONTAP system + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete an existing Cloud Volumes ONTAP system + url: "/cvo/delete-vsa-working-environments-.html" + swagger-title: DELETE /vsa/working-environments/{workingEnvironmentId} + data-api-method: DELETE + data-api-path: "/vsa/working-environments/{workingEnvironmentId}" + data-summary: Delete an existing Cloud Volumes ONTAP system + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set the writing speed for Cloud Volumes ONTAP + url: "/cvo/put-vsa-working-environments-writing-speed.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/writing-speed + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/writing-speed" + data-summary: Set the writing speed for Cloud Volumes ONTAP + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all license types + url: "/cvo/get-vsa-working-environments-license-instance-type.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId}/license-instance-type + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/license-instance-type" + data-summary: Retrieve all license types + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set the instance type + url: "/cvo/put-vsa-working-environments-license-instance-type.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/license-instance-type + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/license-instance-type" + data-summary: Set the instance type + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve images already installed on the system + url: "/cvo/get-vsa-working-environments-ontap-available-images.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId}/ontap-available-images + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/ontap-available-images" + data-summary: Retrieve images already installed on the system + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Perform a complete image update + url: "/cvo/post-vsa-working-environments-update-image.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/update-image + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/update-image" + data-summary: Perform a complete image update + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the eligibility support status + url: "/cvo/get-vsa-working-environments-update-eligibility.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId}/update-eligibility + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/update-eligibility" + data-summary: Retrieve the eligibility support status + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of upgrade versions + url: "/cvo/get-vsa-working-environments-occm-provided-upgrade-versions.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions" + data-summary: Retrieve a list of upgrade versions + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Upload a cloud license file + url: "/cvo/post-vsa-working-environments-upload-license-file.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/upload-license-file + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/upload-license-file" + data-summary: Upload a cloud license file + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Upload cloud license file content + url: "/cvo/post-vsa-working-environments-upload-licenses.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/upload-licenses + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/upload-licenses" + data-summary: Upload cloud license file content + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Activate an off-box configuration + url: "/cvo/put-vsa-working-environments-offbox.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/offbox + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/offbox" + data-summary: Activate an off-box configuration + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify the network port broadcast domain MTU + url: "/cvo/put-vsa-working-environments-networkoptimization.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/networkOptimization + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/networkOptimization" + data-summary: Modify the network port broadcast domain MTU + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the action parameters + url: "/cvo/get-vsa-working-environments-create-request-parameters.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId}/create-request-parameters + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/create-request-parameters" + data-summary: Retrieve the action parameters + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Enable capacity tiering + url: "/cvo/post-vsa-working-environments-enable-capacity-tiering.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering" + data-summary: Enable capacity tiering + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve systems cost and usage + url: "/cvo/get-vsa-working-environments-cost-and-usage.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId}/cost-and-usage + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/cost-and-usage" + data-summary: Retrieve systems cost and usage + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve systems ONTAP savings + url: "/cvo/get-vsa-working-environments-ontap-saving.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId}/ontap-saving + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/ontap-saving" + data-summary: Retrieve systems ONTAP savings + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve extra capacity licenses + url: "/cvo/get-vsa-working-environments-extra-capacity-licenses.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Retrieve extra capacity licenses + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update extra capacity licenses + url: "/cvo/put-vsa-working-environments-extra-capacity-licenses.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Update extra capacity licenses + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Register extra capacity licenses + url: "/cvo/post-vsa-working-environments-extra-capacity-licenses.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Register extra capacity licenses + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update extra capacity serial numbers + url: "/cvo/put-vsa-working-environments-extra-capacity-serials.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Update extra capacity serial numbers + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Register extra capacity serial numbers + url: "/cvo/post-vsa-working-environments-extra-capacity-serials.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Register extra capacity serial numbers + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete extra capacity licenses by serial numbers + url: "/cvo/delete-vsa-working-environments-extra-capacity-serials.html" + swagger-title: DELETE /vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: DELETE + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Delete extra capacity licenses by serial numbers + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Trigger subscription synchronization + url: "/cvo/post-vsa-working-environments-sync-subscription.html" + swagger-title: POST /vsa/working-environments/sync-subscription + data-api-method: POST + data-api-path: "/vsa/working-environments/sync-subscription" + data-summary: Trigger subscription synchronization + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the default Vscan file operation profile + url: "/cvo/put-vsa-working-environments-vscan-file-op.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/vscan-file-op + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/vscan-file-op" + data-summary: Update the default Vscan file operation profile + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the BYOL licence to a capacity-based license + url: "/cvo/put-vsa-working-environments-byol-to-capacity.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/byol-to-capacity + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity" + data-summary: Update the BYOL licence to a capacity-based license + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Enable SnapLock for an existing system + url: "/cvo/put-vsa-working-environments-enable-worm.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/enable-worm + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/enable-worm" + data-summary: Enable SnapLock for an existing system + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set up an NTP server + url: "/cvo/post-vsa-working-environments-ntp.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/ntp + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/ntp" + data-summary: Set up an NTP server + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Start a specific Cloud Volumes ONTAP instance + url: "/cvo/post-vsa-working-environments-start.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/start + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/start" + data-summary: Start a specific Cloud Volumes ONTAP instance + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Stop a specific Cloud Volumes ONTAP instance + url: "/cvo/post-vsa-working-environments-stop.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/stop + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/stop" + data-summary: Stop a specific Cloud Volumes ONTAP instance + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the support registration status + url: "/cvo/get-vsa-working-environments-support-registration.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId}/support-registration + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/support-registration" + data-summary: Retrieve the support registration status + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Register a Cloud Volumes ONTAP system + url: "/cvo/post-vsa-working-environments-support-registration.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/support-registration + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/support-registration" + data-summary: Register a Cloud Volumes ONTAP system + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: List the start/stop schedules + url: "/cvo/get-vsa-working-environments-schedules.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId}/schedules + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/schedules" + data-summary: List the start/stop schedules + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set the schedules + url: "/cvo/put-vsa-working-environments-schedules.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/schedules + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/schedules" + data-summary: Set the schedules + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify the SVM name + url: "/cvo/put-vsa-working-environments-svm.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/svm + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/svm" + data-summary: Modify the SVM name + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Activate the FPolicy for ransomware files + url: "/cvo/put-vsa-working-environments-activate-fpolicy.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/activate-fpolicy + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy" + data-summary: Activate the FPolicy for ransomware files + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Disable the FPolicy for ransomware files + url: "/cvo/put-vsa-working-environments-disable-fpolicy.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/disable-fpolicy + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy" + data-summary: Disable the FPolicy for ransomware files + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete the FPolicy for ransomware files + url: "/cvo/delete-vsa-working-environments-fpolicy.html" + swagger-title: DELETE /vsa/working-environments/{workingEnvironmentId}/fpolicy + data-api-method: DELETE + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/fpolicy" + data-summary: Delete the FPolicy for ransomware files + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the NetApp Console password + url: "/cvo/put-vsa-working-environments-update-credentials.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/update-credentials + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/update-credentials" + data-summary: 'Update the NetApp Console password ' + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify the tier level + url: "/cvo/post-vsa-working-environments-change-tier-level.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/change-tier-level + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/change-tier-level" + data-summary: Modify the tier level + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Parse an uploaded cloud license file + url: "/cvo/post-vsa-working-environments-parse-license-file.html" + swagger-title: POST /vsa/working-environments/parse-license-file + data-api-method: POST + data-api-path: "/vsa/working-environments/parse-license-file" + data-summary: Parse an uploaded cloud license file + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve editable tags for cloud resources + url: "/cvo/get-vsa-working-environments-user-tags.html" + swagger-title: GET /vsa/working-environments/{workingEnvironmentId}/user-tags + data-api-method: GET + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/user-tags" + data-summary: Retrieve editable tags for cloud resources + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify user tags for cloud resources + url: "/cvo/put-vsa-working-environments-user-tags.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/user-tags + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/user-tags" + data-summary: Modify user tags for cloud resources + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Activate snapshot policy assignments + url: "/cvo/put-vsa-working-environments-activate-snapshot-policy.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy" + data-summary: Activate snapshot policy assignments + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot policy + url: "/cvo/post-vsa-working-environments-snapshot-policy.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/snapshot-policy + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/snapshot-policy" + data-summary: Create a snapshot policy + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the serial number of Cloud Volumes ONTAP + url: "/cvo/post-vsa-working-environments-change-serial.html" + swagger-title: POST /vsa/working-environments/{workingEnvironmentId}/change-serial + data-api-method: POST + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/change-serial" + data-summary: Update the serial number of Cloud Volumes ONTAP + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set the cluster password + url: "/cvo/put-vsa-working-environments-set-password.html" + swagger-title: PUT /vsa/working-environments/{workingEnvironmentId}/set-password + data-api-method: PUT + data-api-path: "/vsa/working-environments/{workingEnvironmentId}/set-password" + data-summary: Set the cluster password + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Cloud Volumes ONTAP systems + url: "/cvo/get-vsa-working-environments.html" + swagger-title: GET /vsa/working-environments + data-api-method: GET + data-api-path: "/vsa/working-environments" + data-summary: Retrieve Cloud Volumes ONTAP systems + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new Cloud Volumes ONTAP system + url: "/cvo/post-vsa-working-environments.html" + swagger-title: POST /vsa/working-environments + data-api-method: POST + data-api-path: "/vsa/working-environments" + data-summary: 'Create a new Cloud Volumes ONTAP system ' + data-deprecated: false + data-category: AWS systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: AWS volumes (HA) + entries: + - title: Retrieve volumes for backup activation + url: "/cvo/get-aws-ha-volumes-volumes-for-backup.html" + swagger-title: GET /aws/ha/volumes/volumes-for-backup + data-api-method: GET + data-api-path: "/aws/ha/volumes/volumes-for-backup" + data-summary: Retrieve volumes for backup activation + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve quotes for a new volume + url: "/cvo/post-aws-ha-volumes-quote.html" + swagger-title: POST /aws/ha/volumes/quote + data-api-method: POST + data-api-path: "/aws/ha/volumes/quote" + data-summary: Retrieve quotes for a new volume + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the underlying volume tier + url: "/cvo/post-aws-ha-volumes--change-tier.html" + swagger-title: POST /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier + data-api-method: POST + data-api-path: "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier" + data-summary: Update the underlying volume tier + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Modify an existing volume + url: "/cvo/put-aws-ha-volumes--.html" + swagger-title: PUT /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: PUT + data-api-path: "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Modify an existing volume + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete an existing volume + url: "/cvo/delete-aws-ha-volumes--.html" + swagger-title: DELETE /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: DELETE + data-api-path: "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Delete an existing volume + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Add an export policy rule + url: "/cvo/put-aws-ha-volumes--exportpolicy.html" + swagger-title: PUT /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy + data-api-method: PUT + data-api-path: "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy" + data-summary: Add an export policy rule + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all igroups + url: "/cvo/get-aws-ha-volumes-igroups-.html" + swagger-title: GET /aws/ha/volumes/igroups/{workingEnvironmentId}/{svmName} + data-api-method: GET + data-api-path: "/aws/ha/volumes/igroups/{workingEnvironmentId}/{svmName}" + data-summary: Retrieve all igroups + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all iSCSI initiators + url: "/cvo/get-aws-ha-volumes-initiator.html" + swagger-title: GET /aws/ha/volumes/initiator + data-api-method: GET + data-api-path: "/aws/ha/volumes/initiator" + data-summary: Retrieve all iSCSI initiators + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Add an iSCSI initiator + url: "/cvo/post-aws-ha-volumes-initiator.html" + swagger-title: POST /aws/ha/volumes/initiator + data-api-method: POST + data-api-path: "/aws/ha/volumes/initiator" + data-summary: Add an iSCSI initiator + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of snapshot descriptions for the volume + url: "/cvo/get-aws-ha-volumes--snapshots.html" + swagger-title: GET /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots + data-api-method: GET + data-api-path: "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots" + data-summary: Retrieve a list of snapshot descriptions for the volume + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Clone an existing volume + url: "/cvo/post-aws-ha-volumes--clone.html" + swagger-title: POST /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone + data-api-method: POST + data-api-path: "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone" + data-summary: Clone an existing volume + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot + url: "/cvo/post-aws-ha-volumes--snapshot.html" + swagger-title: POST /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: POST + data-api-path: "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Create a snapshot + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete a snapshot + url: "/cvo/delete-aws-ha-volumes--snapshot.html" + swagger-title: DELETE /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: DELETE + data-api-path: "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Delete a snapshot + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all volumes + url: "/cvo/get-aws-ha-volumes.html" + swagger-title: GET /aws/ha/volumes + data-api-method: GET + data-api-path: "/aws/ha/volumes" + data-summary: Retrieve all volumes + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new volume + url: "/cvo/post-aws-ha-volumes.html" + swagger-title: POST /aws/ha/volumes + data-api-method: POST + data-api-path: "/aws/ha/volumes" + data-summary: Create a new volume + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Move an existing volume + url: "/cvo/post-aws-ha-volumes--move.html" + swagger-title: POST /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move + data-api-method: POST + data-api-path: "/aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move" + data-summary: Move an existing volume + data-deprecated: false + data-category: AWS volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: AWS volumes (single-node) + entries: + - title: Retrieve the volumes for backup activation + url: "/cvo/get-vsa-volumes-volumes-for-backup.html" + swagger-title: GET /vsa/volumes/volumes-for-backup + data-api-method: GET + data-api-path: "/vsa/volumes/volumes-for-backup" + data-summary: Retrieve the volumes for backup activation + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve quotes for a new volume + url: "/cvo/post-vsa-volumes-quote.html" + swagger-title: POST /vsa/volumes/quote + data-api-method: POST + data-api-path: "/vsa/volumes/quote" + data-summary: Retrieve quotes for a new volume + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the underlying volume tier + url: "/cvo/post-vsa-volumes--change-tier.html" + swagger-title: POST /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier + data-api-method: POST + data-api-path: "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier" + data-summary: Update the underlying volume tier + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify an existing volume + url: "/cvo/put-vsa-volumes--.html" + swagger-title: PUT /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: PUT + data-api-path: "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Modify an existing volume + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete an existing volume + url: "/cvo/delete-vsa-volumes--.html" + swagger-title: DELETE /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: DELETE + data-api-path: "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Delete an existing volume + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Add an export policy rule + url: "/cvo/put-vsa-volumes--exportpolicy.html" + swagger-title: PUT /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy + data-api-method: PUT + data-api-path: "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy" + data-summary: Add an export policy rule + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all igroups + url: "/cvo/get-vsa-volumes-igroups-.html" + swagger-title: GET /vsa/volumes/igroups/{workingEnvironmentId}/{svmName} + data-api-method: GET + data-api-path: "/vsa/volumes/igroups/{workingEnvironmentId}/{svmName}" + data-summary: Retrieve all igroups + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all iSCSI initiators + url: "/cvo/get-vsa-volumes-initiator.html" + swagger-title: GET /vsa/volumes/initiator + data-api-method: GET + data-api-path: "/vsa/volumes/initiator" + data-summary: Retrieve all iSCSI initiators + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Add an iSCSI initiator + url: "/cvo/post-vsa-volumes-initiator.html" + swagger-title: POST /vsa/volumes/initiator + data-api-method: POST + data-api-path: "/vsa/volumes/initiator" + data-summary: Add an iSCSI initiator + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of snapshot descriptions for the volume + url: "/cvo/get-vsa-volumes--snapshots.html" + swagger-title: GET /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots + data-api-method: GET + data-api-path: "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots" + data-summary: Retrieve a list of snapshot descriptions for the volume + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Clone an existing volume + url: "/cvo/post-vsa-volumes--clone.html" + swagger-title: POST /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone + data-api-method: POST + data-api-path: "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone" + data-summary: Clone an existing volume + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot + url: "/cvo/post-vsa-volumes--snapshot.html" + swagger-title: POST /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: POST + data-api-path: "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Create a snapshot + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete a snapshot + url: "/cvo/delete-vsa-volumes--snapshot.html" + swagger-title: DELETE /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: DELETE + data-api-path: "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Delete a snapshot + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve volumes + url: "/cvo/get-vsa-volumes.html" + swagger-title: GET /vsa/volumes + data-api-method: GET + data-api-path: "/vsa/volumes" + data-summary: Retrieve volumes + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new volume + url: "/cvo/post-vsa-volumes.html" + swagger-title: POST /vsa/volumes + data-api-method: POST + data-api-path: "/vsa/volumes" + data-summary: Create a new volume + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Move an existing volume + url: "/cvo/post-vsa-volumes--move.html" + swagger-title: POST /vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move + data-api-method: POST + data-api-path: "/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move" + data-summary: Move an existing volume + data-deprecated: false + data-category: AWS volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Account operations + entries: + - title: Create an Azure account + url: "/cvo/post-accounts-azure.html" + swagger-title: POST /accounts/azure + data-api-method: POST + data-api-path: "/accounts/azure" + data-summary: Create an Azure account + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Create a Google Cloud storage account + url: "/cvo/post-accounts-gcp.html" + swagger-title: POST /accounts/gcp + data-api-method: POST + data-api-path: "/accounts/gcp" + data-summary: Create a Google Cloud storage account + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve a Google Cloud storage account + url: "/cvo/get-accounts-gcp-.html" + swagger-title: GET /accounts/gcp/{cloudProviderAccountId} + data-api-method: GET + data-api-path: "/accounts/gcp/{cloudProviderAccountId}" + data-summary: Retrieve a Google Cloud storage account + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Update a Google Cloud storage account + url: "/cvo/put-accounts-gcp-.html" + swagger-title: PUT /accounts/gcp/{cloudProviderAccountId} + data-api-method: PUT + data-api-path: "/accounts/gcp/{cloudProviderAccountId}" + data-summary: Update a Google Cloud storage account + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Update the VSA list of an NSS account + url: "/cvo/put-accounts-nss-set-vsa-list-.html" + swagger-title: PUT /accounts/nss/set-vsa-list/{cloudProviderAccountId} + data-api-method: PUT + data-api-path: "/accounts/nss/set-vsa-list/{cloudProviderAccountId}" + data-summary: Update the VSA list of an NSS account + data-deprecated: false + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Delete an existing account + url: "/cvo/delete-accounts-.html" + swagger-title: DELETE /accounts/{cloudProviderAccountId} + data-api-method: DELETE + data-api-path: "/accounts/{cloudProviderAccountId}" + data-summary: Delete an existing account + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve an AWS account + url: "/cvo/get-accounts-aws-.html" + swagger-title: GET /accounts/aws/{cloudProviderAccountId} + data-api-method: GET + data-api-path: "/accounts/aws/{cloudProviderAccountId}" + data-summary: Retrieve an AWS account + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Update an existing AWS account + url: "/cvo/put-accounts-aws-.html" + swagger-title: PUT /accounts/aws/{cloudProviderAccountId} + data-api-method: PUT + data-api-path: "/accounts/aws/{cloudProviderAccountId}" + data-summary: Update an existing AWS account + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Create an AWS account + url: "/cvo/post-accounts-aws.html" + swagger-title: POST /accounts/aws + data-api-method: POST + data-api-path: "/accounts/aws" + data-summary: Create an AWS account + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve an NSS account + url: "/cvo/get-accounts-nss-.html" + swagger-title: GET /accounts/nss/{cloudProviderAccountId} + data-api-method: GET + data-api-path: "/accounts/nss/{cloudProviderAccountId}" + data-summary: Retrieve an NSS account + data-deprecated: false + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Update an NSS account + url: "/cvo/put-accounts-nss-.html" + swagger-title: PUT /accounts/nss/{cloudProviderAccountId} + data-api-method: PUT + data-api-path: "/accounts/nss/{cloudProviderAccountId}" + data-summary: Update an NSS account + data-deprecated: false + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve all cloud accounts + url: "/cvo/get-accounts-cloud-providers.html" + swagger-title: GET /accounts/cloud-providers + data-api-method: GET + data-api-path: "/accounts/cloud-providers" + data-summary: Retrieve all cloud accounts + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve an AWS account ID for credentials + url: "/cvo/post-accounts-aws-validate-creds.html" + swagger-title: POST /accounts/aws/validate-creds + data-api-method: POST + data-api-path: "/accounts/aws/validate-creds" + data-summary: Retrieve an AWS account ID for credentials + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Validate the Google Cloud account request + url: "/cvo/post-accounts-gcp-validate-creds.html" + swagger-title: POST /accounts/gcp/validate-creds + data-api-method: POST + data-api-path: "/accounts/gcp/validate-creds" + data-summary: Validate the Google Cloud account request + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Validate an Azure account request + url: "/cvo/post-accounts-azure-validate-creds.html" + swagger-title: POST /accounts/azure/validate-creds + data-api-method: POST + data-api-path: "/accounts/azure/validate-creds" + data-summary: Validate an Azure account request + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve an Azure account + url: "/cvo/get-accounts-azure-.html" + swagger-title: GET /accounts/azure/{cloudProviderAccountId} + data-api-method: GET + data-api-path: "/accounts/azure/{cloudProviderAccountId}" + data-summary: Retrieve an Azure account + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Update an Azure account + url: "/cvo/put-accounts-azure-.html" + swagger-title: PUT /accounts/azure/{cloudProviderAccountId} + data-api-method: PUT + data-api-path: "/accounts/azure/{cloudProviderAccountId}" + data-summary: Update an Azure account + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Create an NSS account + url: "/cvo/post-accounts-nss.html" + swagger-title: POST /accounts/nss + data-api-method: POST + data-api-path: "/accounts/nss" + data-summary: Create an NSS account + data-deprecated: false + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve accounts + url: "/cvo/get-accounts.html" + swagger-title: GET /accounts + data-api-method: GET + data-api-path: "/accounts" + data-summary: Retrieve accounts + data-deprecated: true + data-category: Account operations + data-tag-description: '' + data-introduced: '' + - title: Amazon FSx for NetApp ONTAP management systems + entries: + - title: Retrieve CIFS configuration for an FSx system + url: "/cvo/get-fsx-working-environments-cifs.html" + swagger-title: GET /fsx/working-environments/{fileSystemId}/cifs + data-api-method: GET + data-api-path: "/fsx/working-environments/{fileSystemId}/cifs" + data-summary: Retrieve CIFS configuration for an FSx system + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management systems + data-tag-description: '' + data-introduced: '' + - title: Create a new CIFS configuration for an FSx system + url: "/cvo/post-fsx-working-environments-cifs.html" + swagger-title: POST /fsx/working-environments/{fileSystemId}/cifs + data-api-method: POST + data-api-path: "/fsx/working-environments/{fileSystemId}/cifs" + data-summary: Create a new CIFS configuration for an FSx system + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management systems + data-tag-description: '' + data-introduced: '' + - title: Retrieve an export policies list for an FSx system + url: "/cvo/get-fsx-working-environments-export-policies.html" + swagger-title: GET /fsx/working-environments/{fileSystemId}/export-policies + data-api-method: GET + data-api-path: "/fsx/working-environments/{fileSystemId}/export-policies" + data-summary: Retrieve an export policies list for an FSx system + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management systems + data-tag-description: '' + data-introduced: '' + - title: Validate the credentials for an FSx system + url: "/cvo/post-fsx-working-environments-validate-credentials.html" + swagger-title: POST /fsx/working-environments/validate-credentials + data-api-method: POST + data-api-path: "/fsx/working-environments/validate-credentials" + data-summary: Validate the credentials for an FSx system + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management systems + data-tag-description: '' + data-introduced: '' + - title: Retrieve an SVM list for an FSx system + url: "/cvo/get-fsx-working-environments-svms.html" + swagger-title: GET /fsx/working-environments/{fileSystemId}/svms + data-api-method: GET + data-api-path: "/fsx/working-environments/{fileSystemId}/svms" + data-summary: Retrieve an SVM list for an FSx system + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management systems + data-tag-description: '' + data-introduced: '' + - title: Retrieve network interfaces lists for an FSx system + url: "/cvo/get-fsx-working-environments-interfaces.html" + swagger-title: GET /fsx/working-environments/{fileSystemId}/interfaces + data-api-method: GET + data-api-path: "/fsx/working-environments/{fileSystemId}/interfaces" + data-summary: Retrieve network interfaces lists for an FSx system + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management systems + data-tag-description: '' + data-introduced: '' + - title: Retrieve snapshot policies for an FSx system + url: "/cvo/get-fsx-working-environments-snapshot-policies.html" + swagger-title: GET /fsx/working-environments/{fileSystemId}/snapshot-policies + data-api-method: GET + data-api-path: "/fsx/working-environments/{fileSystemId}/snapshot-policies" + data-summary: Retrieve snapshot policies for an FSx system + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management systems + data-tag-description: '' + data-introduced: '' + - title: Amazon FSx for NetApp ONTAP management volumes + entries: + - title: Retrieve volumes + url: "/cvo/get-fsx-volumes-.html" + swagger-title: GET /fsx/volumes/{fileSystemId} + data-api-method: GET + data-api-path: "/fsx/volumes/{fileSystemId}" + data-summary: Retrieve volumes + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Retrieve a volume using the ID + url: "/cvo/get-fsx-volumes-.html" + swagger-title: GET /fsx/volumes/{fileSystemId}/{volumeId} + data-api-method: GET + data-api-path: "/fsx/volumes/{fileSystemId}/{volumeId}" + data-summary: Retrieve a volume using the ID + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Retrieve an NFS clients list for an FSx system + url: "/cvo/get-fsx-volumes-nfs-clients.html" + swagger-title: GET /fsx/volumes/{fileSystemId}/nfs-clients + data-api-method: GET + data-api-path: "/fsx/volumes/{fileSystemId}/nfs-clients" + data-summary: Retrieve an NFS clients list for an FSx system + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Retrieve a CIFS share list for an FSx system + url: "/cvo/get-fsx-volumes-shares.html" + swagger-title: GET /fsx/volumes/{fileSystemId}/shares + data-api-method: GET + data-api-path: "/fsx/volumes/{fileSystemId}/shares" + data-summary: Retrieve a CIFS share list for an FSx system + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Retrieve the volume count + url: "/cvo/get-fsx-volumes-count.html" + swagger-title: GET /fsx/volumes/{fileSystemId}/count + data-api-method: GET + data-api-path: "/fsx/volumes/{fileSystemId}/count" + data-summary: Retrieve the volume count + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Modify an existing volume + url: "/cvo/put-fsx-volumes--.html" + swagger-title: PUT /fsx/volumes/{fileSystemId}/{svmName}/{volumeName} + data-api-method: PUT + data-api-path: "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}" + data-summary: Modify an existing volume + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Delete an existing volume + url: "/cvo/delete-fsx-volumes--.html" + swagger-title: DELETE /fsx/volumes/{fileSystemId}/{svmName}/{volumeName} + data-api-method: DELETE + data-api-path: "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}" + data-summary: Delete an existing volume + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Retrieve all igroups + url: "/cvo/get-fsx-volumes-igroups-.html" + swagger-title: GET /fsx/volumes/igroups/{fileSystemId}/{svmName} + data-api-method: GET + data-api-path: "/fsx/volumes/igroups/{fileSystemId}/{svmName}" + data-summary: Retrieve all igroups + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Retrieve all iSCSI initiators + url: "/cvo/get-fsx-volumes-initiator.html" + swagger-title: GET /fsx/volumes/initiator + data-api-method: GET + data-api-path: "/fsx/volumes/initiator" + data-summary: Retrieve all iSCSI initiators + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Add an iSCSI initiator + url: "/cvo/post-fsx-volumes-initiator.html" + swagger-title: POST /fsx/volumes/initiator + data-api-method: POST + data-api-path: "/fsx/volumes/initiator" + data-summary: Add an iSCSI initiator + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of snapshot descriptions for a volume + url: "/cvo/get-fsx-volumes--snapshots.html" + swagger-title: GET /fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/snapshots + data-api-method: GET + data-api-path: "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/snapshots" + data-summary: Retrieve a list of snapshot descriptions for a volume + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Clone a volume + url: "/cvo/post-fsx-volumes--clone.html" + swagger-title: POST /fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/clone + data-api-method: POST + data-api-path: "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/clone" + data-summary: Clone a volume + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot + url: "/cvo/post-fsx-volumes--snapshot.html" + swagger-title: POST /fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/snapshot + data-api-method: POST + data-api-path: "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/snapshot" + data-summary: Create a snapshot + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Delete a snapshot + url: "/cvo/delete-fsx-volumes--snapshot.html" + swagger-title: DELETE /fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/snapshot + data-api-method: DELETE + data-api-path: "/fsx/volumes/{fileSystemId}/{svmName}/{volumeName}/snapshot" + data-summary: Delete a snapshot + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Create a new volume + url: "/cvo/post-fsx-volumes.html" + swagger-title: POST /fsx/volumes + data-api-method: POST + data-api-path: "/fsx/volumes" + data-summary: Create a new volume + data-deprecated: false + data-category: Amazon FSx for NetApp ONTAP management volumes + data-tag-description: '' + data-introduced: '' + - title: Audit operations + entries: + - title: Retrieve audit group entries + url: "/cvo/get-audit.html" + swagger-title: GET /audit + data-api-method: GET + data-api-path: "/audit" + data-summary: Retrieve audit group entries + data-deprecated: false + data-category: Audit operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve an active task + url: "/cvo/get-audit-activetask-.html" + swagger-title: GET /audit/activeTask/{requestId} + data-api-method: GET + data-api-path: "/audit/activeTask/{requestId}" + data-summary: Retrieve an active task + data-deprecated: false + data-category: Audit operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve an audit group entry + url: "/cvo/get-audit-.html" + swagger-title: GET /audit/{requestId} + data-api-method: GET + data-api-path: "/audit/{requestId}" + data-summary: Retrieve an audit group entry + data-deprecated: false + data-category: Audit operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve audit group entries + url: "/cvo/get-audit-local-audit-.html" + swagger-title: GET /audit/local/audit/{accountId} + data-api-method: GET + data-api-path: "/audit/local/audit/{accountId}" + data-summary: Retrieve audit group entries + data-deprecated: false + data-category: Audit operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve an audit record + url: "/cvo/get-audit-local-audit--records.html" + swagger-title: GET /audit/local/audit/{accountId}/{service}/{requestId}/records + data-api-method: GET + data-api-path: "/audit/local/audit/{accountId}/{service}/{requestId}/records" + data-summary: Retrieve an audit record + data-deprecated: false + data-category: Audit operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve audit page filter options + url: "/cvo/get-audit-local-audit-options.html" + swagger-title: GET /audit/local/audit/{accountId}/options + data-api-method: GET + data-api-path: "/audit/local/audit/{accountId}/options" + data-summary: Retrieve audit page filter options + data-deprecated: false + data-category: Audit operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve audit groups and group records + url: "/cvo/get-audit-auditserver.html" + swagger-title: GET /audit/auditserver + data-api-method: GET + data-api-path: "/audit/auditserver" + data-summary: Retrieve audit groups and group records + data-deprecated: false + data-category: Audit operations + data-tag-description: '' + data-introduced: '' + - title: Azure aggregates (HA) + entries: + - title: Update IOPS and throughput for disks in an existing aggregate + url: "/cvo/put-azure-ha-aggregates-.html" + swagger-title: PUT /azure/ha/aggregates/{workingEnvironmentId}/{aggregateName} + data-api-method: PUT + data-api-path: "/azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}" + data-summary: Update IOPS and throughput for disks in an existing aggregate + data-deprecated: false + data-category: Azure aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete an aggregate + url: "/cvo/delete-azure-ha-aggregates-.html" + swagger-title: DELETE /azure/ha/aggregates/{workingEnvironmentId}/{aggregateName} + data-api-method: DELETE + data-api-path: "/azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}" + data-summary: Delete an aggregate + data-deprecated: false + data-category: Azure aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve aggregates + url: "/cvo/get-azure-ha-aggregates-.html" + swagger-title: GET /azure/ha/aggregates/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/azure/ha/aggregates/{workingEnvironmentId}" + data-summary: Retrieve aggregates + data-deprecated: false + data-category: Azure aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new aggregate + url: "/cvo/post-azure-ha-aggregates.html" + swagger-title: POST /azure/ha/aggregates + data-api-method: POST + data-api-path: "/azure/ha/aggregates" + data-summary: Create a new aggregate + data-deprecated: false + data-category: Azure aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Add disks to an aggregate + url: "/cvo/post-azure-ha-aggregates--disks.html" + swagger-title: POST /azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks + data-api-method: POST + data-api-path: "/azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks" + data-summary: Add disks to an aggregate + data-deprecated: false + data-category: Azure aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Azure aggregates (single-node) + entries: + - title: Update IOPS and throughput for disks in an existing aggregate (single-node) + url: "/cvo/put-azure-vsa-aggregates-.html" + swagger-title: PUT /azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName} + data-api-method: PUT + data-api-path: "/azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}" + data-summary: Update IOPS and throughput for disks in an existing aggregate + (single-node) + data-deprecated: false + data-category: Azure aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete an aggregate + url: "/cvo/delete-azure-vsa-aggregates-.html" + swagger-title: DELETE /azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName} + data-api-method: DELETE + data-api-path: "/azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}" + data-summary: Delete an aggregate + data-deprecated: false + data-category: Azure aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve aggregates + url: "/cvo/get-azure-vsa-aggregates-.html" + swagger-title: GET /azure/vsa/aggregates/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/azure/vsa/aggregates/{workingEnvironmentId}" + data-summary: Retrieve aggregates + data-deprecated: false + data-category: Azure aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new aggregate + url: "/cvo/post-azure-vsa-aggregates.html" + swagger-title: POST /azure/vsa/aggregates + data-api-method: POST + data-api-path: "/azure/vsa/aggregates" + data-summary: Create a new aggregate + data-deprecated: false + data-category: Azure aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Add disks to an aggregate + url: "/cvo/post-azure-vsa-aggregates--disks.html" + swagger-title: POST /azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks + data-api-method: POST + data-api-path: "/azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks" + data-summary: Add disks to an aggregate + data-deprecated: false + data-category: Azure aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Azure system discovery (HA) + entries: + - title: Retrieve a list of systems for the Azure region + url: "/cvo/get-azure-ha-discovery-discover.html" + swagger-title: GET /azure/ha/discovery/discover + data-api-method: GET + data-api-path: "/azure/ha/discovery/discover" + data-summary: Retrieve a list of systems for the Azure region + data-deprecated: false + data-category: Azure system discovery (HA) + data-tag-description: '' + data-introduced: '' + - title: Save a system to the NetApp Console database + url: "/cvo/post-azure-ha-discovery-recover.html" + swagger-title: POST /azure/ha/discovery/recover + data-api-method: POST + data-api-path: "/azure/ha/discovery/recover" + data-summary: Save a system to the NetApp Console database + data-deprecated: false + data-category: Azure system discovery (HA) + data-tag-description: '' + data-introduced: '' + - title: Azure system discovery (single-node) + entries: + - title: Retrieve a list of discovered systems + url: "/cvo/get-azure-vsa-discover.html" + swagger-title: GET /azure/vsa/discover + data-api-method: GET + data-api-path: "/azure/vsa/discover" + data-summary: Retrieve a list of discovered systems + data-deprecated: false + data-category: Azure system discovery (single-node) + data-tag-description: '' + data-introduced: '' + - title: Save a previously discovered Cloud Volumes ONTAP system + url: "/cvo/post-azure-vsa-recover.html" + swagger-title: POST /azure/vsa/recover + data-api-method: POST + data-api-path: "/azure/vsa/recover" + data-summary: Save a previously discovered Cloud Volumes ONTAP system + data-deprecated: false + data-category: Azure system discovery (single-node) + data-tag-description: '' + data-introduced: '' + - title: Azure system metadata (HA) + entries: + - title: Retrieve all ONTAP cloud configurations + url: "/cvo/get-azure-ha-metadata-permutations.html" + swagger-title: GET /azure/ha/metadata/permutations + data-api-method: GET + data-api-path: "/azure/ha/metadata/permutations" + data-summary: Retrieve all ONTAP cloud configurations + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve subscriptions + url: "/cvo/get-azure-ha-metadata-associated-subscriptions.html" + swagger-title: GET /azure/ha/metadata/associated-subscriptions + data-api-method: GET + data-api-path: "/azure/ha/metadata/associated-subscriptions" + data-summary: Retrieve subscriptions + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the minimum number of IP addresses + url: "/cvo/get-azure-ha-metadata-network-requirements.html" + swagger-title: GET /azure/ha/metadata/network-requirements + data-api-method: GET + data-api-path: "/azure/ha/metadata/network-requirements" + data-summary: Retrieve the minimum number of IP addresses + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Validate the Azure marketplace subscription + url: "/cvo/post-azure-ha-metadata-validate-subscribed-to-ontap-cloud.html" + swagger-title: POST /azure/ha/metadata/validate-subscribed-to-ontap-cloud + data-api-method: POST + data-api-path: "/azure/ha/metadata/validate-subscribed-to-ontap-cloud" + data-summary: Validate the Azure marketplace subscription + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve network extended information + url: "/cvo/get-azure-ha-metadata-vnets.html" + swagger-title: GET /azure/ha/metadata/vnets + data-api-method: GET + data-api-path: "/azure/ha/metadata/vnets" + data-summary: Retrieve network extended information + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all vaults + url: "/cvo/get-azure-ha-metadata-vaults.html" + swagger-title: GET /azure/ha/metadata/vaults + data-api-method: GET + data-api-path: "/azure/ha/metadata/vaults" + data-summary: Retrieve all vaults + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all keys in a vault + url: "/cvo/get-azure-ha-metadata-keys-vault.html" + swagger-title: GET /azure/ha/metadata/keys-vault + data-api-method: GET + data-api-path: "/azure/ha/metadata/keys-vault" + data-summary: Retrieve all keys in a vault + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Azure resource groups + url: "/cvo/get-azure-ha-metadata-resource-groups.html" + swagger-title: GET /azure/ha/metadata/resource-groups + data-api-method: GET + data-api-path: "/azure/ha/metadata/resource-groups" + data-summary: Retrieve Azure resource groups + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new blob container + url: "/cvo/post-azure-ha-metadata-create-container.html" + swagger-title: POST /azure/ha/metadata/create-container + data-api-method: POST + data-api-path: "/azure/ha/metadata/create-container" + data-summary: Create a new blob container + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Azure availability zones + url: "/cvo/get-azure-ha-metadata-availability-zones.html" + swagger-title: GET /azure/ha/metadata/availability-zones + data-api-method: GET + data-api-path: "/azure/ha/metadata/availability-zones" + data-summary: Retrieve Azure availability zones + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve capacity tiers for Azure disk types + url: "/cvo/get-azure-ha-metadata-supported-capacity-tiers.html" + swagger-title: GET /azure/ha/metadata/supported-capacity-tiers + data-api-method: GET + data-api-path: "/azure/ha/metadata/supported-capacity-tiers" + data-summary: Retrieve capacity tiers for Azure disk types + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Azure storage account types + url: "/cvo/get-azure-ha-metadata-storage-account-types.html" + swagger-title: GET /azure/ha/metadata/storage-account-types + data-api-method: GET + data-api-path: "/azure/ha/metadata/storage-account-types" + data-summary: Retrieve Azure storage account types + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve tag names + url: "/cvo/get-azure-ha-metadata-tag-keys.html" + swagger-title: GET /azure/ha/metadata/tag-keys + data-api-method: GET + data-api-path: "/azure/ha/metadata/tag-keys" + data-summary: Retrieve tag names + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all blob containers + url: "/cvo/get-azure-ha-metadata-containers.html" + swagger-title: GET /azure/ha/metadata/containers + data-api-method: GET + data-api-path: "/azure/ha/metadata/containers" + data-summary: Retrieve all blob containers + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Azure regions + url: "/cvo/get-azure-ha-metadata-regions.html" + swagger-title: GET /azure/ha/metadata/regions + data-api-method: GET + data-api-path: "/azure/ha/metadata/regions" + data-summary: Retrieve Azure regions + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the default snapshot policies + url: "/cvo/get-azure-ha-metadata-default-snapshot-policies.html" + swagger-title: GET /azure/ha/metadata/default-snapshot-policies + data-api-method: GET + data-api-path: "/azure/ha/metadata/default-snapshot-policies" + data-summary: Retrieve the default snapshot policies + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve unsupported instance types for acceleration and capacity + tiering + url: "/cvo/get-azure-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html" + swagger-title: GET /azure/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering + data-api-method: GET + data-api-path: "/azure/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering" + data-summary: Retrieve unsupported instance types for acceleration and capacity + tiering + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported features + url: "/cvo/get-azure-ha-metadata-supported-features.html" + swagger-title: GET /azure/ha/metadata/supported-features + data-api-method: GET + data-api-path: "/azure/ha/metadata/supported-features" + data-summary: Retrieve supported features + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the packages configuration + url: "/cvo/get-azure-ha-metadata-packages.html" + swagger-title: GET /azure/ha/metadata/packages + data-api-method: GET + data-api-path: "/azure/ha/metadata/packages" + data-summary: Retrieve the packages configuration + data-deprecated: false + data-category: Azure system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Azure system metadata (single-node) + entries: + - title: Retrieve associated subscriptions + url: "/cvo/get-azure-vsa-metadata-associated-subscriptions.html" + swagger-title: GET /azure/vsa/metadata/associated-subscriptions + data-api-method: GET + data-api-path: "/azure/vsa/metadata/associated-subscriptions" + data-summary: Retrieve associated subscriptions + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the minimum number of required IP addresses + url: "/cvo/get-azure-vsa-metadata-network-requirements.html" + swagger-title: GET /azure/vsa/metadata/network-requirements + data-api-method: GET + data-api-path: "/azure/vsa/metadata/network-requirements" + data-summary: Retrieve the minimum number of required IP addresses + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Confirm the current user subscription + url: "/cvo/post-azure-vsa-metadata-validate-subscribed-to-ontap-cloud.html" + swagger-title: POST /azure/vsa/metadata/validate-subscribed-to-ontap-cloud + data-api-method: POST + data-api-path: "/azure/vsa/metadata/validate-subscribed-to-ontap-cloud" + data-summary: Confirm the current user subscription + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve network extended information + url: "/cvo/get-azure-vsa-metadata-vnets.html" + swagger-title: GET /azure/vsa/metadata/vnets + data-api-method: GET + data-api-path: "/azure/vsa/metadata/vnets" + data-summary: Retrieve network extended information + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all vaults + url: "/cvo/get-azure-vsa-metadata-vaults.html" + swagger-title: GET /azure/vsa/metadata/vaults + data-api-method: GET + data-api-path: "/azure/vsa/metadata/vaults" + data-summary: Retrieve all vaults + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all keys in a vault + url: "/cvo/get-azure-vsa-metadata-keys-vault.html" + swagger-title: GET /azure/vsa/metadata/keys-vault + data-api-method: GET + data-api-path: "/azure/vsa/metadata/keys-vault" + data-summary: Retrieve all keys in a vault + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Azure resource groups by region + url: "/cvo/get-azure-vsa-metadata-resource-groups.html" + swagger-title: GET /azure/vsa/metadata/resource-groups + data-api-method: GET + data-api-path: "/azure/vsa/metadata/resource-groups" + data-summary: Retrieve Azure resource groups by region + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new blob container + url: "/cvo/post-azure-vsa-metadata-create-container.html" + swagger-title: POST /azure/vsa/metadata/create-container + data-api-method: POST + data-api-path: "/azure/vsa/metadata/create-container" + data-summary: Create a new blob container + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Azure availability zones by region + url: "/cvo/get-azure-vsa-metadata-availability-zones.html" + swagger-title: GET /azure/vsa/metadata/availability-zones + data-api-method: GET + data-api-path: "/azure/vsa/metadata/availability-zones" + data-summary: Retrieve Azure availability zones by region + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported capacity tiers for Azure disk types + url: "/cvo/get-azure-vsa-metadata-supported-capacity-tiers.html" + swagger-title: GET /azure/vsa/metadata/supported-capacity-tiers + data-api-method: GET + data-api-path: "/azure/vsa/metadata/supported-capacity-tiers" + data-summary: Retrieve supported capacity tiers for Azure disk types + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported Azure storage account types + url: "/cvo/get-azure-vsa-metadata-storage-account-types.html" + swagger-title: GET /azure/vsa/metadata/storage-account-types + data-api-method: GET + data-api-path: "/azure/vsa/metadata/storage-account-types" + data-summary: Retrieve supported Azure storage account types + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all tag names + url: "/cvo/get-azure-vsa-metadata-tag-keys.html" + swagger-title: GET /azure/vsa/metadata/tag-keys + data-api-method: GET + data-api-path: "/azure/vsa/metadata/tag-keys" + data-summary: Retrieve all tag names + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all blob containers + url: "/cvo/get-azure-vsa-metadata-containers.html" + swagger-title: GET /azure/vsa/metadata/containers + data-api-method: GET + data-api-path: "/azure/vsa/metadata/containers" + data-summary: Retrieve all blob containers + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Azure regions + url: "/cvo/get-azure-vsa-metadata-regions.html" + swagger-title: GET /azure/vsa/metadata/regions + data-api-method: GET + data-api-path: "/azure/vsa/metadata/regions" + data-summary: Retrieve Azure regions + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all Cloud Volumes ONTAP configurations + url: "/cvo/get-azure-vsa-metadata-permutations.html" + swagger-title: GET /azure/vsa/metadata/permutations + data-api-method: GET + data-api-path: "/azure/vsa/metadata/permutations" + data-summary: Retrieve all Cloud Volumes ONTAP configurations + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the default snapshot policies + url: "/cvo/get-azure-vsa-metadata-default-snapshot-policies.html" + swagger-title: GET /azure/vsa/metadata/default-snapshot-policies + data-api-method: GET + data-api-path: "/azure/vsa/metadata/default-snapshot-policies" + data-summary: Retrieve the default snapshot policies + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve unsupported instance types for acceleration and capacity + tiering + url: "/cvo/get-azure-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html" + swagger-title: GET /azure/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering + data-api-method: GET + data-api-path: "/azure/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering" + data-summary: Retrieve unsupported instance types for acceleration and capacity + tiering + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported features + url: "/cvo/get-azure-vsa-metadata-supported-features.html" + swagger-title: GET /azure/vsa/metadata/supported-features + data-api-method: GET + data-api-path: "/azure/vsa/metadata/supported-features" + data-summary: Retrieve supported features + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve package configurations + url: "/cvo/get-azure-vsa-metadata-packages.html" + swagger-title: GET /azure/vsa/metadata/packages + data-api-method: GET + data-api-path: "/azure/vsa/metadata/packages" + data-summary: Retrieve package configurations + data-deprecated: false + data-category: Azure system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Azure systems (HA) + entries: + - title: Retrieve HA systems + url: "/cvo/get-azure-ha-working-environments.html" + swagger-title: GET /azure/ha/working-environments + data-api-method: GET + data-api-path: "/azure/ha/working-environments" + data-summary: Retrieve HA systems + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new Azure HA system + url: "/cvo/post-azure-ha-working-environments.html" + swagger-title: POST /azure/ha/working-environments + data-api-method: POST + data-api-path: "/azure/ha/working-environments" + data-summary: Create a new Azure HA system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Check for non-persistent locks + url: "/cvo/get-azure-ha-working-environments-cifs-locks-exist.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist" + data-summary: Check for non-persistent locks + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Modify the SVM name of the system + url: "/cvo/put-azure-ha-working-environments-svm.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/svm + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/svm" + data-summary: Modify the SVM name of the system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new SVM + url: "/cvo/post-azure-ha-working-environments-svm.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/svm + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/svm" + data-summary: Create a new SVM + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete an SVM + url: "/cvo/delete-azure-ha-working-environments-svm-.html" + swagger-title: DELETE /azure/ha/working-environments/{workingEnvironmentId}/svm/{svmName} + data-api-method: DELETE + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/svm/{svmName}" + data-summary: Delete an SVM + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Azure VMware Solution private cloud clusters for a subscription + url: "/cvo/get-azure-ha-working-environments-resourcegroups-avs-private-clouds-clusters.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters" + data-summary: Retrieve Azure VMware Solution private cloud clusters for + a subscription + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Azure VMware Solution cluster hosts for a subscription + url: "/cvo/get-azure-ha-working-environments-resourcegroups-avs-private-clouds-clusters-hosts.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters/{clusterName}/hosts + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters/{clusterName}/hosts" + data-summary: Retrieve Azure VMware Solution cluster hosts for a subscription + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve available IP addresses in the subnet of a system + url: "/cvo/get-azure-ha-working-environments-available-ips-in-subnet.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/available-ips-in-subnet + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/available-ips-in-subnet" + data-summary: Retrieve available IP addresses in the subnet of a system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Check if a resource group with the specified name exists + url: "/cvo/get-azure-ha-working-environments-resource-group-exists-.html" + swagger-title: GET /azure/ha/working-environments/resource-group-exists/{resourceGroupName} + data-api-method: GET + data-api-path: "/azure/ha/working-environments/resource-group-exists/{resourceGroupName}" + data-summary: Check if a resource group with the specified name exists + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve an Azure VMware Solution private cloud for a subscription + url: "/cvo/get-azure-ha-working-environments-avs-private-clouds.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/avs-private-clouds + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/avs-private-clouds" + data-summary: Retrieve an Azure VMware Solution private cloud for a subscription + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a system + url: "/cvo/get-azure-ha-working-environments-.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}" + data-summary: Retrieve a system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete a system + url: "/cvo/delete-azure-ha-working-environments-.html" + swagger-title: DELETE /azure/ha/working-environments/{workingEnvironmentId} + data-api-method: DELETE + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}" + data-summary: Delete a system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the CIFS configuration for a system + url: "/cvo/get-azure-ha-working-environments-cifs.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/cifs + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/cifs" + data-summary: Retrieve the CIFS configuration for a system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new CIFS configuration for a system + url: "/cvo/post-azure-ha-working-environments-cifs.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/cifs + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/cifs" + data-summary: Create a new CIFS configuration for a system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete the CIFS configuration for a system + url: "/cvo/post-azure-ha-working-environments-delete-cifs.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/delete-cifs + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/delete-cifs" + data-summary: Delete the CIFS configuration for a system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Validate prerequisites for converting a system + url: "/cvo/get-azure-ha-working-environments-validate-byol-to-capacity.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity" + data-summary: Validate prerequisites for converting a system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Set the writing speed + url: "/cvo/put-azure-ha-working-environments-writing-speed.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/writing-speed + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/writing-speed" + data-summary: Set the writing speed + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all license types and their associated instance types + url: "/cvo/get-azure-ha-working-environments-license-instance-type.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/license-instance-type + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/license-instance-type" + data-summary: Retrieve all license types and their associated instance types + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Set the instance type + url: "/cvo/put-azure-ha-working-environments-license-instance-type.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/license-instance-type + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/license-instance-type" + data-summary: Set the instance type + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve images already installed on a system + url: "/cvo/get-azure-ha-working-environments-ontap-available-images.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/ontap-available-images + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/ontap-available-images" + data-summary: Retrieve images already installed on a system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Perform an image update on a single node + url: "/cvo/post-azure-ha-working-environments-update-image.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/update-image + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/update-image" + data-summary: Perform an image update on a single node + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the eligibility support status of a system + url: "/cvo/get-azure-ha-working-environments-update-eligibility.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/update-eligibility + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/update-eligibility" + data-summary: Retrieve the eligibility support status of a system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of upgrade versions + url: "/cvo/get-azure-ha-working-environments-occm-provided-upgrade-versions.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions" + data-summary: Retrieve a list of upgrade versions + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Upload a cloud license file + url: "/cvo/post-azure-ha-working-environments-upload-license-file.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/upload-license-file + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/upload-license-file" + data-summary: Upload a cloud license file + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Upload cloud license file content + url: "/cvo/post-azure-ha-working-environments-upload-licenses.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/upload-licenses + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/upload-licenses" + data-summary: Upload cloud license file content + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Activate the off-box configuration + url: "/cvo/put-azure-ha-working-environments-offbox.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/offbox + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/offbox" + data-summary: Activate the off-box configuration + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Modify the network port broadcast domain MTU + url: "/cvo/put-azure-ha-working-environments-networkoptimization.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/networkOptimization + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/networkOptimization" + data-summary: Modify the network port broadcast domain MTU + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve action parameters + url: "/cvo/get-azure-ha-working-environments-create-request-parameters.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/create-request-parameters + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/create-request-parameters" + data-summary: Retrieve action parameters + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Enable capacity tiering + url: "/cvo/post-azure-ha-working-environments-enable-capacity-tiering.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering" + data-summary: Enable capacity tiering + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the system cost and usage + url: "/cvo/get-azure-ha-working-environments-cost-and-usage.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/cost-and-usage + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/cost-and-usage" + data-summary: Retrieve the system cost and usage + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve system ONTAP savings + url: "/cvo/get-azure-ha-working-environments-ontap-saving.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/ontap-saving + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/ontap-saving" + data-summary: Retrieve system ONTAP savings + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve extra capacity licenses + url: "/cvo/get-azure-ha-working-environments-extra-capacity-licenses.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Retrieve extra capacity licenses + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update an extra capacity license + url: "/cvo/put-azure-ha-working-environments-extra-capacity-licenses.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Update an extra capacity license + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Register an extra capacity license + url: "/cvo/post-azure-ha-working-environments-extra-capacity-licenses.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Register an extra capacity license + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update extra capacity serial numbers + url: "/cvo/put-azure-ha-working-environments-extra-capacity-serials.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Update extra capacity serial numbers + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Register extra capacity serial numbers + url: "/cvo/post-azure-ha-working-environments-extra-capacity-serials.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Register extra capacity serial numbers + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete extra capacity licenses by serial number + url: "/cvo/delete-azure-ha-working-environments-extra-capacity-serials.html" + swagger-title: DELETE /azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: DELETE + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Delete extra capacity licenses by serial number + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Trigger subscription synchronization + url: "/cvo/post-azure-ha-working-environments-sync-subscription.html" + swagger-title: POST /azure/ha/working-environments/sync-subscription + data-api-method: POST + data-api-path: "/azure/ha/working-environments/sync-subscription" + data-summary: Trigger subscription synchronization + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the default Vscan file operation profile + url: "/cvo/put-azure-ha-working-environments-vscan-file-op.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/vscan-file-op + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/vscan-file-op" + data-summary: Update the default Vscan file operation profile + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update a BYOL license to a capacity-based license + url: "/cvo/put-azure-ha-working-environments-byol-to-capacity.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/byol-to-capacity + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/byol-to-capacity" + data-summary: Update a BYOL license to a capacity-based license + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Enable SnapLock for a system + url: "/cvo/put-azure-ha-working-environments-enable-worm.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/enable-worm + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/enable-worm" + data-summary: Enable SnapLock for a system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Create an NTP server + url: "/cvo/post-azure-ha-working-environments-ntp.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/ntp + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/ntp" + data-summary: Create an NTP server + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Start a Cloud Volumes ONTAP instance + url: "/cvo/post-azure-ha-working-environments-start.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/start + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/start" + data-summary: Start a Cloud Volumes ONTAP instance + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Stop a Cloud Volumes ONTAP instance + url: "/cvo/post-azure-ha-working-environments-stop.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/stop + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/stop" + data-summary: Stop a Cloud Volumes ONTAP instance + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the support registration status + url: "/cvo/get-azure-ha-working-environments-support-registration.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/support-registration + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/support-registration" + data-summary: Retrieve the support registration status + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Register a Cloud Volumes ONTAP system with NetApp + url: "/cvo/post-azure-ha-working-environments-support-registration.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/support-registration + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/support-registration" + data-summary: Register a Cloud Volumes ONTAP system with NetApp + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: List the start/stop schedules for Cloud Volumes ONTAP + url: "/cvo/get-azure-ha-working-environments-schedules.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/schedules + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/schedules" + data-summary: List the start/stop schedules for Cloud Volumes ONTAP + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Set schedules for Cloud Volumes ONTAP + url: "/cvo/put-azure-ha-working-environments-schedules.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/schedules + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/schedules" + data-summary: Set schedules for Cloud Volumes ONTAP + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Activate FPolicy for ransomware files + url: "/cvo/put-azure-ha-working-environments-activate-fpolicy.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/activate-fpolicy + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/activate-fpolicy" + data-summary: Activate FPolicy for ransomware files + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Disable FPolicy for ransomware files + url: "/cvo/put-azure-ha-working-environments-disable-fpolicy.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/disable-fpolicy + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/disable-fpolicy" + data-summary: Disable FPolicy for ransomware files + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete FPolicy for ransomware files + url: "/cvo/delete-azure-ha-working-environments-fpolicy.html" + swagger-title: DELETE /azure/ha/working-environments/{workingEnvironmentId}/fpolicy + data-api-method: DELETE + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/fpolicy" + data-summary: Delete FPolicy for ransomware files + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the NetApp Console password + url: "/cvo/put-azure-ha-working-environments-update-credentials.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/update-credentials + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/update-credentials" + data-summary: Update the NetApp Console password + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the tier level + url: "/cvo/post-azure-ha-working-environments-change-tier-level.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/change-tier-level + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/change-tier-level" + data-summary: Update the tier level + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Parse an uploaded cloud license file + url: "/cvo/post-azure-ha-working-environments-parse-license-file.html" + swagger-title: POST /azure/ha/working-environments/parse-license-file + data-api-method: POST + data-api-path: "/azure/ha/working-environments/parse-license-file" + data-summary: Parse an uploaded cloud license file + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve editable tags for the cloud resources + url: "/cvo/get-azure-ha-working-environments-user-tags.html" + swagger-title: GET /azure/ha/working-environments/{workingEnvironmentId}/user-tags + data-api-method: GET + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/user-tags" + data-summary: Retrieve editable tags for the cloud resources + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Modify the user tags for cloud resources + url: "/cvo/put-azure-ha-working-environments-user-tags.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/user-tags + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/user-tags" + data-summary: Modify the user tags for cloud resources + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Activate snapshot policy assignment + url: "/cvo/put-azure-ha-working-environments-activate-snapshot-policy.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy" + data-summary: Activate snapshot policy assignment + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot policy + url: "/cvo/post-azure-ha-working-environments-snapshot-policy.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/snapshot-policy + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/snapshot-policy" + data-summary: Create a snapshot policy + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the serial number of a system + url: "/cvo/post-azure-ha-working-environments-change-serial.html" + swagger-title: POST /azure/ha/working-environments/{workingEnvironmentId}/change-serial + data-api-method: POST + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/change-serial" + data-summary: Update the serial number of a system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Set the cluster password for a system + url: "/cvo/put-azure-ha-working-environments-set-password.html" + swagger-title: PUT /azure/ha/working-environments/{workingEnvironmentId}/set-password + data-api-method: PUT + data-api-path: "/azure/ha/working-environments/{workingEnvironmentId}/set-password" + data-summary: Set the cluster password for a system + data-deprecated: false + data-category: Azure systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Azure systems (single-node) + entries: + - title: Retrieve Cloud Volumes ONTAP systems + url: "/cvo/get-azure-vsa-working-environments.html" + swagger-title: GET /azure/vsa/working-environments + data-api-method: GET + data-api-path: "/azure/vsa/working-environments" + data-summary: Retrieve Cloud Volumes ONTAP systems + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new Cloud Volumes ONTAP system + url: "/cvo/post-azure-vsa-working-environments.html" + swagger-title: POST /azure/vsa/working-environments + data-api-method: POST + data-api-path: "/azure/vsa/working-environments" + data-summary: Create a new Cloud Volumes ONTAP system + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify the SVM name + url: "/cvo/put-azure-vsa-working-environments-svm.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/svm + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/svm" + data-summary: Modify the SVM name + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new SVM + url: "/cvo/post-azure-vsa-working-environments-svm.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/svm + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/svm" + data-summary: Create a new SVM + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete an SVM + url: "/cvo/delete-azure-vsa-working-environments-svm-.html" + swagger-title: DELETE /azure/vsa/working-environments/{workingEnvironmentId}/svm/{svmName} + data-api-method: DELETE + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/svm/{svmName}" + data-summary: Delete an SVM + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Azure VMware Solution private cloud clusters + url: "/cvo/get-azure-vsa-working-environments-resourcegroups-avs-private-clouds-clusters.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters" + data-summary: Retrieve Azure VMware Solution private cloud clusters + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Azure VMware Solution cluster hosts + url: "/cvo/get-azure-vsa-working-environments-resourcegroups-avs-private-clouds-clusters-hosts.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters/{clusterName}/hosts + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/resourceGroups/{resourceGroupName}/avs-private-clouds/{privateCloudName}/clusters/{clusterName}/hosts" + data-summary: Retrieve Azure VMware Solution cluster hosts + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the number of available IP addresses + url: "/cvo/get-azure-vsa-working-environments-available-ips-in-subnet.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/available-ips-in-subnet + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/available-ips-in-subnet" + data-summary: Retrieve the number of available IP addresses + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Check if a resource group with the specified name exists + url: "/cvo/get-azure-vsa-working-environments-resource-group-exists-.html" + swagger-title: GET /azure/vsa/working-environments/resource-group-exists/{resourceGroupName} + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/resource-group-exists/{resourceGroupName}" + data-summary: Check if a resource group with the specified name exists + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve an Azure VMware Solution private cloud + url: "/cvo/get-azure-vsa-working-environments-avs-private-clouds.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/avs-private-clouds + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/avs-private-clouds" + data-summary: Retrieve an Azure VMware Solution private cloud + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a Cloud Volumes ONTAP system + url: "/cvo/get-azure-vsa-working-environments-.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}" + data-summary: Retrieve a Cloud Volumes ONTAP system + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete an existing Cloud Volumes ONTAP system + url: "/cvo/delete-azure-vsa-working-environments-.html" + swagger-title: DELETE /azure/vsa/working-environments/{workingEnvironmentId} + data-api-method: DELETE + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}" + data-summary: Delete an existing Cloud Volumes ONTAP system + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a CIFS configuration + url: "/cvo/get-azure-vsa-working-environments-cifs.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/cifs + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/cifs" + data-summary: Retrieve a CIFS configuration + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set up a new CIFS configuration + url: "/cvo/post-azure-vsa-working-environments-cifs.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/cifs + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/cifs" + data-summary: Set up a new CIFS configuration + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete a CIFS configuration + url: "/cvo/post-azure-vsa-working-environments-delete-cifs.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/delete-cifs + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/delete-cifs" + data-summary: Delete a CIFS configuration + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Validate prerequisites for converting a system + url: "/cvo/get-azure-vsa-working-environments-validate-byol-to-capacity.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity" + data-summary: Validate prerequisites for converting a system + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify the writing speed + url: "/cvo/put-azure-vsa-working-environments-writing-speed.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/writing-speed + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/writing-speed" + data-summary: Modify the writing speed + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all license types + url: "/cvo/get-azure-vsa-working-environments-license-instance-type.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/license-instance-type + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/license-instance-type" + data-summary: Retrieve all license types + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set the instance type + url: "/cvo/put-azure-vsa-working-environments-license-instance-type.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/license-instance-type + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/license-instance-type" + data-summary: Set the instance type + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve images already installed + url: "/cvo/get-azure-vsa-working-environments-ontap-available-images.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/ontap-available-images + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/ontap-available-images" + data-summary: Retrieve images already installed + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Perform a complete image update operation + url: "/cvo/post-azure-vsa-working-environments-update-image.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/update-image + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/update-image" + data-summary: Perform a complete image update operation + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the eligibility support status + url: "/cvo/get-azure-vsa-working-environments-update-eligibility.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/update-eligibility + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/update-eligibility" + data-summary: Retrieve the eligibility support status + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of upgrade versions + url: "/cvo/get-azure-vsa-working-environments-occm-provided-upgrade-versions.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions" + data-summary: Retrieve a list of upgrade versions + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Upload a cloud license file + url: "/cvo/post-azure-vsa-working-environments-upload-license-file.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/upload-license-file + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/upload-license-file" + data-summary: Upload a cloud license file + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Upload cloud license file content + url: "/cvo/post-azure-vsa-working-environments-upload-licenses.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/upload-licenses + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/upload-licenses" + data-summary: Upload cloud license file content + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Activate an off-box configuration + url: "/cvo/put-azure-vsa-working-environments-offbox.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/offbox + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/offbox" + data-summary: Activate an off-box configuration + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify the network port broadcast domain MTU + url: "/cvo/put-azure-vsa-working-environments-networkoptimization.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/networkOptimization + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/networkOptimization" + data-summary: Modify the network port broadcast domain MTU + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the action parameters + url: "/cvo/get-azure-vsa-working-environments-create-request-parameters.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/create-request-parameters + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/create-request-parameters" + data-summary: Retrieve the action parameters + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Enable capacity tiering + url: "/cvo/post-azure-vsa-working-environments-enable-capacity-tiering.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering" + data-summary: Enable capacity tiering + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve systems cost and usage + url: "/cvo/get-azure-vsa-working-environments-cost-and-usage.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/cost-and-usage + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/cost-and-usage" + data-summary: Retrieve systems cost and usage + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve systems ONTAP savings + url: "/cvo/get-azure-vsa-working-environments-ontap-saving.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/ontap-saving + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/ontap-saving" + data-summary: Retrieve systems ONTAP savings + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve extra capacity licenses + url: "/cvo/get-azure-vsa-working-environments-extra-capacity-licenses.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Retrieve extra capacity licenses + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update extra capacity licenses + url: "/cvo/put-azure-vsa-working-environments-extra-capacity-licenses.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Update extra capacity licenses + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Register extra capacity licenses + url: "/cvo/post-azure-vsa-working-environments-extra-capacity-licenses.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Register extra capacity licenses + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update extra capacity serial numbers + url: "/cvo/put-azure-vsa-working-environments-extra-capacity-serials.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Update extra capacity serial numbers + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Register extra capacity serial numbers + url: "/cvo/post-azure-vsa-working-environments-extra-capacity-serials.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Register extra capacity serial numbers + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete extra capacity licenses by serial numbers + url: "/cvo/delete-azure-vsa-working-environments-extra-capacity-serials.html" + swagger-title: DELETE /azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: DELETE + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Delete extra capacity licenses by serial numbers + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Trigger subscription synchronization + url: "/cvo/post-azure-vsa-working-environments-sync-subscription.html" + swagger-title: POST /azure/vsa/working-environments/sync-subscription + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/sync-subscription" + data-summary: Trigger subscription synchronization + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the default Vscan file operation profile + url: "/cvo/put-azure-vsa-working-environments-vscan-file-op.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/vscan-file-op + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/vscan-file-op" + data-summary: Update the default Vscan file operation profile + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the BYOL licence to a capacity-based license + url: "/cvo/put-azure-vsa-working-environments-byol-to-capacity.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity" + data-summary: Update the BYOL licence to a capacity-based license + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Enable SnapLock for an existing system + url: "/cvo/put-azure-vsa-working-environments-enable-worm.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/enable-worm + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/enable-worm" + data-summary: Enable SnapLock for an existing system + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set up an NTP server + url: "/cvo/post-azure-vsa-working-environments-ntp.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/ntp + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/ntp" + data-summary: Set up an NTP server + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Start a specific Cloud Volumes ONTAP instance + url: "/cvo/post-azure-vsa-working-environments-start.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/start + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/start" + data-summary: Start a specific Cloud Volumes ONTAP instance + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Stop a specific Cloud Volumes ONTAP instance + url: "/cvo/post-azure-vsa-working-environments-stop.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/stop + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/stop" + data-summary: Stop a specific Cloud Volumes ONTAP instance + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the support registration status + url: "/cvo/get-azure-vsa-working-environments-support-registration.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/support-registration + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/support-registration" + data-summary: Retrieve the support registration status + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Register a Cloud Volumes ONTAP system with NetApp + url: "/cvo/post-azure-vsa-working-environments-support-registration.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/support-registration + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/support-registration" + data-summary: Register a Cloud Volumes ONTAP system with NetApp + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: List the start-stop schedules + url: "/cvo/get-azure-vsa-working-environments-schedules.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/schedules + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/schedules" + data-summary: List the start-stop schedules + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set the schedules for Cloud Volumes ONTAP + url: "/cvo/put-azure-vsa-working-environments-schedules.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/schedules + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/schedules" + data-summary: Set the schedules for Cloud Volumes ONTAP + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Activate the FPolicy for ransomware files + url: "/cvo/put-azure-vsa-working-environments-activate-fpolicy.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy" + data-summary: Activate the FPolicy for ransomware files + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Disable the FPolicy for ransomware files + url: "/cvo/put-azure-vsa-working-environments-disable-fpolicy.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy" + data-summary: Disable the FPolicy for ransomware files + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete the FPolicy for ransomware files + url: "/cvo/delete-azure-vsa-working-environments-fpolicy.html" + swagger-title: DELETE /azure/vsa/working-environments/{workingEnvironmentId}/fpolicy + data-api-method: DELETE + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/fpolicy" + data-summary: Delete the FPolicy for ransomware files + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the NetApp Console password + url: "/cvo/put-azure-vsa-working-environments-update-credentials.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/update-credentials + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/update-credentials" + data-summary: Update the NetApp Console password + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Change the tier level + url: "/cvo/post-azure-vsa-working-environments-change-tier-level.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/change-tier-level + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/change-tier-level" + data-summary: Change the tier level + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Parse an uploaded cloud license file + url: "/cvo/post-azure-vsa-working-environments-parse-license-file.html" + swagger-title: POST /azure/vsa/working-environments/parse-license-file + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/parse-license-file" + data-summary: Parse an uploaded cloud license file + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve editable tags for cloud resources + url: "/cvo/get-azure-vsa-working-environments-user-tags.html" + swagger-title: GET /azure/vsa/working-environments/{workingEnvironmentId}/user-tags + data-api-method: GET + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/user-tags" + data-summary: Retrieve editable tags for cloud resources + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify user tags for cloud resources + url: "/cvo/put-azure-vsa-working-environments-user-tags.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/user-tags + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/user-tags" + data-summary: Modify user tags for cloud resources + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Activate snapshot policy assignment + url: "/cvo/put-azure-vsa-working-environments-activate-snapshot-policy.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy" + data-summary: Activate snapshot policy assignment + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot policy + url: "/cvo/post-azure-vsa-working-environments-snapshot-policy.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/snapshot-policy + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/snapshot-policy" + data-summary: Create a snapshot policy + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the serial number of Cloud Volumes ONTAP + url: "/cvo/post-azure-vsa-working-environments-change-serial.html" + swagger-title: POST /azure/vsa/working-environments/{workingEnvironmentId}/change-serial + data-api-method: POST + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/change-serial" + data-summary: Update the serial number of Cloud Volumes ONTAP + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set the cluster password for a Cloud Volumes ONTAP system + url: "/cvo/put-azure-vsa-working-environments-set-password.html" + swagger-title: PUT /azure/vsa/working-environments/{workingEnvironmentId}/set-password + data-api-method: PUT + data-api-path: "/azure/vsa/working-environments/{workingEnvironmentId}/set-password" + data-summary: Set the cluster password for a Cloud Volumes ONTAP system + data-deprecated: false + data-category: Azure systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Azure volumes (HA) + entries: + - title: Synchronize AVS hosts + url: "/cvo/put-azure-ha-volumes-storage-vms-volumes-sync-avs-host.html" + swagger-title: PUT /azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/sync-avs-host + data-api-method: PUT + data-api-path: "/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/sync-avs-host" + data-summary: Synchronize Azure VMware Solution (AVS) hosts + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Resize a volume and the respective AVS DataStore + url: "/cvo/put-azure-ha-volumes-storage-vms-volumes-resize-avs-ds.html" + swagger-title: PUT /azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/resize-avs-ds + data-api-method: PUT + data-api-path: "/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/resize-avs-ds" + data-summary: Resize an Azure volume and the respective AVS DataStore with + Cloud Volumes ONTAP + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Remove AVS hosts on a volume + url: "/cvo/delete-azure-ha-volumes-storage-vms-volumes-remove-avs.html" + swagger-title: DELETE /azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/remove-avs + data-api-method: DELETE + data-api-path: "/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/remove-avs" + data-summary: Remove AVS hosts on a volume + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve volumes for backup activation + url: "/cvo/get-azure-ha-volumes-volumes-for-backup.html" + swagger-title: GET /azure/ha/volumes/volumes-for-backup + data-api-method: GET + data-api-path: "/azure/ha/volumes/volumes-for-backup" + data-summary: Retrieve volumes for backup activation + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve quotes for a new volume + url: "/cvo/post-azure-ha-volumes-quote.html" + swagger-title: POST /azure/ha/volumes/quote + data-api-method: POST + data-api-path: "/azure/ha/volumes/quote" + data-summary: Retrieve quotes for a new volume + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the underlying volume tier + url: "/cvo/post-azure-ha-volumes--change-tier.html" + swagger-title: POST /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier + data-api-method: POST + data-api-path: "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier" + data-summary: Update the underlying volume tier + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Modify an existing volume + url: "/cvo/put-azure-ha-volumes--.html" + swagger-title: PUT /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: PUT + data-api-path: "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Modify an existing volume + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete an existing volume + url: "/cvo/delete-azure-ha-volumes--.html" + swagger-title: DELETE /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: DELETE + data-api-path: "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Delete an existing volume + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Add an export policy rule + url: "/cvo/put-azure-ha-volumes--exportpolicy.html" + swagger-title: PUT /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy + data-api-method: PUT + data-api-path: "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy" + data-summary: Add an export policy rule + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all igroups + url: "/cvo/get-azure-ha-volumes-igroups-.html" + swagger-title: GET /azure/ha/volumes/igroups/{workingEnvironmentId}/{svmName} + data-api-method: GET + data-api-path: "/azure/ha/volumes/igroups/{workingEnvironmentId}/{svmName}" + data-summary: Retrieve all igroups + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all iSCSI initiators + url: "/cvo/get-azure-ha-volumes-initiator.html" + swagger-title: GET /azure/ha/volumes/initiator + data-api-method: GET + data-api-path: "/azure/ha/volumes/initiator" + data-summary: Retrieve all iSCSI initiators + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Add an iSCSI initiator + url: "/cvo/post-azure-ha-volumes-initiator.html" + swagger-title: POST /azure/ha/volumes/initiator + data-api-method: POST + data-api-path: "/azure/ha/volumes/initiator" + data-summary: Add an iSCSI initiator + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of volume snapshot descriptions + url: "/cvo/get-azure-ha-volumes--snapshots.html" + swagger-title: GET /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots + data-api-method: GET + data-api-path: "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots" + data-summary: Retrieve a list of volume snapshot descriptions + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Set up Azure VMware Solution on a volume + url: "/cvo/put-azure-ha-volumes-storage-vms-volumes-setup-avs.html" + swagger-title: PUT /azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/setup-avs + data-api-method: PUT + data-api-path: "/azure/ha/volumes/{workingEnvironmentId}/storage-vms/{svmName}/volumes/{volumeName}/setup-avs" + data-summary: Set up Azure VMware Solution on a volume + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Clone an existing volume + url: "/cvo/post-azure-ha-volumes--clone.html" + swagger-title: POST /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone + data-api-method: POST + data-api-path: "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone" + data-summary: Clone an existing volume + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot + url: "/cvo/post-azure-ha-volumes--snapshot.html" + swagger-title: POST /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: POST + data-api-path: "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Create a snapshot + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete a snapshot + url: "/cvo/delete-azure-ha-volumes--snapshot.html" + swagger-title: DELETE /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: DELETE + data-api-path: "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Delete a snapshot + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve volumes + url: "/cvo/get-azure-ha-volumes.html" + swagger-title: GET /azure/ha/volumes + data-api-method: GET + data-api-path: "/azure/ha/volumes" + data-summary: Retrieve volumes + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new volume + url: "/cvo/post-azure-ha-volumes.html" + swagger-title: POST /azure/ha/volumes + data-api-method: POST + data-api-path: "/azure/ha/volumes" + data-summary: Create a new volume + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Move an existing volume + url: "/cvo/post-azure-ha-volumes--move.html" + swagger-title: POST /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move + data-api-method: POST + data-api-path: "/azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move" + data-summary: Move an existing volume + data-deprecated: false + data-category: Azure volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Azure volumes (single-node) + entries: + - title: Retrieve volumes for backup activation + url: "/cvo/get-azure-vsa-volumes-volumes-for-backup.html" + swagger-title: GET /azure/vsa/volumes/volumes-for-backup + data-api-method: GET + data-api-path: "/azure/vsa/volumes/volumes-for-backup" + data-summary: Retrieve volumes for backup activation + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve quotes for a new Azure volume + url: "/cvo/post-azure-vsa-volumes-quote.html" + swagger-title: POST /azure/vsa/volumes/quote + data-api-method: POST + data-api-path: "/azure/vsa/volumes/quote" + data-summary: Retrieve quotes for a new Azure volume + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the underlying volume tier + url: "/cvo/post-azure-vsa-volumes--change-tier.html" + swagger-title: POST /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier + data-api-method: POST + data-api-path: "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier" + data-summary: Update the underlying volume tier + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify an existing volume + url: "/cvo/put-azure-vsa-volumes--.html" + swagger-title: PUT /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: PUT + data-api-path: "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Modify an existing volume + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete an existing volume + url: "/cvo/delete-azure-vsa-volumes--.html" + swagger-title: DELETE /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: DELETE + data-api-path: "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Delete an existing volume + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Add an export policy rule + url: "/cvo/put-azure-vsa-volumes--exportpolicy.html" + swagger-title: PUT /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy + data-api-method: PUT + data-api-path: "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy" + data-summary: Add an export policy rule + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all igroups + url: "/cvo/get-azure-vsa-volumes-igroups-.html" + swagger-title: GET /azure/vsa/volumes/igroups/{workingEnvironmentId}/{svmName} + data-api-method: GET + data-api-path: "/azure/vsa/volumes/igroups/{workingEnvironmentId}/{svmName}" + data-summary: Retrieve all igroups + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all iSCSI initiators + url: "/cvo/get-azure-vsa-volumes-initiator.html" + swagger-title: GET /azure/vsa/volumes/initiator + data-api-method: GET + data-api-path: "/azure/vsa/volumes/initiator" + data-summary: Retrieve all iSCSI initiators + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Add an iSCSI initiator + url: "/cvo/post-azure-vsa-volumes-initiator.html" + swagger-title: POST /azure/vsa/volumes/initiator + data-api-method: POST + data-api-path: "/azure/vsa/volumes/initiator" + data-summary: Add an iSCSI initiator + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of volume snapshot descriptions + url: "/cvo/get-azure-vsa-volumes--snapshots.html" + swagger-title: GET /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots + data-api-method: GET + data-api-path: "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots" + data-summary: Retrieve a list of volume snapshot descriptions + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Clone an existing volume + url: "/cvo/post-azure-vsa-volumes--clone.html" + swagger-title: POST /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone + data-api-method: POST + data-api-path: "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone" + data-summary: Clone an existing volume + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot + url: "/cvo/post-azure-vsa-volumes--snapshot.html" + swagger-title: POST /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: POST + data-api-path: "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Create a snapshot + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete a snapshot + url: "/cvo/delete-azure-vsa-volumes--snapshot.html" + swagger-title: DELETE /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: DELETE + data-api-path: "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Delete a snapshot + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all volumes + url: "/cvo/get-azure-vsa-volumes.html" + swagger-title: GET /azure/vsa/volumes + data-api-method: GET + data-api-path: "/azure/vsa/volumes" + data-summary: Retrieve all volumes + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new volume + url: "/cvo/post-azure-vsa-volumes.html" + swagger-title: POST /azure/vsa/volumes + data-api-method: POST + data-api-path: "/azure/vsa/volumes" + data-summary: Create a new volume + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Move an existing volume + url: "/cvo/post-azure-vsa-volumes--move.html" + swagger-title: POST /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move + data-api-method: POST + data-api-path: "/azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move" + data-summary: Move an existing volume + data-deprecated: false + data-category: Azure volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Cloud compliance operations + entries: + - title: Disable scanning using the service ID + url: "/cvo/post-cloud-compliance-disable-service-scan.html" + swagger-title: POST /cloud-compliance/{serviceId}/disable-service-scan + data-api-method: POST + data-api-path: "/cloud-compliance/{serviceId}/disable-service-scan" + data-summary: Disable scanning using the service ID + data-deprecated: false + data-category: Cloud compliance operations + data-tag-description: '' + data-introduced: '' + - title: Enable on-premises scanning using the system ID + url: "/cvo/post-cloud-compliance-enable-onprem-scan.html" + swagger-title: POST /cloud-compliance/{workingEnvironmentId}/enable-onprem-scan + data-api-method: POST + data-api-path: "/cloud-compliance/{workingEnvironmentId}/enable-onprem-scan" + data-summary: Enable on-premises scanning using the system ID + data-deprecated: false + data-category: Cloud compliance operations + data-tag-description: '' + data-introduced: '' + - title: Enable scanning using the file system ID + url: "/cvo/post-cloud-compliance-fsx-enable-scan.html" + swagger-title: POST /cloud-compliance/fsx/{fileSystemId}/enable-scan + data-api-method: POST + data-api-path: "/cloud-compliance/fsx/{fileSystemId}/enable-scan" + data-summary: Enable scanning using the file system ID + data-deprecated: false + data-category: Cloud compliance operations + data-tag-description: '' + data-introduced: '' + - title: Disable scanning using the file system ID + url: "/cvo/post-cloud-compliance-fsx-disable-scan.html" + swagger-title: POST /cloud-compliance/fsx/{fileSystemId}/disable-scan + data-api-method: POST + data-api-path: "/cloud-compliance/fsx/{fileSystemId}/disable-scan" + data-summary: Disable scanning using the file system ID + data-deprecated: false + data-category: Cloud compliance operations + data-tag-description: '' + data-introduced: '' + - title: Enable scanning using the service ID + url: "/cvo/post-cloud-compliance-enable-service-scan.html" + swagger-title: POST /cloud-compliance/{serviceId}/enable-service-scan + data-api-method: POST + data-api-path: "/cloud-compliance/{serviceId}/enable-service-scan" + data-summary: Enable scanning using the service ID + data-deprecated: false + data-category: Cloud compliance operations + data-tag-description: '' + data-introduced: '' + - title: Deploy a cloud compliance instance by systems + url: "/cvo/post-cloud-compliance-deploy-by-working-environments.html" + swagger-title: POST /cloud-compliance/deploy-by-working-environments + data-api-method: POST + data-api-path: "/cloud-compliance/deploy-by-working-environments" + data-summary: Deploy a cloud compliance instance by systems + data-deprecated: false + data-category: Cloud compliance operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve cloud compliance information + url: "/cvo/get-cloud-compliance-info.html" + swagger-title: GET /cloud-compliance/info + data-api-method: GET + data-api-path: "/cloud-compliance/info" + data-summary: Retrieve cloud compliance information + data-deprecated: false + data-category: Cloud compliance operations + data-tag-description: '' + data-introduced: '' + - title: Disable on-premises scanning + url: "/cvo/post-cloud-compliance-disable-onprem-scan.html" + swagger-title: POST /cloud-compliance/{workingEnvironmentId}/disable-onprem-scan + data-api-method: POST + data-api-path: "/cloud-compliance/{workingEnvironmentId}/disable-onprem-scan" + data-summary: Disable on-premises scanning + data-deprecated: false + data-category: Cloud compliance operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve the service cloud compliance status using the file system + ID + url: "/cvo/get-cloud-compliance-fsx-compliance-status.html" + swagger-title: GET /cloud-compliance/fsx/{fileSystemId}/compliance-status + data-api-method: GET + data-api-path: "/cloud-compliance/fsx/{fileSystemId}/compliance-status" + data-summary: Retrieve the service cloud compliance status using the file + system ID + data-deprecated: false + data-category: Cloud compliance operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve the service cloud compliance status using the service ID + url: "/cvo/get-cloud-compliance-compliance-status.html" + swagger-title: GET /cloud-compliance/{serviceId}/compliance-status + data-api-method: GET + data-api-path: "/cloud-compliance/{serviceId}/compliance-status" + data-summary: Retrieve the service cloud compliance status using the service + ID + data-deprecated: false + data-category: Cloud compliance operations + data-tag-description: '' + data-introduced: '' + - title: Enable scanning using the system ID + url: "/cvo/post-cloud-compliance-enable-scan.html" + swagger-title: POST /cloud-compliance/{workingEnvironmentId}/enable-scan + data-api-method: POST + data-api-path: "/cloud-compliance/{workingEnvironmentId}/enable-scan" + data-summary: Enable scanning using the system ID + data-deprecated: false + data-category: Cloud compliance operations + data-tag-description: '' + data-introduced: '' + - title: Disable scanning using the system ID + url: "/cvo/post-cloud-compliance-disable-scan.html" + swagger-title: POST /cloud-compliance/{workingEnvironmentId}/disable-scan + data-api-method: POST + data-api-path: "/cloud-compliance/{workingEnvironmentId}/disable-scan" + data-summary: Disable scanning using the system ID + data-deprecated: false + data-category: Cloud compliance operations + data-tag-description: '' + data-introduced: '' + - title: Common system operations + entries: + - title: Retrieve capacity-based BYOL license metering details + url: "/cvo/get-working-environments-by-capacity-byol-details-v2.html" + swagger-title: GET /working-environments/by-capacity-byol-details-v2 + data-api-method: GET + data-api-path: "/working-environments/by-capacity-byol-details-v2" + data-summary: Retrieve Cloud Volumes ONTAP capacity-based BYOL license metering + details + data-deprecated: false + data-category: Common system operations + data-tag-description: '' + data-introduced: '' + - title: Trigger dark site capacity metering report generation + url: "/cvo/post-working-environments-metering-report.html" + swagger-title: POST /working-environments/metering-report + data-api-method: POST + data-api-path: "/working-environments/metering-report" + data-summary: Trigger NetApp Console dark site capacity metering report + generation + data-deprecated: false + data-category: Common system operations + data-tag-description: '' + data-introduced: '' + - title: Check if a system with the specified name exists + url: "/cvo/get-working-environments-exists-.html" + swagger-title: GET /working-environments/exists/{workingEnvironmentName} + data-api-method: GET + data-api-path: "/working-environments/exists/{workingEnvironmentName}" + data-summary: Check if a system with the specified name exists + data-deprecated: false + data-category: Common system operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve all non-premises system actions for a tenant ID + url: "/cvo/get-working-environments-actionrequired-.html" + swagger-title: GET /working-environments/actionRequired/{tenantId} + data-api-method: GET + data-api-path: "/working-environments/actionRequired/{tenantId}" + data-summary: Retrieve all non-premises system actions for a tenant ID + data-deprecated: false + data-category: Common system operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve all systems + url: "/cvo/get-working-environments.html" + swagger-title: GET /working-environments + data-api-method: GET + data-api-path: "/working-environments" + data-summary: Retrieve all systems + data-deprecated: false + data-category: Common system operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve a Cloud Volumes ONTAP system + url: "/cvo/get-working-environments-.html" + swagger-title: GET /working-environments/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/working-environments/{workingEnvironmentId}" + data-summary: Retrieve a Cloud Volumes ONTAP system + data-deprecated: false + data-category: Common system operations + data-tag-description: '' + data-introduced: '' + - title: FlexCache volume operations + entries: + - title: Create a new FlexCache volume for an FSx system + url: "/cvo/post-flexcache-fsx.html" + swagger-title: POST /flexcache/fsx + data-api-method: POST + data-api-path: "/flexcache/fsx" + data-summary: Create a new FlexCache volume for an FSx system + data-deprecated: false + data-category: FlexCache volume operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve all FlexCache volume relationships + url: "/cvo/get-flexcache-all-relationships.html" + swagger-title: GET /flexcache/all-relationships + data-api-method: GET + data-api-path: "/flexcache/all-relationships" + data-summary: Retrieve all FlexCache volume relationships + data-deprecated: false + data-category: FlexCache volume operations + data-tag-description: '' + data-introduced: '' + - title: Modify a FlexCache volume + url: "/cvo/put-flexcache-caches-.html" + swagger-title: PUT /flexcache/{workingEnvironmentId}/caches/{cacheId} + data-api-method: PUT + data-api-path: "/flexcache/{workingEnvironmentId}/caches/{cacheId}" + data-summary: Modify a FlexCache volume + data-deprecated: false + data-category: FlexCache volume operations + data-tag-description: '' + data-introduced: '' + - title: Delete a FlexCache volume + url: "/cvo/delete-flexcache-caches-.html" + swagger-title: DELETE /flexcache/{workingEnvironmentId}/caches/{cacheId} + data-api-method: DELETE + data-api-path: "/flexcache/{workingEnvironmentId}/caches/{cacheId}" + data-summary: Delete a FlexCache volume + data-deprecated: false + data-category: FlexCache volume operations + data-tag-description: '' + data-introduced: '' + - title: Create a new FlexCache volume + url: "/cvo/post-flexcache.html" + swagger-title: POST /flexcache + data-api-method: POST + data-api-path: "/flexcache" + data-summary: Create a new FlexCache volume + data-deprecated: false + data-category: FlexCache volume operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve all FlexCache volumes lists + url: "/cvo/get-flexcache-caches.html" + swagger-title: GET /flexcache/caches + data-api-method: GET + data-api-path: "/flexcache/caches" + data-summary: Retrieve all FlexCache volumes lists + data-deprecated: false + data-category: FlexCache volume operations + data-tag-description: '' + data-introduced: '' + - title: Google Cloud aggregates (HA) + entries: + - title: Update IOPS and throughput for the disks in an existing aggregate + url: "/cvo/put-gcp-ha-aggregates-.html" + swagger-title: PUT /gcp/ha/aggregates/{workingEnvironmentId}/{aggregateName} + data-api-method: PUT + data-api-path: "/gcp/ha/aggregates/{workingEnvironmentId}/{aggregateName}" + data-summary: Update IOPS and throughput for the disks in an existing Cloud + Volumes ONTAP aggregate + data-deprecated: false + data-category: Google Cloud aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete an aggregate + url: "/cvo/delete-gcp-ha-aggregates-.html" + swagger-title: DELETE /gcp/ha/aggregates/{workingEnvironmentId}/{aggregateName} + data-api-method: DELETE + data-api-path: "/gcp/ha/aggregates/{workingEnvironmentId}/{aggregateName}" + data-summary: Delete an aggregate + data-deprecated: false + data-category: Google Cloud aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve aggregates + url: "/cvo/get-gcp-ha-aggregates-.html" + swagger-title: GET /gcp/ha/aggregates/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/gcp/ha/aggregates/{workingEnvironmentId}" + data-summary: Retrieve aggregates + data-deprecated: false + data-category: Google Cloud aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new aggregate + url: "/cvo/post-gcp-ha-aggregates.html" + swagger-title: POST /gcp/ha/aggregates + data-api-method: POST + data-api-path: "/gcp/ha/aggregates" + data-summary: Create a new aggregate + data-deprecated: false + data-category: Google Cloud aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Add disks to an aggregate + url: "/cvo/post-gcp-ha-aggregates--disks.html" + swagger-title: POST /gcp/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks + data-api-method: POST + data-api-path: "/gcp/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks" + data-summary: Add disks to an aggregate + data-deprecated: false + data-category: Google Cloud aggregates (HA) + data-tag-description: '' + data-introduced: '' + - title: Google Cloud aggregates (single-node) + entries: + - title: Update IOPS and throughput for the disks in an existing aggregate + url: "/cvo/put-gcp-vsa-aggregates-.html" + swagger-title: PUT /gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName} + data-api-method: PUT + data-api-path: "/gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName}" + data-summary: Update IOPS and throughput for the disks in an existing Cloud + Volumes ONTAP aggregate + data-deprecated: false + data-category: Google Cloud aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete an aggregate + url: "/cvo/delete-gcp-vsa-aggregates-.html" + swagger-title: DELETE /gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName} + data-api-method: DELETE + data-api-path: "/gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName}" + data-summary: Delete an aggregate + data-deprecated: false + data-category: Google Cloud aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve aggregates + url: "/cvo/get-gcp-vsa-aggregates-.html" + swagger-title: GET /gcp/vsa/aggregates/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/gcp/vsa/aggregates/{workingEnvironmentId}" + data-summary: Retrieve aggregates + data-deprecated: false + data-category: Google Cloud aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new aggregate + url: "/cvo/post-gcp-vsa-aggregates.html" + swagger-title: POST /gcp/vsa/aggregates + data-api-method: POST + data-api-path: "/gcp/vsa/aggregates" + data-summary: Create a new aggregate + data-deprecated: false + data-category: Google Cloud aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Add disks to an aggregate + url: "/cvo/post-gcp-vsa-aggregates--disks.html" + swagger-title: POST /gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks + data-api-method: POST + data-api-path: "/gcp/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks" + data-summary: Add disks to an aggregate + data-deprecated: false + data-category: Google Cloud aggregates (single-node) + data-tag-description: '' + data-introduced: '' + - title: Google Cloud system discovery (HA) + entries: + - title: Retrieve a list of HA systems for a Google Cloud region + url: "/cvo/get-gcp-ha-discovery-discover.html" + swagger-title: GET /gcp/ha/discovery/discover + data-api-method: GET + data-api-path: "/gcp/ha/discovery/discover" + data-summary: Retrieve a list of HA systems for a Google Cloud region + data-deprecated: false + data-category: Google Cloud system discovery (HA) + data-tag-description: '' + data-introduced: '' + - title: Save an HA system to the NetApp Console database + url: "/cvo/post-gcp-ha-discovery-recover.html" + swagger-title: POST /gcp/ha/discovery/recover + data-api-method: POST + data-api-path: "/gcp/ha/discovery/recover" + data-summary: Save an HA system to the NetApp Console database + data-deprecated: false + data-category: Google Cloud system discovery (HA) + data-tag-description: '' + data-introduced: '' + - title: Google Cloud system discovery (single-node) + entries: + - title: Retrieve a list of systems for a Google Cloud zone + url: "/cvo/get-gcp-vsa-discover.html" + swagger-title: GET /gcp/vsa/discover + data-api-method: GET + data-api-path: "/gcp/vsa/discover" + data-summary: Retrieve a list of systems for a Google Cloud zone + data-deprecated: false + data-category: Google Cloud system discovery (single-node) + data-tag-description: '' + data-introduced: '' + - title: Save a system to the NetApp Console database + url: "/cvo/post-gcp-vsa-recover.html" + swagger-title: POST /gcp/vsa/recover + data-api-method: POST + data-api-path: "/gcp/vsa/recover" + data-summary: Save a system to the NetApp Console database + data-deprecated: false + data-category: Google Cloud system discovery (single-node) + data-tag-description: '' + data-introduced: '' + - title: Google Cloud system metadata (HA) + entries: + - title: Retrieve Google Cloud regions and zones + url: "/cvo/get-gcp-ha-metadata-zones.html" + swagger-title: GET /gcp/ha/metadata/zones + data-api-method: GET + data-api-path: "/gcp/ha/metadata/zones" + data-summary: Retrieve Google Cloud regions and zones + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Google Cloud networks and subnetworks + url: "/cvo/get-gcp-ha-metadata-vpcs.html" + swagger-title: GET /gcp/ha/metadata/vpcs + data-api-method: GET + data-api-path: "/gcp/ha/metadata/vpcs" + data-summary: Retrieve Google Cloud networks and subnetworks + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all labels for a project ID and region + url: "/cvo/get-gcp-ha-metadata-tag-keys.html" + swagger-title: GET /gcp/ha/metadata/tag-keys + data-api-method: GET + data-api-path: "/gcp/ha/metadata/tag-keys" + data-summary: Retrieve all labels for a project ID and region + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all Cloud Volumes ONTAP configurations + url: "/cvo/get-gcp-ha-metadata-permutations.html" + swagger-title: GET /gcp/ha/metadata/permutations + data-api-method: GET + data-api-path: "/gcp/ha/metadata/permutations" + data-summary: Retrieve all Cloud Volumes ONTAP configurations + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Google Cloud worker pools for a Cloud Volumes ONTAP system + url: "/cvo/get-gcp-ha-metadata-workerpools.html" + swagger-title: GET /gcp/ha/metadata/workerPools + data-api-method: GET + data-api-path: "/gcp/ha/metadata/workerPools" + data-summary: Retrieve Google Cloud worker pools for a Cloud Volumes ONTAP + system + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Google Cloud encryption keys for a region + url: "/cvo/get-gcp-ha-metadata-gcp-encryption-keys.html" + swagger-title: GET /gcp/ha/metadata/gcp-encryption-keys + data-api-method: GET + data-api-path: "/gcp/ha/metadata/gcp-encryption-keys" + data-summary: Retrieve Google Cloud encryption keys for a region + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the minimum number of IP addresses for a system + url: "/cvo/get-gcp-ha-metadata-network-requirements.html" + swagger-title: GET /gcp/ha/metadata/network-requirements + data-api-method: GET + data-api-path: "/gcp/ha/metadata/network-requirements" + data-summary: Retrieve the minimum number of IP addresses for a system + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of service accounts + url: "/cvo/get-gcp-ha-metadata-service-accounts.html" + swagger-title: GET /gcp/ha/metadata/service-accounts + data-api-method: GET + data-api-path: "/gcp/ha/metadata/service-accounts" + data-summary: Retrieve a list of service accounts + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all cloud storage buckets + url: "/cvo/get-gcp-ha-metadata-buckets.html" + swagger-title: GET /gcp/ha/metadata/buckets + data-api-method: GET + data-api-path: "/gcp/ha/metadata/buckets" + data-summary: Retrieve all cloud storage buckets + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported capacity tiers for Google Cloud disk types + url: "/cvo/get-gcp-ha-metadata-supported-capacity-tiers.html" + swagger-title: GET /gcp/ha/metadata/supported-capacity-tiers + data-api-method: GET + data-api-path: "/gcp/ha/metadata/supported-capacity-tiers" + data-summary: Retrieve supported capacity tiers for Google Cloud disk types + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new bucket + url: "/cvo/post-gcp-ha-metadata-create-bucket.html" + swagger-title: POST /gcp/ha/metadata/create-bucket + data-api-method: POST + data-api-path: "/gcp/ha/metadata/create-bucket" + data-summary: Create a new bucket + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the supported disk types + url: "/cvo/get-gcp-ha-metadata-gcp-disk-types.html" + swagger-title: GET /gcp/ha/metadata/gcp-disk-types + data-api-method: GET + data-api-path: "/gcp/ha/metadata/gcp-disk-types" + data-summary: Retrieve the supported disk types + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Google Cloud regions + url: "/cvo/get-gcp-ha-metadata-regions.html" + swagger-title: GET /gcp/ha/metadata/regions + data-api-method: GET + data-api-path: "/gcp/ha/metadata/regions" + data-summary: Retrieve Google Cloud regions + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of projects + url: "/cvo/get-gcp-ha-metadata-projects.html" + swagger-title: GET /gcp/ha/metadata/projects + data-api-method: GET + data-api-path: "/gcp/ha/metadata/projects" + data-summary: Retrieve a list of projects + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the default snapshot policies + url: "/cvo/get-gcp-ha-metadata-default-snapshot-policies.html" + swagger-title: GET /gcp/ha/metadata/default-snapshot-policies + data-api-method: GET + data-api-path: "/gcp/ha/metadata/default-snapshot-policies" + data-summary: Retrieve the default snapshot policies + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve instance types that do not support acceleration and capacity + tiering + url: "/cvo/get-gcp-ha-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html" + swagger-title: GET /gcp/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering + data-api-method: GET + data-api-path: "/gcp/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering" + data-summary: Retrieve instance types that do not support acceleration and + capacity tiering + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported features + url: "/cvo/get-gcp-ha-metadata-supported-features.html" + swagger-title: GET /gcp/ha/metadata/supported-features + data-api-method: GET + data-api-path: "/gcp/ha/metadata/supported-features" + data-summary: Retrieve supported features + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the packages configuration + url: "/cvo/get-gcp-ha-metadata-packages.html" + swagger-title: GET /gcp/ha/metadata/packages + data-api-method: GET + data-api-path: "/gcp/ha/metadata/packages" + data-summary: Retrieve the packages configuration + data-deprecated: false + data-category: Google Cloud system metadata (HA) + data-tag-description: '' + data-introduced: '' + - title: Google Cloud system metadata (single-node) + entries: + - title: Retrieve Google Cloud worker pools for a Cloud Volumes ONTAP system + url: "/cvo/get-gcp-vsa-metadata-workerpools.html" + swagger-title: GET /gcp/vsa/metadata/workerPools + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/workerPools" + data-summary: Retrieve Google Cloud worker pools for a Cloud Volumes ONTAP + system + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Google Cloud encryption keys for a region + url: "/cvo/get-gcp-vsa-metadata-gcp-encryption-keys.html" + swagger-title: GET /gcp/vsa/metadata/gcp-encryption-keys + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/gcp-encryption-keys" + data-summary: Retrieve Google Cloud encryption keys for a region + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the minimum number of IP addresses for a system + url: "/cvo/get-gcp-vsa-metadata-network-requirements.html" + swagger-title: GET /gcp/vsa/metadata/network-requirements + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/network-requirements" + data-summary: Retrieve the minimum number of IP addresses for a system + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of service accounts + url: "/cvo/get-gcp-vsa-metadata-service-accounts.html" + swagger-title: GET /gcp/vsa/metadata/service-accounts + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/service-accounts" + data-summary: Retrieve a list of service accounts + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all cloud storage buckets + url: "/cvo/get-gcp-vsa-metadata-buckets.html" + swagger-title: GET /gcp/vsa/metadata/buckets + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/buckets" + data-summary: Retrieve all cloud storage buckets + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported capacity tiers for Google Cloud disk types + url: "/cvo/get-gcp-vsa-metadata-supported-capacity-tiers.html" + swagger-title: GET /gcp/vsa/metadata/supported-capacity-tiers + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/supported-capacity-tiers" + data-summary: Retrieve supported capacity tiers for Google Cloud disk types + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new bucket + url: "/cvo/post-gcp-vsa-metadata-create-bucket.html" + swagger-title: POST /gcp/vsa/metadata/create-bucket + data-api-method: POST + data-api-path: "/gcp/vsa/metadata/create-bucket" + data-summary: Create a new bucket + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the supported Google Cloud disk types + url: "/cvo/get-gcp-vsa-metadata-gcp-disk-types.html" + swagger-title: GET /gcp/vsa/metadata/gcp-disk-types + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/gcp-disk-types" + data-summary: Retrieve the supported Google Cloud disk types + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all the labels for a project ID and zone + url: "/cvo/get-gcp-vsa-metadata-tag-keys.html" + swagger-title: GET /gcp/vsa/metadata/tag-keys + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/tag-keys" + data-summary: Retrieve all the labels for a project ID and zone + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve Google Cloud regions + url: "/cvo/get-gcp-vsa-metadata-regions.html" + swagger-title: GET /gcp/vsa/metadata/regions + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/regions" + data-summary: Retrieve Google Cloud regions + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of projects + url: "/cvo/get-gcp-vsa-metadata-projects.html" + swagger-title: GET /gcp/vsa/metadata/projects + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/projects" + data-summary: Retrieve a list of projects + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all Cloud Volumes ONTAP configurations + url: "/cvo/get-gcp-vsa-metadata-permutations.html" + swagger-title: GET /gcp/vsa/metadata/permutations + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/permutations" + data-summary: Retrieve all Cloud Volumes ONTAP configurations + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve default snapshot policies + url: "/cvo/get-gcp-vsa-metadata-default-snapshot-policies.html" + swagger-title: GET /gcp/vsa/metadata/default-snapshot-policies + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/default-snapshot-policies" + data-summary: Retrieve default snapshot policies + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the instance types that do not support acceleration and + capacity tiering + url: "/cvo/get-gcp-vsa-metadata-instance-types-not-supporting-acceleration-and-capacity-tiering.html" + swagger-title: GET /gcp/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering" + data-summary: Retrieve the instance types that do not support acceleration + and capacity tiering + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported features + url: "/cvo/get-gcp-vsa-metadata-supported-features.html" + swagger-title: GET /gcp/vsa/metadata/supported-features + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/supported-features" + data-summary: Retrieve supported features + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the packages configuration + url: "/cvo/get-gcp-vsa-metadata-packages.html" + swagger-title: GET /gcp/vsa/metadata/packages + data-api-method: GET + data-api-path: "/gcp/vsa/metadata/packages" + data-summary: Retrieve the packages configuration + data-deprecated: false + data-category: Google Cloud system metadata (single-node) + data-tag-description: '' + data-introduced: '' + - title: Google Cloud systems (HA) + entries: + - title: Retrieve Cloud Volumes ONTAP systems + url: "/cvo/get-gcp-ha-working-environments.html" + swagger-title: GET /gcp/ha/working-environments + data-api-method: GET + data-api-path: "/gcp/ha/working-environments" + data-summary: Retrieve Cloud Volumes ONTAP systems + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new Cloud Volumes ONTAP Google Cloud HA system + url: "/cvo/post-gcp-ha-working-environments.html" + swagger-title: POST /gcp/ha/working-environments + data-api-method: POST + data-api-path: "/gcp/ha/working-environments" + data-summary: Create a new Cloud Volumes ONTAP Google Cloud HA system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Stop a specific Cloud Volumes ONTAP instance + url: "/cvo/post-gcp-ha-working-environments-stop.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/stop + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/stop" + data-summary: Stop a specific Cloud Volumes ONTAP instance + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Check for non-persistent locks held on CIFS sessions + url: "/cvo/get-gcp-ha-working-environments-cifs-locks-exist.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist" + data-summary: Check for non-persistent locks held on CIFS sessions + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Modify the SVM name of the Cloud Volumes ONTAP system + url: "/cvo/put-gcp-ha-working-environments-svm.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/svm + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/svm" + data-summary: Modify the SVM name of the Cloud Volumes ONTAP system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new SVM + url: "/cvo/post-gcp-ha-working-environments-svm.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/svm + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/svm" + data-summary: Create a new SVM + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a system + url: "/cvo/get-gcp-ha-working-environments-.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}" + data-summary: Retrieve a system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete an existing system + url: "/cvo/delete-gcp-ha-working-environments-.html" + swagger-title: DELETE /gcp/ha/working-environments/{workingEnvironmentId} + data-api-method: DELETE + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}" + data-summary: Delete an existing system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete an SVM + url: "/cvo/delete-gcp-ha-working-environments-svm-.html" + swagger-title: DELETE /gcp/ha/working-environments/{workingEnvironmentId}/svm/{svmName} + data-api-method: DELETE + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/svm/{svmName}" + data-summary: Delete an SVM + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the CIFS configuration for a system + url: "/cvo/get-gcp-ha-working-environments-cifs.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/cifs + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/cifs" + data-summary: Retrieve the CIFS configuration for a system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new CIFS configuration for a system + url: "/cvo/post-gcp-ha-working-environments-cifs.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/cifs + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/cifs" + data-summary: Create a new CIFS configuration for a system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete the CIFS configuration for a system + url: "/cvo/post-gcp-ha-working-environments-delete-cifs.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/delete-cifs + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/delete-cifs" + data-summary: Delete the CIFS configuration for a system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Validate prerequisites for converting a system + url: "/cvo/get-gcp-ha-working-environments-validate-byol-to-capacity.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/validate-byol-to-capacity" + data-summary: Validate prerequisites for converting a system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Modify the writing speed for a system + url: "/cvo/put-gcp-ha-working-environments-writing-speed.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/writing-speed + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/writing-speed" + data-summary: Modify the writing speed for a system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all license types for a system + url: "/cvo/get-gcp-ha-working-environments-license-instance-type.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/license-instance-type + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/license-instance-type" + data-summary: Retrieve all license types for a system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Set the instance type + url: "/cvo/put-gcp-ha-working-environments-license-instance-type.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/license-instance-type + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/license-instance-type" + data-summary: Set the instance type + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve images already installed on a system + url: "/cvo/get-gcp-ha-working-environments-ontap-available-images.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/ontap-available-images + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/ontap-available-images" + data-summary: Retrieve images already installed on a system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Perform a complete image update + url: "/cvo/post-gcp-ha-working-environments-update-image.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/update-image + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/update-image" + data-summary: Perform a complete image update + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the eligibility support status + url: "/cvo/get-gcp-ha-working-environments-update-eligibility.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/update-eligibility + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/update-eligibility" + data-summary: Retrieve the eligibility support status + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of upgrade versions + url: "/cvo/get-gcp-ha-working-environments-occm-provided-upgrade-versions.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions" + data-summary: Retrieve a list of upgrade versions + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Upload a cloud license file + url: "/cvo/post-gcp-ha-working-environments-upload-license-file.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/upload-license-file + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/upload-license-file" + data-summary: Upload a cloud license file + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Upload cloud license file content + url: "/cvo/post-gcp-ha-working-environments-upload-licenses.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/upload-licenses + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/upload-licenses" + data-summary: Upload cloud license file content + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Activate an off-box configuration + url: "/cvo/put-gcp-ha-working-environments-offbox.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/offbox + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/offbox" + data-summary: Activate an off-box configuration + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Modify the network port broadcast domain MTU + url: "/cvo/put-gcp-ha-working-environments-networkoptimization.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/networkOptimization + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/networkOptimization" + data-summary: Modify the network port broadcast domain MTU + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve action parameters + url: "/cvo/get-gcp-ha-working-environments-create-request-parameters.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/create-request-parameters + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/create-request-parameters" + data-summary: Retrieve action parameters + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Enable capacity tiering + url: "/cvo/post-gcp-ha-working-environments-enable-capacity-tiering.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering" + data-summary: Enable capacity tiering + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the system cost and usage + url: "/cvo/get-gcp-ha-working-environments-cost-and-usage.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/cost-and-usage + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/cost-and-usage" + data-summary: Retrieve the system cost and usage + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve system ONTAP savings + url: "/cvo/get-gcp-ha-working-environments-ontap-saving.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/ontap-saving + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/ontap-saving" + data-summary: Retrieve system ONTAP savings + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve extra capacity licenses + url: "/cvo/get-gcp-ha-working-environments-extra-capacity-licenses.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Retrieve extra capacity licenses + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update extra capacity licenses + url: "/cvo/put-gcp-ha-working-environments-extra-capacity-licenses.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Update extra capacity licenses + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Register an extra capacity license + url: "/cvo/post-gcp-ha-working-environments-extra-capacity-licenses.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Register an extra capacity license + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update extra capacity license serial numbers + url: "/cvo/put-gcp-ha-working-environments-extra-capacity-serials.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Update extra capacity license serial numbers + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Register extra capacity license serial numbers + url: "/cvo/post-gcp-ha-working-environments-extra-capacity-serials.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Register extra capacity license serial numbers + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete extra capacity licenses using the license serial numbers + url: "/cvo/delete-gcp-ha-working-environments-extra-capacity-serials.html" + swagger-title: DELETE /gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: DELETE + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Delete extra capacity licenses using the license serial numbers + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Trigger subscription synchronization + url: "/cvo/post-gcp-ha-working-environments-sync-subscription.html" + swagger-title: POST /gcp/ha/working-environments/sync-subscription + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/sync-subscription" + data-summary: Trigger subscription synchronization + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the default Vscan file operation profile + url: "/cvo/put-gcp-ha-working-environments-vscan-file-op.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/vscan-file-op + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/vscan-file-op" + data-summary: Update the default Vscan file operation profile + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update a BYOL license to a capacity-based license + url: "/cvo/put-gcp-ha-working-environments-byol-to-capacity.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/byol-to-capacity + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/byol-to-capacity" + data-summary: Update a BYOL license to a capacity-based license + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Enable SnapLock on a system + url: "/cvo/put-gcp-ha-working-environments-enable-worm.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/enable-worm + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/enable-worm" + data-summary: Enable SnapLock on a system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Set up an NTP server + url: "/cvo/post-gcp-ha-working-environments-ntp.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/ntp + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/ntp" + data-summary: Set up an NTP server + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Start a Cloud Volumes ONTAP instance + url: "/cvo/post-gcp-ha-working-environments-start.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/start + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/start" + data-summary: Start a Cloud Volumes ONTAP instance + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the support registration status + url: "/cvo/get-gcp-ha-working-environments-support-registration.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/support-registration + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/support-registration" + data-summary: Retrieve the support registration status + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Register a Cloud Volumes ONTAP system with NetApp + url: "/cvo/post-gcp-ha-working-environments-support-registration.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/support-registration + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/support-registration" + data-summary: Register a Cloud Volumes ONTAP system with NetApp + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: List the start/stop schedules for Cloud Volumes ONTAP + url: "/cvo/get-gcp-ha-working-environments-schedules.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/schedules + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/schedules" + data-summary: List the start/stop schedules for Cloud Volumes ONTAP + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Set the schedules for Cloud Volumes ONTAP + url: "/cvo/put-gcp-ha-working-environments-schedules.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/schedules + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/schedules" + data-summary: Set the schedules for Cloud Volumes ONTAP + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Activate FPolicy for ransomware files + url: "/cvo/put-gcp-ha-working-environments-activate-fpolicy.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/activate-fpolicy + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/activate-fpolicy" + data-summary: Activate FPolicy for ransomware files + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Disable FPolicy for ransomware files + url: "/cvo/put-gcp-ha-working-environments-disable-fpolicy.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/disable-fpolicy + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/disable-fpolicy" + data-summary: Disable FPolicy for ransomware files + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete FPolicy for ransomware files + url: "/cvo/delete-gcp-ha-working-environments-fpolicy.html" + swagger-title: DELETE /gcp/ha/working-environments/{workingEnvironmentId}/fpolicy + data-api-method: DELETE + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/fpolicy" + data-summary: Delete FPolicy for ransomware files + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the NetApp Console password + url: "/cvo/put-gcp-ha-working-environments-update-credentials.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/update-credentials + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/update-credentials" + data-summary: Update the NetApp Console password + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the tier level + url: "/cvo/post-gcp-ha-working-environments-change-tier-level.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/change-tier-level + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/change-tier-level" + data-summary: Update the tier level + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Parse an uploaded cloud license file + url: "/cvo/post-gcp-ha-working-environments-parse-license-file.html" + swagger-title: POST /gcp/ha/working-environments/parse-license-file + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/parse-license-file" + data-summary: Parse an uploaded cloud license file + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve editable tags for cloud resources + url: "/cvo/get-gcp-ha-working-environments-user-tags.html" + swagger-title: GET /gcp/ha/working-environments/{workingEnvironmentId}/user-tags + data-api-method: GET + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/user-tags" + data-summary: Retrieve editable tags for cloud resources + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Modify user tags for cloud resources + url: "/cvo/put-gcp-ha-working-environments-user-tags.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/user-tags + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/user-tags" + data-summary: Modify user tags for cloud resources + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Activate snapshot policy assignment for unprotected read/write volumes + url: "/cvo/put-gcp-ha-working-environments-activate-snapshot-policy.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy" + data-summary: Activate snapshot policy assignment for unprotected read/write + volumes + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot policy + url: "/cvo/post-gcp-ha-working-environments-snapshot-policy.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/snapshot-policy + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/snapshot-policy" + data-summary: " Create a snapshot policy" + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the serial number of a system + url: "/cvo/post-gcp-ha-working-environments-change-serial.html" + swagger-title: POST /gcp/ha/working-environments/{workingEnvironmentId}/change-serial + data-api-method: POST + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/change-serial" + data-summary: Update the serial number of a system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Set the cluster password for a system + url: "/cvo/put-gcp-ha-working-environments-set-password.html" + swagger-title: PUT /gcp/ha/working-environments/{workingEnvironmentId}/set-password + data-api-method: PUT + data-api-path: "/gcp/ha/working-environments/{workingEnvironmentId}/set-password" + data-summary: Set the cluster password for a system + data-deprecated: false + data-category: Google Cloud systems (HA) + data-tag-description: '' + data-introduced: '' + - title: Google Cloud systems (single-node) + entries: + - title: Retrieve Cloud Volumes ONTAP systems + url: "/cvo/get-gcp-vsa-working-environments.html" + swagger-title: GET /gcp/vsa/working-environments + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments" + data-summary: Retrieve Cloud Volumes ONTAP systems + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new Cloud Volumes ONTAP system + url: "/cvo/post-gcp-vsa-working-environments.html" + swagger-title: POST /gcp/vsa/working-environments + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments" + data-summary: Create a new Cloud Volumes ONTAP system + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify the SVM name + url: "/cvo/put-gcp-vsa-working-environments-svm.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/svm + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/svm" + data-summary: Modify the SVM name + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new SVM + url: "/cvo/post-gcp-vsa-working-environments-svm.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/svm + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/svm" + data-summary: Create a new SVM + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a Cloud Volumes ONTAP system + url: "/cvo/get-gcp-vsa-working-environments-.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}" + data-summary: Retrieve a Cloud Volumes ONTAP system + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete an existing Cloud Volumes ONTAP system + url: "/cvo/delete-gcp-vsa-working-environments-.html" + swagger-title: DELETE /gcp/vsa/working-environments/{workingEnvironmentId} + data-api-method: DELETE + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}" + data-summary: Delete an existing Cloud Volumes ONTAP system + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete an SVM + url: "/cvo/delete-gcp-vsa-working-environments-svm-.html" + swagger-title: DELETE /gcp/vsa/working-environments/{workingEnvironmentId}/svm/{svmName} + data-api-method: DELETE + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/svm/{svmName}" + data-summary: Delete an SVM + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a CIFS configuration + url: "/cvo/get-gcp-vsa-working-environments-cifs.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId}/cifs + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/cifs" + data-summary: Retrieve a CIFS configuration + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set up a new CIFS configuration + url: "/cvo/post-gcp-vsa-working-environments-cifs.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/cifs + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/cifs" + data-summary: Set up a new CIFS configuration + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete a CIFS configuration + url: "/cvo/post-gcp-vsa-working-environments-delete-cifs.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/delete-cifs + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/delete-cifs" + data-summary: Delete a CIFS configuration + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Validate prerequisites for converting a system + url: "/cvo/get-gcp-vsa-working-environments-validate-byol-to-capacity.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/validate-byol-to-capacity" + data-summary: Validate prerequisites for converting a system + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set the writing speed + url: "/cvo/put-gcp-vsa-working-environments-writing-speed.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/writing-speed + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/writing-speed" + data-summary: Set the writing speed + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all license types and their associated instance types + url: "/cvo/get-gcp-vsa-working-environments-license-instance-type.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId}/license-instance-type + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/license-instance-type" + data-summary: Retrieve all license types and their associated instance types + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set the instance type + url: "/cvo/put-gcp-vsa-working-environments-license-instance-type.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/license-instance-type + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/license-instance-type" + data-summary: Set the instance type + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve images already installed + url: "/cvo/get-gcp-vsa-working-environments-ontap-available-images.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId}/ontap-available-images + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/ontap-available-images" + data-summary: Retrieve images already installed + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Perform a complete image update operation + url: "/cvo/post-gcp-vsa-working-environments-update-image.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/update-image + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/update-image" + data-summary: Perform a complete image update operation + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the eligibility support status + url: "/cvo/get-gcp-vsa-working-environments-update-eligibility.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId}/update-eligibility + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/update-eligibility" + data-summary: Retrieve the eligibility support status + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of upgrade versions + url: "/cvo/get-gcp-vsa-working-environments-occm-provided-upgrade-versions.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions" + data-summary: Retrieve a list of upgrade versions + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Upload a cloud license file + url: "/cvo/post-gcp-vsa-working-environments-upload-license-file.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/upload-license-file + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/upload-license-file" + data-summary: Upload a cloud license file + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Upload cloud license file content + url: "/cvo/post-gcp-vsa-working-environments-upload-licenses.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/upload-licenses + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/upload-licenses" + data-summary: Upload cloud license file content + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Activate an offbox configuration + url: "/cvo/put-gcp-vsa-working-environments-offbox.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/offbox + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/offbox" + data-summary: Activate an offbox configuration + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify the network port broadcast domain MTU + url: "/cvo/put-gcp-vsa-working-environments-networkoptimization.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/networkOptimization + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/networkOptimization" + data-summary: Modify the network port broadcast domain MTU + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the action parameters + url: "/cvo/get-gcp-vsa-working-environments-create-request-parameters.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId}/create-request-parameters + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/create-request-parameters" + data-summary: Retrieve the action parameters + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Enable capacity tiering + url: "/cvo/post-gcp-vsa-working-environments-enable-capacity-tiering.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering" + data-summary: Enable capacity tiering + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve system cost and usage + url: "/cvo/get-gcp-vsa-working-environments-cost-and-usage.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId}/cost-and-usage + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/cost-and-usage" + data-summary: Retrieve system cost and usage + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve system ONTAP savings + url: "/cvo/get-gcp-vsa-working-environments-ontap-saving.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId}/ontap-saving + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/ontap-saving" + data-summary: Retrieve system ONTAP savings + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve extra capacity licenses + url: "/cvo/get-gcp-vsa-working-environments-extra-capacity-licenses.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Retrieve extra capacity licenses + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update extra capacity licenses + url: "/cvo/put-gcp-vsa-working-environments-extra-capacity-licenses.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Update extra capacity licenses + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Register extra capacity licenses + url: "/cvo/post-gcp-vsa-working-environments-extra-capacity-licenses.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-licenses" + data-summary: Register extra capacity licenses + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update extra capacity serial numbers + url: "/cvo/put-gcp-vsa-working-environments-extra-capacity-serials.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Update extra capacity serial numbers + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Register extra capacity serial numbers + url: "/cvo/post-gcp-vsa-working-environments-extra-capacity-serials.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Register extra capacity serial numbers + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete extra capacity licenses by serial numbers + url: "/cvo/delete-gcp-vsa-working-environments-extra-capacity-serials.html" + swagger-title: DELETE /gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials + data-api-method: DELETE + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/extra-capacity-serials" + data-summary: Delete extra capacity licenses by serial numbers + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Trigger subscription synchronization + url: "/cvo/post-gcp-vsa-working-environments-sync-subscription.html" + swagger-title: POST /gcp/vsa/working-environments/sync-subscription + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/sync-subscription" + data-summary: Trigger subscription synchronization + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the default Vscan file operation profile + url: "/cvo/put-gcp-vsa-working-environments-vscan-file-op.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/vscan-file-op + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/vscan-file-op" + data-summary: Update the default Vscan file operation profile + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update a BYOL licence to a capacity-based license + url: "/cvo/put-gcp-vsa-working-environments-byol-to-capacity.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/byol-to-capacity" + data-summary: Update a BYOL licence to a capacity-based license + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Enable SnapLock for a system + url: "/cvo/put-gcp-vsa-working-environments-enable-worm.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/enable-worm + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/enable-worm" + data-summary: Enable SnapLock for a system + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set up an NTP server + url: "/cvo/post-gcp-vsa-working-environments-ntp.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/ntp + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/ntp" + data-summary: Set up an NTP server + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Start a Cloud Volumes ONTAP instance + url: "/cvo/post-gcp-vsa-working-environments-start.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/start + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/start" + data-summary: Start a Cloud Volumes ONTAP instance + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Stop a Cloud Volumes ONTAP instance + url: "/cvo/post-gcp-vsa-working-environments-stop.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/stop + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/stop" + data-summary: Stop a Cloud Volumes ONTAP instance + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve the registration support status + url: "/cvo/get-gcp-vsa-working-environments-support-registration.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId}/support-registration + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/support-registration" + data-summary: Retrieve the registration support status + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Register a Cloud Volumes ONTAP system + url: "/cvo/post-gcp-vsa-working-environments-support-registration.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/support-registration + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/support-registration" + data-summary: Register a Cloud Volumes ONTAP system + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: List the start/stop schedules + url: "/cvo/get-gcp-vsa-working-environments-schedules.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId}/schedules + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/schedules" + data-summary: List the start/stop schedules + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set the schedules for Cloud Volumes ONTAP + url: "/cvo/put-gcp-vsa-working-environments-schedules.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/schedules + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/schedules" + data-summary: Set the schedules for Cloud Volumes ONTAP + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Activate the FPolicy for ransomware files + url: "/cvo/put-gcp-vsa-working-environments-activate-fpolicy.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy" + data-summary: Activate the FPolicy for ransomware files + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Disable the FPolicy for ransomware files + url: "/cvo/put-gcp-vsa-working-environments-disable-fpolicy.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy" + data-summary: Disable the FPolicy for ransomware files + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete the FPolicy for ransomware files + url: "/cvo/delete-gcp-vsa-working-environments-fpolicy.html" + swagger-title: DELETE /gcp/vsa/working-environments/{workingEnvironmentId}/fpolicy + data-api-method: DELETE + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/fpolicy" + data-summary: Delete the FPolicy for ransomware files + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the NetApp Console password + url: "/cvo/put-gcp-vsa-working-environments-update-credentials.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/update-credentials + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/update-credentials" + data-summary: Update the NetApp Console password + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the tier level + url: "/cvo/post-gcp-vsa-working-environments-change-tier-level.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/change-tier-level + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/change-tier-level" + data-summary: Update the tier level + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Parse an uploaded cloud license file + url: "/cvo/post-gcp-vsa-working-environments-parse-license-file.html" + swagger-title: POST /gcp/vsa/working-environments/parse-license-file + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/parse-license-file" + data-summary: Parse an uploaded cloud license file + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve editable tags + url: "/cvo/get-gcp-vsa-working-environments-user-tags.html" + swagger-title: GET /gcp/vsa/working-environments/{workingEnvironmentId}/user-tags + data-api-method: GET + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/user-tags" + data-summary: Retrieve editable tags + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify user tags for cloud resources + url: "/cvo/put-gcp-vsa-working-environments-user-tags.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/user-tags + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/user-tags" + data-summary: Modify user tags for cloud resources + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Activate snapshot policy assignment + url: "/cvo/put-gcp-vsa-working-environments-activate-snapshot-policy.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy" + data-summary: Activate snapshot policy assignment + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot policy + url: "/cvo/post-gcp-vsa-working-environments-snapshot-policy.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/snapshot-policy + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/snapshot-policy" + data-summary: Create a snapshot policy + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the serial number of Cloud Volumes ONTAP + url: "/cvo/post-gcp-vsa-working-environments-change-serial.html" + swagger-title: POST /gcp/vsa/working-environments/{workingEnvironmentId}/change-serial + data-api-method: POST + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/change-serial" + data-summary: Update the serial number of Cloud Volumes ONTAP + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Set the cluster password + url: "/cvo/put-gcp-vsa-working-environments-set-password.html" + swagger-title: PUT /gcp/vsa/working-environments/{workingEnvironmentId}/set-password + data-api-method: PUT + data-api-path: "/gcp/vsa/working-environments/{workingEnvironmentId}/set-password" + data-summary: Set the cluster password + data-deprecated: false + data-category: Google Cloud systems (single-node) + data-tag-description: '' + data-introduced: '' + - title: Google Cloud volumes (HA) + entries: + - title: Retrieve volumes for backup activation + url: "/cvo/get-gcp-ha-volumes-volumes-for-backup.html" + swagger-title: GET /gcp/ha/volumes/volumes-for-backup + data-api-method: GET + data-api-path: "/gcp/ha/volumes/volumes-for-backup" + data-summary: Retrieve volumes for backup activation + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve quotes for a new volume + url: "/cvo/post-gcp-ha-volumes-quote.html" + swagger-title: POST /gcp/ha/volumes/quote + data-api-method: POST + data-api-path: "/gcp/ha/volumes/quote" + data-summary: Retrieve quotes for a new volume + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Update the underlying volume tier + url: "/cvo/post-gcp-ha-volumes--change-tier.html" + swagger-title: POST /gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier + data-api-method: POST + data-api-path: "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier" + data-summary: Update the underlying volume tier + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Modify a volume + url: "/cvo/put-gcp-ha-volumes--.html" + swagger-title: PUT /gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: PUT + data-api-path: "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Modify a volume + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete a volume + url: "/cvo/delete-gcp-ha-volumes--.html" + swagger-title: DELETE /gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: DELETE + data-api-path: "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Delete a volume + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Add an export policy rule + url: "/cvo/put-gcp-ha-volumes--exportpolicy.html" + swagger-title: PUT /gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy + data-api-method: PUT + data-api-path: "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy" + data-summary: Add an export policy rule + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all igroups + url: "/cvo/get-gcp-ha-volumes-igroups-.html" + swagger-title: GET /gcp/ha/volumes/igroups/{workingEnvironmentId}/{svmName} + data-api-method: GET + data-api-path: "/gcp/ha/volumes/igroups/{workingEnvironmentId}/{svmName}" + data-summary: Retrieve all igroups + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all iSCSI initiators + url: "/cvo/get-gcp-ha-volumes-initiator.html" + swagger-title: GET /gcp/ha/volumes/initiator + data-api-method: GET + data-api-path: "/gcp/ha/volumes/initiator" + data-summary: Retrieve all iSCSI initiators + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Add an iSCSI initiator + url: "/cvo/post-gcp-ha-volumes-initiator.html" + swagger-title: POST /gcp/ha/volumes/initiator + data-api-method: POST + data-api-path: "/gcp/ha/volumes/initiator" + data-summary: Add an iSCSI initiator + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of snapshot descriptions + url: "/cvo/get-gcp-ha-volumes--snapshots.html" + swagger-title: GET /gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots + data-api-method: GET + data-api-path: "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots" + data-summary: Retrieve a list of snapshot descriptions + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Clone an existing volume + url: "/cvo/post-gcp-ha-volumes--clone.html" + swagger-title: POST /gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone + data-api-method: POST + data-api-path: "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone" + data-summary: Clone an existing volume + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot + url: "/cvo/post-gcp-ha-volumes--snapshot.html" + swagger-title: POST /gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: POST + data-api-path: "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Create a snapshot + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Delete a snapshot + url: "/cvo/delete-gcp-ha-volumes--snapshot.html" + swagger-title: DELETE /gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: DELETE + data-api-path: "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Delete a snapshot + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Retrieve volumes + url: "/cvo/get-gcp-ha-volumes.html" + swagger-title: GET /gcp/ha/volumes + data-api-method: GET + data-api-path: "/gcp/ha/volumes" + data-summary: Retrieve volumes + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Create a new volume + url: "/cvo/post-gcp-ha-volumes.html" + swagger-title: POST /gcp/ha/volumes + data-api-method: POST + data-api-path: "/gcp/ha/volumes" + data-summary: Create a new volume + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Move an existing volume + url: "/cvo/post-gcp-ha-volumes--move.html" + swagger-title: POST /gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move + data-api-method: POST + data-api-path: "/gcp/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move" + data-summary: Move an existing volume + data-deprecated: false + data-category: Google Cloud volumes (HA) + data-tag-description: '' + data-introduced: '' + - title: Google Cloud volumes (single-node) + entries: + - title: Retrieve volumes for backup activation + url: "/cvo/get-gcp-vsa-volumes-volumes-for-backup.html" + swagger-title: GET /gcp/vsa/volumes/volumes-for-backup + data-api-method: GET + data-api-path: "/gcp/vsa/volumes/volumes-for-backup" + data-summary: Retrieve volumes for backup activation + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve quotes for a new volume + url: "/cvo/post-gcp-vsa-volumes-quote.html" + swagger-title: POST /gcp/vsa/volumes/quote + data-api-method: POST + data-api-path: "/gcp/vsa/volumes/quote" + data-summary: Retrieve quotes for a new volume + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Update the underlying volume tier + url: "/cvo/post-gcp-vsa-volumes--change-tier.html" + swagger-title: POST /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier + data-api-method: POST + data-api-path: "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier" + data-summary: Update the underlying volume tier + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Modify a volume + url: "/cvo/put-gcp-vsa-volumes--.html" + swagger-title: PUT /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: PUT + data-api-path: "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Modify a volume + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete a volume + url: "/cvo/delete-gcp-vsa-volumes--.html" + swagger-title: DELETE /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: DELETE + data-api-path: "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Delete a volume + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Add an export policy rule + url: "/cvo/put-gcp-vsa-volumes--exportpolicy.html" + swagger-title: PUT /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy + data-api-method: PUT + data-api-path: "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/exportPolicy" + data-summary: Add an export policy rule + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all igroups + url: "/cvo/get-gcp-vsa-volumes-igroups-.html" + swagger-title: GET /gcp/vsa/volumes/igroups/{workingEnvironmentId}/{svmName} + data-api-method: GET + data-api-path: "/gcp/vsa/volumes/igroups/{workingEnvironmentId}/{svmName}" + data-summary: Retrieve all igroups + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve all iSCSI initiators + url: "/cvo/get-gcp-vsa-volumes-initiator.html" + swagger-title: GET /gcp/vsa/volumes/initiator + data-api-method: GET + data-api-path: "/gcp/vsa/volumes/initiator" + data-summary: Retrieve all iSCSI initiators + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Add an iSCSI initiator + url: "/cvo/post-gcp-vsa-volumes-initiator.html" + swagger-title: POST /gcp/vsa/volumes/initiator + data-api-method: POST + data-api-path: "/gcp/vsa/volumes/initiator" + data-summary: Add an iSCSI initiator + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of snapshot descriptions for a volume + url: "/cvo/get-gcp-vsa-volumes--snapshots.html" + swagger-title: GET /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots + data-api-method: GET + data-api-path: "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots" + data-summary: Retrieve a list of snapshot descriptions for a volume + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Clone a volume + url: "/cvo/post-gcp-vsa-volumes--clone.html" + swagger-title: POST /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone + data-api-method: POST + data-api-path: "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone" + data-summary: Clone a volume + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot + url: "/cvo/post-gcp-vsa-volumes--snapshot.html" + swagger-title: POST /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: POST + data-api-path: "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Create a snapshot + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Delete a snapshot + url: "/cvo/delete-gcp-vsa-volumes--snapshot.html" + swagger-title: DELETE /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: DELETE + data-api-path: "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Delete a snapshot + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Retrieve volumes + url: "/cvo/get-gcp-vsa-volumes.html" + swagger-title: GET /gcp/vsa/volumes + data-api-method: GET + data-api-path: "/gcp/vsa/volumes" + data-summary: Retrieve volumes + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Create a new volume + url: "/cvo/post-gcp-vsa-volumes.html" + swagger-title: POST /gcp/vsa/volumes + data-api-method: POST + data-api-path: "/gcp/vsa/volumes" + data-summary: Create a new volume + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Move a volume + url: "/cvo/post-gcp-vsa-volumes--move.html" + swagger-title: POST /gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move + data-api-method: POST + data-api-path: "/gcp/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move" + data-summary: Move a volume + data-deprecated: false + data-category: Google Cloud volumes (single-node) + data-tag-description: '' + data-introduced: '' + - title: Monitoring operations + entries: + - title: Deploy a monitoring instance by systems + url: "/cvo/post-monitoring-deploy-by-working-environments.html" + swagger-title: POST /monitoring/deploy-by-working-environments + data-api-method: POST + data-api-path: "/monitoring/deploy-by-working-environments" + data-summary: Deploy a monitoring instance by systems + data-deprecated: false + data-category: Monitoring operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve monitoring information + url: "/cvo/get-monitoring-info.html" + swagger-title: GET /monitoring/info + data-api-method: GET + data-api-path: "/monitoring/info" + data-summary: Retrieve monitoring information + data-deprecated: false + data-category: Monitoring operations + data-tag-description: '' + data-introduced: '' + - title: Disable monitoring + url: "/cvo/post-monitoring-disable-monitoring.html" + swagger-title: POST /monitoring/{workingEnvironmentId}/disable-monitoring + data-api-method: POST + data-api-path: "/monitoring/{workingEnvironmentId}/disable-monitoring" + data-summary: Disable monitoring + data-deprecated: false + data-category: Monitoring operations + data-tag-description: '' + data-introduced: '' + - title: Enable monitoring + url: "/cvo/post-monitoring-enable-monitoring.html" + swagger-title: POST /monitoring/{workingEnvironmentId}/enable-monitoring + data-api-method: POST + data-api-path: "/monitoring/{workingEnvironmentId}/enable-monitoring" + data-summary: Enable monitoring + data-deprecated: false + data-category: Monitoring operations + data-tag-description: '' + data-introduced: '' + - title: 'NetApp Console ' + entries: + - title: Check for a new version of the NetApp Console + url: "/cvo/get-occm-system-available-update-versions.html" + swagger-title: GET /occm/system/available-update-versions + data-api-method: GET + data-api-path: "/occm/system/available-update-versions" + data-summary: Check for a new version of the NetApp Console + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: Perform a fetch and process of image update metadata files + url: "/cvo/post-occm-system-cloud-ontap-update-image-metadata.html" + swagger-title: POST /occm/system/cloud-ontap-update-image-metadata + data-api-method: POST + data-api-path: "/occm/system/cloud-ontap-update-image-metadata" + data-summary: Perform a fetch and process of image update metadata files + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: Perform a fetch and cache of Cloud Volumes ONTAP and NetApp Console + files + url: "/cvo/post-occm-system-cloud-ontap-update-metadata.html" + swagger-title: POST /occm/system/cloud-ontap-update-metadata + data-api-method: POST + data-api-path: "/occm/system/cloud-ontap-update-metadata" + data-summary: Perform a fetch and cache of Cloud Volumes ONTAP and NetApp + Console files + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: Retrieve supported regions for the cloud providers + url: "/cvo/get-occm-system-cloud-provider-regions.html" + swagger-title: GET /occm/system/cloud-provider-regions + data-api-method: GET + data-api-path: "/occm/system/cloud-provider-regions" + data-summary: Retrieve supported regions for the cloud providers + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: Activate the Cloud Volumes ONTAP capacity automatic management cycle + url: "/cvo/post-occm-system-manually-activate-auto-vsa-capacity-management-cycle.html" + swagger-title: POST /occm/system/manually-activate-auto-vsa-capacity-management-cycle + data-api-method: POST + data-api-path: "/occm/system/manually-activate-auto-vsa-capacity-management-cycle" + data-summary: Activate the Cloud Volumes ONTAP capacity automatic management + cycle + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: Trigger sending daily notifications + url: "/cvo/post-occm-system-manually-trigger-send-daily-notification.html" + swagger-title: POST /occm/system/manually-trigger-send-daily-notification + data-api-method: POST + data-api-path: "/occm/system/manually-trigger-send-daily-notification" + data-summary: Trigger sending daily notifications + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: Update the NetApp Console + url: "/cvo/post-occm-system-update.html" + swagger-title: POST /occm/system/update + data-api-method: POST + data-api-path: "/occm/system/update" + data-summary: Update the NetApp Console + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: Restart the server + url: "/cvo/post-occm-system-restart-server.html" + swagger-title: POST /occm/system/restart-server + data-api-method: POST + data-api-path: "/occm/system/restart-server" + data-summary: Restart the server + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: Retrieve feature flags + url: "/cvo/get-occm-system-feature-flags.html" + swagger-title: GET /occm/system/feature-flags + data-api-method: GET + data-api-path: "/occm/system/feature-flags" + data-summary: Retrieve feature flags + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: Retrieve the NetApp Console feedback configuration + url: "/cvo/get-occm-system-external-config.html" + swagger-title: GET /occm/system/external-config + data-api-method: GET + data-api-path: "/occm/system/external-config" + data-summary: Retrieve the NetApp Console feedback configuration + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: Retrieve the NetApp Console server information + url: "/cvo/get-occm-system-about.html" + swagger-title: GET /occm/system/about + data-api-method: GET + data-api-path: "/occm/system/about" + data-summary: Retrieve the NetApp Console server information + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: Retrieve the NetApp Console support services information + url: "/cvo/get-occm-system-support-services.html" + swagger-title: GET /occm/system/support-services + data-api-method: GET + data-api-path: "/occm/system/support-services" + data-summary: Retrieve the NetApp Console support services information + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: Update the NetApp Console with the specified patch version + url: "/cvo/post-occm-system-patch.html" + swagger-title: POST /occm/system/patch + data-api-method: POST + data-api-path: "/occm/system/patch" + data-summary: Update the NetApp Console with the specified patch version + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: Retrieve the region, VPC, and subnet + url: "/cvo/get-occm-system-occm-instance-placement.html" + swagger-title: GET /occm/system/occm-instance-placement + data-api-method: GET + data-api-path: "/occm/system/occm-instance-placement" + data-summary: Retrieve the region, VPC, and subnet + data-deprecated: false + data-category: 'NetApp Console ' + data-tag-description: '' + data-introduced: '' + - title: NetApp Console AutoSupport + entries: + - title: Retrieve the signed URL for the NetApp Console support data + url: "/cvo/get-occm-asup-download-signed.html" + swagger-title: GET /occm/asup/download-signed + data-api-method: GET + data-api-path: "/occm/asup/download-signed" + data-summary: Retrieve the signed URL for the NetApp Console support data + data-deprecated: false + data-category: NetApp Console AutoSupport + data-tag-description: '' + data-introduced: '' + - title: Retrieve the AutoSupport configuration + url: "/cvo/get-occm-asup.html" + swagger-title: GET /occm/asup + data-api-method: GET + data-api-path: "/occm/asup" + data-summary: Retrieve the AutoSupport configuration + data-deprecated: false + data-category: NetApp Console AutoSupport + data-tag-description: '' + data-introduced: '' + - title: Update the AutoSupport configuration + url: "/cvo/put-occm-asup.html" + swagger-title: PUT /occm/asup + data-api-method: PUT + data-api-path: "/occm/asup" + data-summary: Update the AutoSupport configuration + data-deprecated: false + data-category: NetApp Console AutoSupport + data-tag-description: '' + data-introduced: '' + - title: Download a compressed file of all the AutoSupport files from all + VSAs + url: "/cvo/get-occm-asup-download-ontap-cloud-asups.html" + swagger-title: GET /occm/asup/download-ontap-cloud-asups + data-api-method: GET + data-api-path: "/occm/asup/download-ontap-cloud-asups" + data-summary: Download a compressed file of all the AutoSupport files from + all VSAs + data-deprecated: false + data-category: NetApp Console AutoSupport + data-tag-description: '' + data-introduced: '' + - title: Send performance archive support data to NetApp support + url: "/cvo/post-occm-asup-send-cot-performance-asup-.html" + swagger-title: POST /occm/asup/send-Cot-performance-Asup/{workingEnvironmentId} + data-api-method: POST + data-api-path: "/occm/asup/send-Cot-performance-Asup/{workingEnvironmentId}" + data-summary: Send performance archive support data to NetApp support + data-deprecated: false + data-category: NetApp Console AutoSupport + data-tag-description: '' + data-introduced: '' + - title: Download NetApp Console support data + url: "/cvo/get-occm-asup-download.html" + swagger-title: GET /occm/asup/download + data-api-method: GET + data-api-path: "/occm/asup/download" + data-summary: Download NetApp Console support data + data-deprecated: false + data-category: NetApp Console AutoSupport + data-tag-description: '' + data-introduced: '' + - title: Send NetApp Console support data to NetApp support + url: "/cvo/post-occm-asup-send.html" + swagger-title: POST /occm/asup/send + data-api-method: POST + data-api-path: "/occm/asup/send" + data-summary: Send NetApp Console support data to NetApp support + data-deprecated: false + data-category: NetApp Console AutoSupport + data-tag-description: '' + data-introduced: '' + - title: Send Cloud Volumes ONTAP support data to NetApp support + url: "/cvo/post-occm-asup-send-cot-asup.html" + swagger-title: POST /occm/asup/send-Cot-Asup + data-api-method: POST + data-api-path: "/occm/asup/send-Cot-Asup" + data-summary: Send Cloud Volumes ONTAP support data to NetApp support + data-deprecated: false + data-category: NetApp Console AutoSupport + data-tag-description: '' + data-introduced: '' + - title: 'NetApp Console CA certificates ' + entries: + - title: Retrieve all key manager CA certificates + url: "/cvo/get-occm-encryption-key-managers-ca-certificates.html" + swagger-title: GET /occm/encryption/key-managers-ca-certificates + data-api-method: GET + data-api-path: "/occm/encryption/key-managers-ca-certificates" + data-summary: Retrieve all key manager CA certificates + data-deprecated: false + data-category: 'NetApp Console CA certificates ' + data-tag-description: '' + data-introduced: '' + - title: Add a new key manager CA certificate + url: "/cvo/post-occm-encryption-key-managers-ca-certificates.html" + swagger-title: POST /occm/encryption/key-managers-ca-certificates + data-api-method: POST + data-api-path: "/occm/encryption/key-managers-ca-certificates" + data-summary: Add a new key manager CA certificate + data-deprecated: false + data-category: 'NetApp Console CA certificates ' + data-tag-description: '' + data-introduced: '' + - title: Retrieve a key manager CA certificate + url: "/cvo/get-occm-encryption-key-managers-ca-certificates-.html" + swagger-title: GET /occm/encryption/key-managers-ca-certificates/{keyManagerCaCertificateId} + data-api-method: GET + data-api-path: "/occm/encryption/key-managers-ca-certificates/{keyManagerCaCertificateId}" + data-summary: Retrieve a key manager CA certificate + data-deprecated: false + data-category: 'NetApp Console CA certificates ' + data-tag-description: '' + data-introduced: '' + - title: Delete a key manager CA certificate + url: "/cvo/delete-occm-encryption-key-managers-ca-certificates-.html" + swagger-title: DELETE /occm/encryption/key-managers-ca-certificates/{keyManagerCaCertificateId} + data-api-method: DELETE + data-api-path: "/occm/encryption/key-managers-ca-certificates/{keyManagerCaCertificateId}" + data-summary: Delete a key manager CA certificate + data-deprecated: false + data-category: 'NetApp Console CA certificates ' + data-tag-description: '' + data-introduced: '' + - title: NetApp Console SaaS marketplace + entries: + - title: Attach a SaaS subscription + url: "/cvo/put-occm-saas-mp-service-attach-subscription-.html" + swagger-title: PUT /occm/saas-mp-service/attach-subscription/{provider}/{cloudAccountId} + data-api-method: PUT + data-api-path: "/occm/saas-mp-service/attach-subscription/{provider}/{cloudAccountId}" + data-summary: Attach a SaaS subscription + data-deprecated: false + data-category: NetApp Console SaaS marketplace + data-tag-description: '' + data-introduced: '' + - title: Retrieve SaaS marketplace subscriptions + url: "/cvo/get-occm-saas-mp-service-subscription.html" + swagger-title: GET /occm/saas-mp-service/{workingEnvironmentId}/subscription + data-api-method: GET + data-api-path: "/occm/saas-mp-service/{workingEnvironmentId}/subscription" + data-summary: Retrieve SaaS marketplace subscriptions + data-deprecated: false + data-category: NetApp Console SaaS marketplace + data-tag-description: '' + data-introduced: '' + - title: Retrieve current SaaS marketplace accounts and subscriptions + url: "/cvo/get-occm-saas-mp-service-account.html" + swagger-title: GET /occm/saas-mp-service/account + data-api-method: GET + data-api-path: "/occm/saas-mp-service/account" + data-summary: Retrieve current SaaS marketplace accounts and subscriptions + data-deprecated: false + data-category: NetApp Console SaaS marketplace + data-tag-description: '' + data-introduced: '' + - title: NetApp Console certificate signing requests + entries: + - title: Retrieve a generated certificate signing request + url: "/cvo/get-occm-encryption-csr.html" + swagger-title: GET /occm/encryption/csr + data-api-method: GET + data-api-path: "/occm/encryption/csr" + data-summary: Retrieve a generated certificate signing request + data-deprecated: false + data-category: NetApp Console certificate signing requests + data-tag-description: '' + data-introduced: '' + - title: Generate, store, and return a certificate signing request + url: "/cvo/post-occm-encryption-csr.html" + swagger-title: POST /occm/encryption/csr + data-api-method: POST + data-api-path: "/occm/encryption/csr" + data-summary: Generate, store, and return a certificate signing request + data-deprecated: false + data-category: NetApp Console certificate signing requests + data-tag-description: '' + data-introduced: '' + - title: NetApp Console certificates + entries: + - title: Retrieve the installed certificate + url: "/cvo/get-occm-encryption-certificate.html" + swagger-title: GET /occm/encryption/certificate + data-api-method: GET + data-api-path: "/occm/encryption/certificate" + data-summary: Retrieve the installed certificate + data-deprecated: false + data-category: NetApp Console certificates + data-tag-description: '' + data-introduced: '' + - title: Validate and install a certificate + url: "/cvo/post-occm-encryption-certificate.html" + swagger-title: POST /occm/encryption/certificate + data-api-method: POST + data-api-path: "/occm/encryption/certificate" + data-summary: Validate and install a certificate + data-deprecated: false + data-category: NetApp Console certificates + data-tag-description: '' + data-introduced: '' + - title: NetApp Console configuration + entries: + - title: Retrieve NetApp Console configuration parameters + url: "/cvo/get-occm-config.html" + swagger-title: GET /occm/config + data-api-method: GET + data-api-path: "/occm/config" + data-summary: Retrieve NetApp Console configuration parameters + data-deprecated: false + data-category: NetApp Console configuration + data-tag-description: '' + data-introduced: '' + - title: Configure modifiable NetApp Console parameters + url: "/cvo/put-occm-config.html" + swagger-title: PUT /occm/config + data-api-method: PUT + data-api-path: "/occm/config" + data-summary: Configure modifiable NetApp Console parameters + data-deprecated: false + data-category: NetApp Console configuration + data-tag-description: '' + data-introduced: '' + - title: NetApp Console identity and access management + entries: + - title: Associate a console agent with a workspace + url: "/cvo/post-occm-tenancy-service-workspaces-associate.html" + swagger-title: POST /occm/tenancy-service/workspaces/{workspaceId}/associate + data-api-method: POST + data-api-path: "/occm/tenancy-service/workspaces/{workspaceId}/associate" + data-summary: Associate a console agent with a workspace + data-deprecated: false + data-category: NetApp Console identity and access management + data-tag-description: '' + data-introduced: '' + - title: Retrieve visible workspaces + url: "/cvo/get-occm-tenancy-service-workspaces.html" + swagger-title: GET /occm/tenancy-service/workspaces + data-api-method: GET + data-api-path: "/occm/tenancy-service/workspaces" + data-summary: Retrieve visible workspaces + data-deprecated: false + data-category: NetApp Console identity and access management + data-tag-description: '' + data-introduced: '' + - title: NetApp Console initial setup + entries: + - title: Validate a proxy URL + url: "/cvo/post-occm-setup-validate-proxy.html" + swagger-title: POST /occm/setup/validate/proxy + data-api-method: POST + data-api-path: "/occm/setup/validate/proxy" + data-summary: Validate a proxy URL + data-deprecated: false + data-category: NetApp Console initial setup + data-tag-description: '' + data-introduced: '' + - title: Validate an active internet connection + url: "/cvo/post-occm-setup-validate-connectivity.html" + swagger-title: POST /occm/setup/validate/connectivity + data-api-method: POST + data-api-path: "/occm/setup/validate/connectivity" + data-summary: Validate an active internet connection + data-deprecated: false + data-category: NetApp Console initial setup + data-tag-description: '' + data-introduced: '' + - title: Perform an initial standalone setup with the local identity provider + url: "/cvo/post-occm-setup-portal-init-standalone-local-auth.html" + swagger-title: POST /occm/setup-portal/init-standalone-local-auth + data-api-method: POST + data-api-path: "/occm/setup-portal/init-standalone-local-auth" + data-summary: Perform an initial standalone setup with the local identity + provider + data-deprecated: false + data-category: NetApp Console initial setup + data-tag-description: '' + data-introduced: '' + - title: Register NetApp Console to a dark site + url: "/cvo/post-occm-setup-portal-register-in-local-auth.html" + swagger-title: POST /occm/setup-portal/register-in-local-auth + data-api-method: POST + data-api-path: "/occm/setup-portal/register-in-local-auth" + data-summary: Register NetApp Console to a dark site + data-deprecated: false + data-category: NetApp Console initial setup + data-tag-description: '' + data-introduced: '' + - title: Perform an initial setup with NetApp Console + url: "/cvo/post-occm-setup-portal-init.html" + swagger-title: POST /occm/setup-portal/init + data-api-method: POST + data-api-path: "/occm/setup-portal/init" + data-summary: Perform an initial setup with NetApp Console + data-deprecated: false + data-category: NetApp Console initial setup + data-tag-description: '' + data-introduced: '' + - title: Complete the setup + url: "/cvo/post-occm-setup-portal-complete-connectivity-pending-setup.html" + swagger-title: POST /occm/setup-portal/complete-connectivity-pending-setup + data-api-method: POST + data-api-path: "/occm/setup-portal/complete-connectivity-pending-setup" + data-summary: Complete the setup + data-deprecated: false + data-category: NetApp Console initial setup + data-tag-description: '' + data-introduced: '' + - title: Register NetApp Console + url: "/cvo/post-occm-setup-portal-register.html" + swagger-title: POST /occm/setup-portal/register + data-api-method: POST + data-api-path: "/occm/setup-portal/register" + data-summary: Register NetApp Console + data-deprecated: false + data-category: NetApp Console initial setup + data-tag-description: '' + data-introduced: '' + - title: Set up a proxy URL + url: "/cvo/post-occm-setup-portal-proxy-setup.html" + swagger-title: POST /occm/setup-portal/proxy/setup + data-api-method: POST + data-api-path: "/occm/setup-portal/proxy/setup" + data-summary: Set up a proxy URL + data-deprecated: false + data-category: NetApp Console initial setup + data-tag-description: '' + data-introduced: '' + - title: Confirm the NetApp Console active internet connection + url: "/cvo/post-occm-setup-portal-validate-connectivity.html" + swagger-title: POST /occm/setup-portal/validate/connectivity + data-api-method: POST + data-api-path: "/occm/setup-portal/validate/connectivity" + data-summary: Confirm the NetApp Console active internet connection + data-deprecated: false + data-category: NetApp Console initial setup + data-tag-description: '' + data-introduced: '' + - title: NetApp Console key managers + entries: + - title: Retrieve a key manager using the public ID + url: "/cvo/get-occm-encryption-key-managers-.html" + swagger-title: GET /occm/encryption/key-managers/{keyManagerId} + data-api-method: GET + data-api-path: "/occm/encryption/key-managers/{keyManagerId}" + data-summary: Retrieve a key manager using the public ID + data-deprecated: false + data-category: NetApp Console key managers + data-tag-description: '' + data-introduced: '' + - title: Update an existing key manager + url: "/cvo/put-occm-encryption-key-managers-.html" + swagger-title: PUT /occm/encryption/key-managers/{keyManagerId} + data-api-method: PUT + data-api-path: "/occm/encryption/key-managers/{keyManagerId}" + data-summary: Update an existing key manager + data-deprecated: false + data-category: NetApp Console key managers + data-tag-description: '' + data-introduced: '' + - title: Delete an existing key manager + url: "/cvo/delete-occm-encryption-key-managers-.html" + swagger-title: DELETE /occm/encryption/key-managers/{keyManagerId} + data-api-method: DELETE + data-api-path: "/occm/encryption/key-managers/{keyManagerId}" + data-summary: Delete an existing key manager + data-deprecated: false + data-category: NetApp Console key managers + data-tag-description: '' + data-introduced: '' + - title: Retrieve all key managers + url: "/cvo/get-occm-encryption-key-managers.html" + swagger-title: GET /occm/encryption/key-managers + data-api-method: GET + data-api-path: "/occm/encryption/key-managers" + data-summary: Retrieve all key managers + data-deprecated: false + data-category: NetApp Console key managers + data-tag-description: '' + data-introduced: '' + - title: Add a new key manager + url: "/cvo/post-occm-encryption-key-managers.html" + swagger-title: POST /occm/encryption/key-managers + data-api-method: POST + data-api-path: "/occm/encryption/key-managers" + data-summary: Add a new key manager + data-deprecated: false + data-category: NetApp Console key managers + data-tag-description: '' + data-introduced: '' + - title: NetApp Console key store + entries: + - title: Generate a new key pair and self-signed certificate + url: "/cvo/post-occm-key-store.html" + swagger-title: POST /occm/key-store + data-api-method: POST + data-api-path: "/occm/key-store" + data-summary: Generate a new key pair and self-signed certificate + data-deprecated: false + data-category: NetApp Console key store + data-tag-description: '' + data-introduced: '' + - title: Generate a new key pair and self-signed certificate at the key store + url: "/cvo/post-occm-key-store-external-certificate-file.html" + swagger-title: POST /occm/key-store/external-certificate-file + data-api-method: POST + data-api-path: "/occm/key-store/external-certificate-file" + data-summary: Generate a new key pair and self-signed certificate at the + key store + data-deprecated: false + data-category: NetApp Console key store + data-tag-description: '' + data-introduced: '' + - title: Validate and install the provided root CA chain + url: "/cvo/post-occm-key-store-signed-certificate-file.html" + swagger-title: POST /occm/key-store/signed-certificate-file + data-api-method: POST + data-api-path: "/occm/key-store/signed-certificate-file" + data-summary: Validate and install the provided root CA chain + data-deprecated: false + data-category: NetApp Console key store + data-tag-description: '' + data-introduced: '' + - title: Generate a new key pair and self-signed certificate at the key store + url: "/cvo/post-occm-key-store-external-certificate.html" + swagger-title: POST /occm/key-store/external-certificate + data-api-method: POST + data-api-path: "/occm/key-store/external-certificate" + data-summary: Generate a new key pair and self-signed certificate at the + key store + data-deprecated: false + data-category: NetApp Console key store + data-tag-description: '' + data-introduced: '' + - title: Validate and install the certificate in the trust store + url: "/cvo/post-occm-key-store-trusted-certificate-file.html" + swagger-title: POST /occm/key-store/trusted-certificate-file + data-api-method: POST + data-api-path: "/occm/key-store/trusted-certificate-file" + data-summary: Validate and install the certificate in the trust store + data-deprecated: false + data-category: NetApp Console key store + data-tag-description: '' + data-introduced: '' + - title: Retrieve the CA signed certificate + url: "/cvo/get-occm-key-store-signed-certificate.html" + swagger-title: GET /occm/key-store/signed-certificate + data-api-method: GET + data-api-path: "/occm/key-store/signed-certificate" + data-summary: Retrieve the CA signed certificate + data-deprecated: false + data-category: NetApp Console key store + data-tag-description: '' + data-introduced: '' + - title: Validate and install the provided root CA chain + url: "/cvo/post-occm-key-store-signed-certificate.html" + swagger-title: POST /occm/key-store/signed-certificate + data-api-method: POST + data-api-path: "/occm/key-store/signed-certificate" + data-summary: Validate and install the provided root CA chain + data-deprecated: false + data-category: NetApp Console key store + data-tag-description: '' + data-introduced: '' + - title: Return the existing trusted certificates from the trust store + url: "/cvo/get-occm-key-store-user-trusted-certificates.html" + swagger-title: GET /occm/key-store/user-trusted-certificates + data-api-method: GET + data-api-path: "/occm/key-store/user-trusted-certificates" + data-summary: Return the existing trusted certificates from the trust store + data-deprecated: false + data-category: NetApp Console key store + data-tag-description: '' + data-introduced: '' + - title: Delete an existing trusted certificate from the trust store + url: "/cvo/delete-occm-key-store-trusted-certificate-.html" + swagger-title: DELETE /occm/key-store/trusted-certificate/{certificateId} + data-api-method: DELETE + data-api-path: "/occm/key-store/trusted-certificate/{certificateId}" + data-summary: Delete an existing trusted certificate from the trust store + data-deprecated: false + data-category: NetApp Console key store + data-tag-description: '' + data-introduced: '' + - title: Retrieve the self-signed certificate of the NetApp Console key store + url: "/cvo/get-occm-key-store-self-certificate.html" + swagger-title: GET /occm/key-store/self-certificate + data-api-method: GET + data-api-path: "/occm/key-store/self-certificate" + data-summary: Retrieve the self-signed certificate of the NetApp Console + key store + data-deprecated: false + data-category: NetApp Console key store + data-tag-description: '' + data-introduced: '' + - title: On-premises ONTAP cluster aggregates + entries: + - title: Retrieve aggregates + url: "/cvo/get-onprem-aggregates.html" + swagger-title: GET /onprem/aggregates + data-api-method: GET + data-api-path: "/onprem/aggregates" + data-summary: Retrieve aggregates + data-deprecated: false + data-category: On-premises ONTAP cluster aggregates + data-tag-description: '' + data-introduced: '' + - title: On-premises ONTAP cluster metadata + entries: + - title: Verify the address and credentials of a cluster + url: "/cvo/get-onprem-metadata-cluster-info.html" + swagger-title: GET /onprem/metadata/cluster-info + data-api-method: GET + data-api-path: "/onprem/metadata/cluster-info" + data-summary: Verify the address and credentials of a cluster + data-deprecated: false + data-category: On-premises ONTAP cluster metadata + data-tag-description: '' + data-introduced: '' + - title: On-premises ONTAP cluster systems + entries: + - title: Set up Azure backup to cloud + url: "/cvo/post-onprem-working-environments-azure-cloud-backup-setup.html" + swagger-title: POST /onprem/working-environments/{workingEnvironmentId}/azure-cloud-backup-setup + data-api-method: POST + data-api-path: "/onprem/working-environments/{workingEnvironmentId}/azure-cloud-backup-setup" + data-summary: Set up Azure backup to cloud + data-deprecated: false + data-category: On-premises ONTAP cluster systems + data-tag-description: '' + data-introduced: '' + - title: Set up AWS backup to cloud + url: "/cvo/post-onprem-working-environments-aws-cloud-backup-setup.html" + swagger-title: POST /onprem/working-environments/{workingEnvironmentId}/aws-cloud-backup-setup + data-api-method: POST + data-api-path: "/onprem/working-environments/{workingEnvironmentId}/aws-cloud-backup-setup" + data-summary: Set up AWS backup to cloud + data-deprecated: false + data-category: On-premises ONTAP cluster systems + data-tag-description: '' + data-introduced: '' + - title: Set up Google Cloud backup to cloud + url: "/cvo/post-onprem-working-environments-gcp-cloud-backup-setup.html" + swagger-title: POST /onprem/working-environments/{workingEnvironmentId}/gcp-cloud-backup-setup + data-api-method: POST + data-api-path: "/onprem/working-environments/{workingEnvironmentId}/gcp-cloud-backup-setup" + data-summary: Set up Google Cloud backup to cloud + data-deprecated: false + data-category: On-premises ONTAP cluster systems + data-tag-description: '' + data-introduced: '' + - title: Set up StorageGRID backup to cloud + url: "/cvo/post-onprem-working-environments-sgws-cloud-backup-setup.html" + swagger-title: POST /onprem/working-environments/{workingEnvironmentId}/sgws-cloud-backup-setup + data-api-method: POST + data-api-path: "/onprem/working-environments/{workingEnvironmentId}/sgws-cloud-backup-setup" + data-summary: Set up StorageGRID backup to cloud + data-deprecated: false + data-category: On-premises ONTAP cluster systems + data-tag-description: '' + data-introduced: '' + - title: Retrieve an IPspace list for an existing system + url: "/cvo/get-onprem-working-environments-ip-spaces.html" + swagger-title: GET /onprem/working-environments/{workingEnvironmentId}/ip-spaces + data-api-method: GET + data-api-path: "/onprem/working-environments/{workingEnvironmentId}/ip-spaces" + data-summary: Retrieve an IPspace list for an existing system + data-deprecated: false + data-category: On-premises ONTAP cluster systems + data-tag-description: '' + data-introduced: '' + - title: Retrieve on-premises systems + url: "/cvo/get-onprem-working-environments.html" + swagger-title: GET /onprem/working-environments + data-api-method: GET + data-api-path: "/onprem/working-environments" + data-summary: Retrieve on-premises systems + data-deprecated: false + data-category: On-premises ONTAP cluster systems + data-tag-description: '' + data-introduced: '' + - title: Discover an on-premises system + url: "/cvo/post-onprem-working-environments.html" + swagger-title: POST /onprem/working-environments + data-api-method: POST + data-api-path: "/onprem/working-environments" + data-summary: Discover an on-premises system + data-deprecated: false + data-category: On-premises ONTAP cluster systems + data-tag-description: '' + data-introduced: '' + - title: Retrieve an on-premises ONTAP system + url: "/cvo/get-onprem-working-environments-.html" + swagger-title: GET /onprem/working-environments/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/onprem/working-environments/{workingEnvironmentId}" + data-summary: Retrieve an on-premises ONTAP system + data-deprecated: false + data-category: On-premises ONTAP cluster systems + data-tag-description: '' + data-introduced: '' + - title: Delete an on-premises ONTAP system + url: "/cvo/delete-onprem-working-environments-.html" + swagger-title: DELETE /onprem/working-environments/{workingEnvironmentId} + data-api-method: DELETE + data-api-path: "/onprem/working-environments/{workingEnvironmentId}" + data-summary: Delete an on-premises ONTAP system + data-deprecated: false + data-category: On-premises ONTAP cluster systems + data-tag-description: '' + data-introduced: '' + - title: Modify the NetApp Console password + url: "/cvo/put-onprem-working-environments-update-credentials.html" + swagger-title: PUT /onprem/working-environments/{workingEnvironmentId}/update-credentials + data-api-method: PUT + data-api-path: "/onprem/working-environments/{workingEnvironmentId}/update-credentials" + data-summary: Modify the NetApp Console password + data-deprecated: false + data-category: On-premises ONTAP cluster systems + data-tag-description: '' + data-introduced: '' + - title: Retrieve a CIFS configuration for a system + url: "/cvo/get-onprem-working-environments-cifs.html" + swagger-title: GET /onprem/working-environments/{workingEnvironmentId}/cifs + data-api-method: GET + data-api-path: "/onprem/working-environments/{workingEnvironmentId}/cifs" + data-summary: Retrieve a CIFS configuration for a system + data-deprecated: false + data-category: On-premises ONTAP cluster systems + data-tag-description: '' + data-introduced: '' + - title: On-premises ONTAP cluster volumes + entries: + - title: Retrieve volumes for backup activation + url: "/cvo/get-onprem-volumes-volumes-for-backup.html" + swagger-title: GET /onprem/volumes/volumes-for-backup + data-api-method: GET + data-api-path: "/onprem/volumes/volumes-for-backup" + data-summary: Retrieve volumes for backup activation + data-deprecated: false + data-category: On-premises ONTAP cluster volumes + data-tag-description: '' + data-introduced: '' + - title: Modify an existing volume + url: "/cvo/put-onprem-volumes--.html" + swagger-title: PUT /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: PUT + data-api-path: "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Modify an existing volume + data-deprecated: false + data-category: On-premises ONTAP cluster volumes + data-tag-description: '' + data-introduced: '' + - title: Delete an existing volume + url: "/cvo/delete-onprem-volumes--.html" + swagger-title: DELETE /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: DELETE + data-api-path: "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Delete an existing volume + data-deprecated: false + data-category: On-premises ONTAP cluster volumes + data-tag-description: '' + data-introduced: '' + - title: Retrieve a list of snapshot descriptions + url: "/cvo/get-onprem-volumes--snapshots.html" + swagger-title: GET /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots + data-api-method: GET + data-api-path: "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots" + data-summary: Retrieve a list of snapshot descriptions + data-deprecated: false + data-category: On-premises ONTAP cluster volumes + data-tag-description: '' + data-introduced: '' + - title: Clone an existing volume + url: "/cvo/post-onprem-volumes--clone.html" + swagger-title: POST /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone + data-api-method: POST + data-api-path: "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone" + data-summary: Clone an existing volume + data-deprecated: false + data-category: On-premises ONTAP cluster volumes + data-tag-description: '' + data-introduced: '' + - title: Create a snapshot + url: "/cvo/post-onprem-volumes--snapshot.html" + swagger-title: POST /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: POST + data-api-path: "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Create a snapshot + data-deprecated: false + data-category: On-premises ONTAP cluster volumes + data-tag-description: '' + data-introduced: '' + - title: Delete a snapshot + url: "/cvo/delete-onprem-volumes--snapshot.html" + swagger-title: DELETE /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot + data-api-method: DELETE + data-api-path: "/onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot" + data-summary: Delete a snapshot + data-deprecated: false + data-category: On-premises ONTAP cluster volumes + data-tag-description: '' + data-introduced: '' + - title: Retrieve volumes + url: "/cvo/get-onprem-volumes.html" + swagger-title: GET /onprem/volumes + data-api-method: GET + data-api-path: "/onprem/volumes" + data-summary: Retrieve volumes + data-deprecated: false + data-category: On-premises ONTAP cluster volumes + data-tag-description: '' + data-introduced: '' + - title: Create a new volume + url: "/cvo/post-onprem-volumes.html" + swagger-title: POST /onprem/volumes + data-api-method: POST + data-api-path: "/onprem/volumes" + data-summary: Create a new volume + data-deprecated: false + data-category: On-premises ONTAP cluster volumes + data-tag-description: '' + data-introduced: '' + - title: Replication + entries: + - title: Remove a replication relationship + url: "/cvo/delete-replication--.html" + swagger-title: DELETE /replication/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName} + data-api-method: DELETE + data-api-path: "/replication/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}" + data-summary: Remove a replication relationship + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Initialize an existing SnapMirror relationship + url: "/cvo/post-replication-initialize--.html" + swagger-title: POST /replication/initialize/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName} + data-api-method: POST + data-api-path: "/replication/initialize/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}" + data-summary: Initialize an existing SnapMirror relationship + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Reverse an existing SnapMirror relationship + url: "/cvo/post-replication-reverse--.html" + swagger-title: POST /replication/reverse/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName} + data-api-method: POST + data-api-path: "/replication/reverse/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}" + data-summary: Reverse an existing SnapMirror relationship + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Create a new replication for an on-premises system + url: "/cvo/post-replication-onprem.html" + swagger-title: POST /replication/onprem + data-api-method: POST + data-api-path: "/replication/onprem" + data-summary: Create a new replication for an on-premises system + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Create a new replication for a Cloud Volumes ONTAP system + url: "/cvo/post-replication-vsa.html" + swagger-title: POST /replication/vsa + data-api-method: POST + data-api-path: "/replication/vsa" + data-summary: Create a new replication for a Cloud Volumes ONTAP system + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Resync a SnapMirror replication relationship + url: "/cvo/post-replication-resync--.html" + swagger-title: POST /replication/resync/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName} + data-api-method: POST + data-api-path: "/replication/resync/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}" + data-summary: Resync a SnapMirror replication relationship + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Update the destination endpoint of the SnapMirror relationship + url: "/cvo/post-replication-update--.html" + swagger-title: POST /replication/update/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName} + data-api-method: POST + data-api-path: "/replication/update/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}" + data-summary: Update the destination endpoint of the SnapMirror relationship + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Modify a SnapMirror replication relationship + url: "/cvo/put-replication--.html" + swagger-title: PUT /replication/{workingEnvironmentId}/{destinationSvmName}/{destinationVolumeName} + data-api-method: PUT + data-api-path: "/replication/{workingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}" + data-summary: Modify a SnapMirror replication relationship + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Break a SnapMirror replication relationship + url: "/cvo/post-replication-break--.html" + swagger-title: POST /replication/break/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName} + data-api-method: POST + data-api-path: "/replication/break/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}" + data-summary: Break a SnapMirror replication relationship + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Return pairs of relationships + url: "/cvo/get-replication-all-relationships.html" + swagger-title: GET /replication/all-relationships + data-api-method: GET + data-api-path: "/replication/all-relationships" + data-summary: Return pairs of relationships + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Retrieve the intercluster LIFs + url: "/cvo/get-replication-intercluster-lifs.html" + swagger-title: GET /replication/intercluster-lifs + data-api-method: GET + data-api-path: "/replication/intercluster-lifs" + data-summary: Retrieve the intercluster LIFs + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Retrieve the replication schedules of a system + url: "/cvo/get-replication-schedules-.html" + swagger-title: GET /replication/schedules/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/replication/schedules/{workingEnvironmentId}" + data-summary: Retrieve the replication schedules of a system + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Retrieve the status of all SnapMirror relationships + url: "/cvo/get-replication-status.html" + swagger-title: GET /replication/status + data-api-method: GET + data-api-path: "/replication/status" + data-summary: Retrieve the status of all SnapMirror relationships + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Retrieve SnapMirror replication relationship status + url: "/cvo/get-replication-status-.html" + swagger-title: GET /replication/status/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/replication/status/{workingEnvironmentId}" + data-summary: Retrieve SnapMirror replication relationship status + data-deprecated: false + data-category: Replication + data-tag-description: '' + data-introduced: '' + - title: Replication metadata + entries: + - title: Retrieve SnapMirror policies + url: "/cvo/get-replication-metadata-snapmirror-svm-policies--.html" + swagger-title: GET /replication/metadata/snapmirror-svm-policies/{sourceWorkingEnvironmentId}/{svmName}/{targetWorkingEnvironmentId} + data-api-method: GET + data-api-path: "/replication/metadata/snapmirror-svm-policies/{sourceWorkingEnvironmentId}/{svmName}/{targetWorkingEnvironmentId}" + data-summary: Retrieve SnapMirror policies + data-deprecated: false + data-category: Replication metadata + data-tag-description: '' + data-introduced: '' + - title: Retrieve SnapMirror policies + url: "/cvo/get-replication-metadata-snapmirror-policies-.html" + swagger-title: GET /replication/metadata/snapmirror-policies/{sourceWorkingEnvironmentId}/{targetWorkingEnvironmentId} + data-api-method: GET + data-api-path: "/replication/metadata/snapmirror-policies/{sourceWorkingEnvironmentId}/{targetWorkingEnvironmentId}" + data-summary: Retrieve SnapMirror policies + data-deprecated: false + data-category: Replication metadata + data-tag-description: '' + data-introduced: '' + - title: Return a list of snapshot labels + url: "/cvo/get-replication-metadata-snapshot-labels--.html" + swagger-title: GET /replication/metadata/snapshot-labels/{workingEnvironmentId}/{svmName}/{volumeName} + data-api-method: GET + data-api-path: "/replication/metadata/snapshot-labels/{workingEnvironmentId}/{svmName}/{volumeName}" + data-summary: Return a list of snapshot labels + data-deprecated: false + data-category: Replication metadata + data-tag-description: '' + data-introduced: '' + - title: Tenant operations + entries: + - title: Retrieve a tenant + url: "/cvo/get-tenants-.html" + swagger-title: GET /tenants/{tenantId} + data-api-method: GET + data-api-path: "/tenants/{tenantId}" + data-summary: Retrieve a tenant + data-deprecated: false + data-category: Tenant operations + data-tag-description: '' + data-introduced: '' + - title: Update an existing tenant + url: "/cvo/put-tenants-.html" + swagger-title: PUT /tenants/{tenantId} + data-api-method: PUT + data-api-path: "/tenants/{tenantId}" + data-summary: Update an existing tenant + data-deprecated: false + data-category: Tenant operations + data-tag-description: '' + data-introduced: '' + - title: Delete an existing tenant + url: "/cvo/delete-tenants-.html" + swagger-title: DELETE /tenants/{tenantId} + data-api-method: DELETE + data-api-path: "/tenants/{tenantId}" + data-summary: Delete an existing tenant + data-deprecated: false + data-category: Tenant operations + data-tag-description: '' + data-introduced: '' + - title: Link a tenant to a NetApp support site account + url: "/cvo/put-tenants-nss-keys.html" + swagger-title: PUT /tenants/{tenantId}/nss-keys + data-api-method: PUT + data-api-path: "/tenants/{tenantId}/nss-keys" + data-summary: Link a tenant to a NetApp support site account + data-deprecated: false + data-category: Tenant operations + data-tag-description: '' + data-introduced: '' + - title: Retrieve tenants + url: "/cvo/get-tenants.html" + swagger-title: GET /tenants + data-api-method: GET + data-api-path: "/tenants" + data-summary: Retrieve tenants + data-deprecated: false + data-category: Tenant operations + data-tag-description: '' + data-introduced: '' + - title: Create a new tenant + url: "/cvo/post-tenants.html" + swagger-title: POST /tenants + data-api-method: POST + data-api-path: "/tenants" + data-summary: Create a new tenant + data-deprecated: false + data-category: Tenant operations + data-tag-description: '' + data-introduced: '' + - title: User management + entries: + - title: Retrieve a user + url: "/cvo/get-users-.html" + swagger-title: GET /users/{userId} + data-api-method: GET + data-api-path: "/users/{userId}" + data-summary: Retrieve a user + data-deprecated: false + data-category: User management + data-tag-description: '' + data-introduced: '' + - title: Update an existing user + url: "/cvo/put-users-.html" + swagger-title: PUT /users/{userId} + data-api-method: PUT + data-api-path: "/users/{userId}" + data-summary: Update an existing user + data-deprecated: false + data-category: User management + data-tag-description: '' + data-introduced: '' + - title: Delete an existing user + url: "/cvo/delete-users-.html" + swagger-title: DELETE /users/{userId} + data-api-method: DELETE + data-api-path: "/users/{userId}" + data-summary: Delete an existing user + data-deprecated: false + data-category: User management + data-tag-description: '' + data-introduced: '' + - title: Grant or revoke permissions to a user + url: "/cvo/post-users-working-environments-grant-revoke.html" + swagger-title: POST /users/{userId}/working-environments-grant-revoke + data-api-method: POST + data-api-path: "/users/{userId}/working-environments-grant-revoke" + data-summary: Grant or revoke permissions to a user + data-deprecated: false + data-category: User management + data-tag-description: '' + data-introduced: '' + - title: Reset the password + url: "/cvo/put-users-reset-password.html" + swagger-title: PUT /users/{userId}/reset-password + data-api-method: PUT + data-api-path: "/users/{userId}/reset-password" + data-summary: Reset the password + data-deprecated: false + data-category: User management + data-tag-description: '' + data-introduced: '' + - title: Add a NetApp Cloud Central user to NetApp Console + url: "/cvo/post-users-add-user.html" + swagger-title: POST /users/add-user + data-api-method: POST + data-api-path: "/users/add-user" + data-summary: Add a NetApp Cloud Central user to NetApp Console + data-deprecated: false + data-category: User management + data-tag-description: '' + data-introduced: '' + - title: Remove a user from NetApp Console + url: "/cvo/delete-users-remove-user.html" + swagger-title: DELETE /users/{userId}/remove-user + data-api-method: DELETE + data-api-path: "/users/{userId}/remove-user" + data-summary: Remove a user from NetApp Console + data-deprecated: false + data-category: User management + data-tag-description: '' + data-introduced: '' + - title: Retrieve all users + url: "/cvo/get-users.html" + swagger-title: GET /users + data-api-method: GET + data-api-path: "/users" + data-summary: Retrieve all users + data-deprecated: false + data-category: User management + data-tag-description: '' + data-introduced: '' + - title: Create a new user + url: "/cvo/post-users.html" + swagger-title: POST /users + data-api-method: POST + data-api-path: "/users" + data-summary: Create a new user + data-deprecated: false + data-category: User management + data-tag-description: '' + data-introduced: '' + - title: 'User management authentication ' + entries: + - title: Retrieve a user representation with roles + url: "/cvo/get-auth-v4-current-user.html" + swagger-title: GET /auth/v4/current-user + data-api-method: GET + data-api-path: "/auth/v4/current-user" + data-summary: Retrieve a NetApp Console user representation with roles + data-deprecated: false + data-category: 'User management authentication ' + data-tag-description: '' + data-introduced: '' + - title: Sign out of the NetApp Console + url: "/cvo/post-auth-logout.html" + swagger-title: POST /auth/logout + data-api-method: POST + data-api-path: "/auth/logout" + data-summary: Sign out of the NetApp Console + data-deprecated: false + data-category: 'User management authentication ' + data-tag-description: '' + data-introduced: '' + - title: Update the user password + url: "/cvo/put-auth-current-user-change-password.html" + swagger-title: PUT /auth/current-user/change-password + data-api-method: PUT + data-api-path: "/auth/current-user/change-password" + data-summary: Update the user password + data-deprecated: false + data-category: 'User management authentication ' + data-tag-description: '' + data-introduced: '' + - title: Retrieve user representation + url: "/cvo/get-auth-current-user.html" + swagger-title: GET /auth/current-user + data-api-method: GET + data-api-path: "/auth/current-user" + data-summary: Retrieve user representation + data-deprecated: false + data-category: 'User management authentication ' + data-tag-description: '' + data-introduced: '' + - title: Sign in to the NetApp Console + url: "/cvo/post-auth-login.html" + swagger-title: POST /auth/login + data-api-method: POST + data-api-path: "/auth/login" + data-summary: Sign in to the NetApp Console + data-deprecated: false + data-category: 'User management authentication ' + data-tag-description: '' + data-introduced: '' + - title: Accounts (tenancy) + entries: + - title: Overview + url: "/tenancy/overview.html" + - title: Account + entries: + - title: Overview + url: "/tenancy/account_overview.html" + - title: Create an account + url: "/tenancy/post-tenancy-account-id.html" + swagger-title: POST /tenancy/account/{accountName} + data-api-method: POST + data-api-path: "/tenancy/account/{accountName}" + data-summary: Create an account + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Delete an account + url: "/tenancy/delete-tenancy-account-id.html" + swagger-title: DELETE /tenancy/account/{accountId} + data-api-method: DELETE + data-api-path: "/tenancy/account/{accountId}" + data-summary: Delete an account + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve an account + url: "/tenancy/get-tenancy-account-id.html" + swagger-title: GET /tenancy/account/{accountId} + data-api-method: GET + data-api-path: "/tenancy/account/{accountId}" + data-summary: Retrieve an account + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Associate a user + url: "/tenancy/post-tenancy-account-associate.html" + swagger-title: POST /tenancy/account/{accountId}/associate + data-api-method: POST + data-api-path: "/tenancy/account/{accountId}/associate" + data-summary: Associate a user + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Dissociate a user + url: "/tenancy/post-tenancy-account-disassociate.html" + swagger-title: POST /tenancy/account/{accountId}/disassociate + data-api-method: POST + data-api-path: "/tenancy/account/{accountId}/disassociate" + data-summary: Dissociate a user + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve user data + url: "/tenancy/get-tenancy-account-users.html" + swagger-title: GET /tenancy/account/{accountId}/users + data-api-method: GET + data-api-path: "/tenancy/account/{accountId}/users" + data-summary: Retrieve user data + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve service account data + url: "/tenancy/get-tenancy-account-service-accounts.html" + swagger-title: GET /tenancy/account/{accountId}/service-accounts + data-api-method: GET + data-api-path: "/tenancy/account/{accountId}/service-accounts" + data-summary: Retrieve service account data + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve user and service account data + url: "/tenancy/get-tenancy-account-members.html" + swagger-title: GET /tenancy/account/{accountId}/members + data-api-method: GET + data-api-path: "/tenancy/account/{accountId}/members" + data-summary: Retrieve user and service account data + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve user role and permissions + url: "/tenancy/get-tenancy-account-permissions-for-user.html" + swagger-title: GET /tenancy/account/{accountId}/permissions-for-user + data-api-method: GET + data-api-path: "/tenancy/account/{accountId}/permissions-for-user" + data-summary: Retrieve user role and permissions + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Delete a user + url: "/tenancy/post-tenancy-account-leave.html" + swagger-title: POST /tenancy/account/{accountId}/leave + data-api-method: POST + data-api-path: "/tenancy/account/{accountId}/leave" + data-summary: Delete a user + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Enable Cloud Manager notifications + url: "/tenancy/patch-tenancy-account-update-user.html" + swagger-title: PATCH /tenancy/account/{accountId}/update-user + data-api-method: PATCH + data-api-path: "/tenancy/account/{accountId}/update-user" + data-summary: Enable Cloud Manager notifications + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve user accounts + url: "/tenancy/get-tenancy-account.html" + swagger-title: GET /tenancy/account + data-api-method: GET + data-api-path: "/tenancy/account" + data-summary: Retrieve user accounts + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Move account data + url: "/tenancy/post-tenancy-account-dest-account-.html" + swagger-title: POST /tenancy/account/{srcAccountId}/dest/account/{dstAccountId} + data-api-method: POST + data-api-path: "/tenancy/account/{srcAccountId}/dest/account/{dstAccountId}" + data-summary: Move account data + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Rename an account + url: "/tenancy/post-tenancy-account-rename-id.html" + swagger-title: POST /tenancy/account/{accountId}/rename/{newAccountName} + data-api-method: POST + data-api-path: "/tenancy/account/{accountId}/rename/{newAccountName}" + data-summary: Rename an account + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Enable private preview for SaaS + url: "/tenancy/post-tenancy-account-enable-private-preview-id.html" + swagger-title: POST /tenancy/account/{accountId}/enable-private-preview/{privatePreviewEnabled} + data-api-method: POST + data-api-path: "/tenancy/account/{accountId}/enable-private-preview/{privatePreviewEnabled}" + data-summary: Enable private preview for SaaS + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Enable third-party services + url: "/tenancy/post-tenancy-account-enable-3rd-party-services-id.html" + swagger-title: POST /tenancy/account/{accountId}/enable-3rd-party-services/{enabled} + data-api-method: POST + data-api-path: "/tenancy/account/{accountId}/enable-3rd-party-services/{enabled}" + data-summary: Enable third-party services + data-deprecated: false + data-category: Account + data-tag-description: | +
    + Overview +
    + The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: +
      +
    • Single person
      • +
    • Group of people
      • +
    • Internal software service
      • +
    +

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    +

    At a high level, an account is a collection of the following:

    +
      +
    • Associated person or group of people or software service
      • +
    • One or more workspaces
      • +
    • One or more BlueXP Connectors
      • +
    +

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    +

    The following actions can be performed with the account endpoints:

    +
      +
    • Create an account
      • +
    • Delete an account
      • +
    • Associate a user (person) to an account
      • +
    • Disassociate a user from an account
      • +
    • List the users of an account
      • +
    • List the services (service accounts) of an account
      • +
    • List the members (users and services) of an account
      • +
    • List the roles and permissions of an account
      • +
    • Leave an account
      • +
    • Allow a user to enable or disable receiving BlueXP notifications
      • +
    • List the accounts a user is associated with
      • +
    • Migrate the configuration data from one account to another account
      • +
    • Rename an account
      • +
    • Set miscellaneous account enablement options
      • +
    +
    +
    + data-introduced: '' + - title: Authorize + entries: + - title: Overview + url: "/tenancy/authorize_overview.html" + - title: Authorize an external resource + url: "/tenancy/post-tenancy-authorize.html" + swagger-title: POST /tenancy/authorize + data-api-method: POST + data-api-path: "/tenancy/authorize" + data-summary: Authorize an external resource + data-deprecated: false + data-category: Authorize + data-tag-description: | +
    + Overview +
    +

    The authorization endpoints provide the ability to set various permissions for workspaces, Connectors, and resources that allow them to take specific actions.

    +

    The following actions can be performed with the authorization endpoints:

    +
      +
    • Authorize a resource to take specific actions
      • +
    • Authorize a Connector
      • +
    • Authorize a workspace and a Connector in the workspace
      • +
    • Authorize a user as an account administrator
      • +
    • Authorize a user in an account
      • +
    • Authorize an agent in an account
      • +
    +
    +
    + data-introduced: '' + - title: Authorize an external agent + url: "/tenancy/post-tenancy-authorize-agent.html" + swagger-title: POST /tenancy/authorize-agent + data-api-method: POST + data-api-path: "/tenancy/authorize-agent" + data-summary: Authorize an external agent + data-deprecated: false + data-category: Authorize + data-tag-description: | +
    + Overview +
    +

    The authorization endpoints provide the ability to set various permissions for workspaces, Connectors, and resources that allow them to take specific actions.

    +

    The following actions can be performed with the authorization endpoints:

    +
      +
    • Authorize a resource to take specific actions
      • +
    • Authorize a Connector
      • +
    • Authorize a workspace and a Connector in the workspace
      • +
    • Authorize a user as an account administrator
      • +
    • Authorize a user in an account
      • +
    • Authorize an agent in an account
      • +
    +
    +
    + data-introduced: '' + - title: Authorize an agent workspace + url: "/tenancy/post-tenancy-authorize-agent-workspace.html" + swagger-title: POST /tenancy/authorize-agent-workspace + data-api-method: POST + data-api-path: "/tenancy/authorize-agent-workspace" + data-summary: Authorize an agent workspace + data-deprecated: false + data-category: Authorize + data-tag-description: | +
    + Overview +
    +

    The authorization endpoints provide the ability to set various permissions for workspaces, Connectors, and resources that allow them to take specific actions.

    +

    The following actions can be performed with the authorization endpoints:

    +
      +
    • Authorize a resource to take specific actions
      • +
    • Authorize a Connector
      • +
    • Authorize a workspace and a Connector in the workspace
      • +
    • Authorize a user as an account administrator
      • +
    • Authorize a user in an account
      • +
    • Authorize an agent in an account
      • +
    +
    +
    + data-introduced: '' + - title: Authorize a user as account admin + url: "/tenancy/post-tenancy-authorize-user-is-account-admin.html" + swagger-title: POST /tenancy/authorize-user-is-account-admin + data-api-method: POST + data-api-path: "/tenancy/authorize-user-is-account-admin" + data-summary: Authorize a user as account admin + data-deprecated: false + data-category: Authorize + data-tag-description: | +
    + Overview +
    +

    The authorization endpoints provide the ability to set various permissions for workspaces, Connectors, and resources that allow them to take specific actions.

    +

    The following actions can be performed with the authorization endpoints:

    +
      +
    • Authorize a resource to take specific actions
      • +
    • Authorize a Connector
      • +
    • Authorize a workspace and a Connector in the workspace
      • +
    • Authorize a user as an account administrator
      • +
    • Authorize a user in an account
      • +
    • Authorize an agent in an account
      • +
    +
    +
    + data-introduced: '' + - title: Authorize a user for an account + url: "/tenancy/post-tenancy-authorize-user-is-in-account.html" + swagger-title: POST /tenancy/authorize-user-is-in-account + data-api-method: POST + data-api-path: "/tenancy/authorize-user-is-in-account" + data-summary: Authorize a user for an account + data-deprecated: false + data-category: Authorize + data-tag-description: | +
    + Overview +
    +

    The authorization endpoints provide the ability to set various permissions for workspaces, Connectors, and resources that allow them to take specific actions.

    +

    The following actions can be performed with the authorization endpoints:

    +
      +
    • Authorize a resource to take specific actions
      • +
    • Authorize a Connector
      • +
    • Authorize a workspace and a Connector in the workspace
      • +
    • Authorize a user as an account administrator
      • +
    • Authorize a user in an account
      • +
    • Authorize an agent in an account
      • +
    +
    +
    + data-introduced: '' + - title: Authorize an agent + url: "/tenancy/post-tenancy-authorize-agent-in-account.html" + swagger-title: POST /tenancy/authorize-agent-in-account + data-api-method: POST + data-api-path: "/tenancy/authorize-agent-in-account" + data-summary: Authorize an agent + data-deprecated: false + data-category: Authorize + data-tag-description: | +
    + Overview +
    +

    The authorization endpoints provide the ability to set various permissions for workspaces, Connectors, and resources that allow them to take specific actions.

    +

    The following actions can be performed with the authorization endpoints:

    +
      +
    • Authorize a resource to take specific actions
      • +
    • Authorize a Connector
      • +
    • Authorize a workspace and a Connector in the workspace
      • +
    • Authorize a user as an account administrator
      • +
    • Authorize a user in an account
      • +
    • Authorize an agent in an account
      • +
    +
    +
    + data-introduced: '' + - title: Resource + entries: + - title: Overview + url: "/tenancy/resource_overview.html" + - title: Discover an external resource + url: "/tenancy/post-tenancy-resource-discover.html" + swagger-title: POST /tenancy/resource/discover + data-api-method: POST + data-api-path: "/tenancy/resource/discover" + data-summary: Discover an external resource + data-deprecated: false + data-category: Resource + data-tag-description: | +
    + Overview +
    +

    A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces.

    +

    Each resource contains the following information:

    +
      +
    • Public identifier (such as resource-PnA04qmQ)
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Resource type (such as S3, AZURE, GCP)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    +

    The following actions can be performed with the resource endpoints:

    +
      +
    • Discover a resource
      • +
    • Create, update, or delete a resource
      • +
    • List the resources available in an account
      • +
    • Delete a service resource from an account
      • +
    • Associate or disassociate a resource from the workspace
      • +
    • Disassociate a resource from a Connector
      • +
    +
    +
    + data-introduced: '' + - title: Create an external resource + url: "/tenancy/post-tenancy-resource.html" + swagger-title: POST /tenancy/resource + data-api-method: POST + data-api-path: "/tenancy/resource" + data-summary: Create an external resource + data-deprecated: false + data-category: Resource + data-tag-description: | +
    + Overview +
    +

    A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces.

    +

    Each resource contains the following information:

    +
      +
    • Public identifier (such as resource-PnA04qmQ)
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Resource type (such as S3, AZURE, GCP)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    +

    The following actions can be performed with the resource endpoints:

    +
      +
    • Discover a resource
      • +
    • Create, update, or delete a resource
      • +
    • List the resources available in an account
      • +
    • Delete a service resource from an account
      • +
    • Associate or disassociate a resource from the workspace
      • +
    • Disassociate a resource from a Connector
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve a resource + url: "/tenancy/get-tenancy-resource.html" + swagger-title: GET /tenancy/resource + data-api-method: GET + data-api-path: "/tenancy/resource" + data-summary: Retrieve a resource + data-deprecated: false + data-category: Resource + data-tag-description: | +
    + Overview +
    +

    A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces.

    +

    Each resource contains the following information:

    +
      +
    • Public identifier (such as resource-PnA04qmQ)
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Resource type (such as S3, AZURE, GCP)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    +

    The following actions can be performed with the resource endpoints:

    +
      +
    • Discover a resource
      • +
    • Create, update, or delete a resource
      • +
    • List the resources available in an account
      • +
    • Delete a service resource from an account
      • +
    • Associate or disassociate a resource from the workspace
      • +
    • Disassociate a resource from a Connector
      • +
    +
    +
    + data-introduced: '' + - title: Delete a service resource + url: "/tenancy/delete-tenancy-service-resource-id.html" + swagger-title: DELETE /tenancy/service-resource/{resourceIdentifier} + data-api-method: DELETE + data-api-path: "/tenancy/service-resource/{resourceIdentifier}" + data-summary: Delete a service resource + data-deprecated: false + data-category: Resource + data-tag-description: | +
    + Overview +
    +

    A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces.

    +

    Each resource contains the following information:

    +
      +
    • Public identifier (such as resource-PnA04qmQ)
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Resource type (such as S3, AZURE, GCP)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    +

    The following actions can be performed with the resource endpoints:

    +
      +
    • Discover a resource
      • +
    • Create, update, or delete a resource
      • +
    • List the resources available in an account
      • +
    • Delete a service resource from an account
      • +
    • Associate or disassociate a resource from the workspace
      • +
    • Disassociate a resource from a Connector
      • +
    +
    +
    + data-introduced: '' + - title: Set a cloud identifier + url: "/tenancy/post-tenancy-resource-set-cloud-id.html" + swagger-title: POST /tenancy/resource/{resourceIdentifier}/set-cloud-id + data-api-method: POST + data-api-path: "/tenancy/resource/{resourceIdentifier}/set-cloud-id" + data-summary: Set a cloud identifier + data-deprecated: true + data-category: Resource + data-tag-description: | +
    + Overview +
    +

    A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces.

    +

    Each resource contains the following information:

    +
      +
    • Public identifier (such as resource-PnA04qmQ)
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Resource type (such as S3, AZURE, GCP)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    +

    The following actions can be performed with the resource endpoints:

    +
      +
    • Discover a resource
      • +
    • Create, update, or delete a resource
      • +
    • List the resources available in an account
      • +
    • Delete a service resource from an account
      • +
    • Associate or disassociate a resource from the workspace
      • +
    • Disassociate a resource from a Connector
      • +
    +
    +
    + data-introduced: '' + - title: Set a resource name + url: "/tenancy/post-tenancy-resource-account-set-resource-name.html" + swagger-title: POST /tenancy/resource/{resourceIdentifier}/account/{accountId}/set-resource-name + data-api-method: POST + data-api-path: "/tenancy/resource/{resourceIdentifier}/account/{accountId}/set-resource-name" + data-summary: Set a resource name + data-deprecated: true + data-category: Resource + data-tag-description: | +
    + Overview +
    +

    A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces.

    +

    Each resource contains the following information:

    +
      +
    • Public identifier (such as resource-PnA04qmQ)
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Resource type (such as S3, AZURE, GCP)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    +

    The following actions can be performed with the resource endpoints:

    +
      +
    • Discover a resource
      • +
    • Create, update, or delete a resource
      • +
    • List the resources available in an account
      • +
    • Delete a service resource from an account
      • +
    • Associate or disassociate a resource from the workspace
      • +
    • Disassociate a resource from a Connector
      • +
    +
    +
    + data-introduced: '' + - title: Add a resource to a workspace + url: "/tenancy/post-tenancy-resource-add-to-workspace-id.html" + swagger-title: POST /tenancy/resource/{resourceIdentifier}/add-to-workspace/{workspacePublicId} + data-api-method: POST + data-api-path: "/tenancy/resource/{resourceIdentifier}/add-to-workspace/{workspacePublicId}" + data-summary: Add a resource to a workspace + data-deprecated: false + data-category: Resource + data-tag-description: | +
    + Overview +
    +

    A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces.

    +

    Each resource contains the following information:

    +
      +
    • Public identifier (such as resource-PnA04qmQ)
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Resource type (such as S3, AZURE, GCP)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    +

    The following actions can be performed with the resource endpoints:

    +
      +
    • Discover a resource
      • +
    • Create, update, or delete a resource
      • +
    • List the resources available in an account
      • +
    • Delete a service resource from an account
      • +
    • Associate or disassociate a resource from the workspace
      • +
    • Disassociate a resource from a Connector
      • +
    +
    +
    + data-introduced: '' + - title: Remove a resource from a workspace + url: "/tenancy/post-tenancy-resource-remove-from-workspace-id.html" + swagger-title: POST /tenancy/resource/{resourceIdentifier}/remove-from-workspace/{workspacePublicId} + data-api-method: POST + data-api-path: "/tenancy/resource/{resourceIdentifier}/remove-from-workspace/{workspacePublicId}" + data-summary: Remove a resource from a workspace + data-deprecated: false + data-category: Resource + data-tag-description: | +
    + Overview +
    +

    A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces.

    +

    Each resource contains the following information:

    +
      +
    • Public identifier (such as resource-PnA04qmQ)
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Resource type (such as S3, AZURE, GCP)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    +

    The following actions can be performed with the resource endpoints:

    +
      +
    • Discover a resource
      • +
    • Create, update, or delete a resource
      • +
    • List the resources available in an account
      • +
    • Delete a service resource from an account
      • +
    • Associate or disassociate a resource from the workspace
      • +
    • Disassociate a resource from a Connector
      • +
    +
    +
    + data-introduced: '' + - title: Remove a resource from an agent + url: "/tenancy/post-tenancy-resource-remove-from-agent-id.html" + swagger-title: POST /tenancy/resource/{resourceIdentifier}/remove-from-agent/{agentId} + data-api-method: POST + data-api-path: "/tenancy/resource/{resourceIdentifier}/remove-from-agent/{agentId}" + data-summary: Remove a resource from an agent + data-deprecated: false + data-category: Resource + data-tag-description: | +
    + Overview +
    +

    A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces.

    +

    Each resource contains the following information:

    +
      +
    • Public identifier (such as resource-PnA04qmQ)
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Resource type (such as S3, AZURE, GCP)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    +

    The following actions can be performed with the resource endpoints:

    +
      +
    • Discover a resource
      • +
    • Create, update, or delete a resource
      • +
    • List the resources available in an account
      • +
    • Delete a service resource from an account
      • +
    • Associate or disassociate a resource from the workspace
      • +
    • Disassociate a resource from a Connector
      • +
    +
    +
    + data-introduced: '' + - title: Delete a resource from an account + url: "/tenancy/delete-tenancy-resource-id.html" + swagger-title: DELETE /tenancy/resource/{resourceIdentifier} + data-api-method: DELETE + data-api-path: "/tenancy/resource/{resourceIdentifier}" + data-summary: Delete a resource from an account + data-deprecated: false + data-category: Resource + data-tag-description: | +
    + Overview +
    +

    A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces.

    +

    Each resource contains the following information:

    +
      +
    • Public identifier (such as resource-PnA04qmQ)
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Resource type (such as S3, AZURE, GCP)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    +

    The following actions can be performed with the resource endpoints:

    +
      +
    • Discover a resource
      • +
    • Create, update, or delete a resource
      • +
    • List the resources available in an account
      • +
    • Delete a service resource from an account
      • +
    • Associate or disassociate a resource from the workspace
      • +
    • Disassociate a resource from a Connector
      • +
    +
    +
    + data-introduced: '' + - title: Update properties + url: "/tenancy/post-tenancy-resource-account-update.html" + swagger-title: POST /tenancy/resource/{resourceIdentifier}/account/{accountId}/update + data-api-method: POST + data-api-path: "/tenancy/resource/{resourceIdentifier}/account/{accountId}/update" + data-summary: Update properties + data-deprecated: false + data-category: Resource + data-tag-description: | +
    + Overview +
    +

    A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces.

    +

    Each resource contains the following information:

    +
      +
    • Public identifier (such as resource-PnA04qmQ)
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Resource type (such as S3, AZURE, GCP)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    +

    The following actions can be performed with the resource endpoints:

    +
      +
    • Discover a resource
      • +
    • Create, update, or delete a resource
      • +
    • List the resources available in an account
      • +
    • Delete a service resource from an account
      • +
    • Associate or disassociate a resource from the workspace
      • +
    • Disassociate a resource from a Connector
      • +
    +
    +
    + data-introduced: '' + - title: Delete service resources + url: "/tenancy/delete-tenancy-service-resource-.html" + swagger-title: DELETE /tenancy/service-resources + data-api-method: DELETE + data-api-path: "/tenancy/service-resources" + data-summary: Delete service resources + data-deprecated: false + data-category: Resource + data-tag-description: | +
    + Overview +
    +

    A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces.

    +

    Each resource contains the following information:

    +
      +
    • Public identifier (such as resource-PnA04qmQ)
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Resource type (such as S3, AZURE, GCP)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    +

    The following actions can be performed with the resource endpoints:

    +
      +
    • Discover a resource
      • +
    • Create, update, or delete a resource
      • +
    • List the resources available in an account
      • +
    • Delete a service resource from an account
      • +
    • Associate or disassociate a resource from the workspace
      • +
    • Disassociate a resource from a Connector
      • +
    +
    +
    + data-introduced: '' + - title: Service account + entries: + - title: Overview + url: "/tenancy/service_account_overview.html" + - title: Create a service account + url: "/tenancy/post-tenancy-account-service-account.html" + swagger-title: POST /tenancy/account/{accountId}/service-account + data-api-method: POST + data-api-path: "/tenancy/account/{accountId}/service-account" + data-summary: Create a service account + data-deprecated: false + data-category: Service Account + data-tag-description: | +
    + Overview +
    +

    The service account endpoints represent a general BlueXP service. A service account can be created as an account administrator or delegated more limited authority over one or more workspaces.

    +

    Each service account contains the following information:

    +
      +
    • Public identifier (such as do0uPCFi)
      • +
    • Name
      • +
    • Auth0 identifier (such as HEgEEJbfE0UfBzhmyprOjdZskl3H8KT3)
      • +
    +

    The following actions can be performed with the service account endpoints:

    +
      +
    • Create, Read, Update, and Delete (CRUD) operations
      • +
    • Generate the service account secret
      • +
    +
    +
    + data-introduced: '' + - title: Delete a service account + url: "/tenancy/delete-tenancy-account-service-account-del.html" + swagger-title: DELETE /tenancy/account/{accountId}/service-account/{serviceAccountId} + data-api-method: DELETE + data-api-path: "/tenancy/account/{accountId}/service-account/{serviceAccountId}" + data-summary: Delete a service account + data-deprecated: false + data-category: Service Account + data-tag-description: | +
    + Overview +
    +

    The service account endpoints represent a general BlueXP service. A service account can be created as an account administrator or delegated more limited authority over one or more workspaces.

    +

    Each service account contains the following information:

    +
      +
    • Public identifier (such as do0uPCFi)
      • +
    • Name
      • +
    • Auth0 identifier (such as HEgEEJbfE0UfBzhmyprOjdZskl3H8KT3)
      • +
    +

    The following actions can be performed with the service account endpoints:

    +
      +
    • Create, Read, Update, and Delete (CRUD) operations
      • +
    • Generate the service account secret
      • +
    +
    +
    + data-introduced: '' + - title: Update details + url: "/tenancy/patch-tenancy-account-service-account-pat.html" + swagger-title: PATCH /tenancy/account/{accountId}/service-account/{serviceAccountId} + data-api-method: PATCH + data-api-path: "/tenancy/account/{accountId}/service-account/{serviceAccountId}" + data-summary: Update details + data-deprecated: false + data-category: Service Account + data-tag-description: | +
    + Overview +
    +

    The service account endpoints represent a general BlueXP service. A service account can be created as an account administrator or delegated more limited authority over one or more workspaces.

    +

    Each service account contains the following information:

    +
      +
    • Public identifier (such as do0uPCFi)
      • +
    • Name
      • +
    • Auth0 identifier (such as HEgEEJbfE0UfBzhmyprOjdZskl3H8KT3)
      • +
    +

    The following actions can be performed with the service account endpoints:

    +
      +
    • Create, Read, Update, and Delete (CRUD) operations
      • +
    • Generate the service account secret
      • +
    +
    +
    + data-introduced: '' + - title: Generate a secret + url: "/tenancy/post-tenancy-account-service-account-generate-service-account-secret.html" + swagger-title: POST /tenancy/account/{accountId}/service-account/{serviceAccountId}/generate-service-account-secret + data-api-method: POST + data-api-path: "/tenancy/account/{accountId}/service-account/{serviceAccountId}/generate-service-account-secret" + data-summary: Generate a secret + data-deprecated: false + data-category: Service Account + data-tag-description: | +
    + Overview +
    +

    The service account endpoints represent a general BlueXP service. A service account can be created as an account administrator or delegated more limited authority over one or more workspaces.

    +

    Each service account contains the following information:

    +
      +
    • Public identifier (such as do0uPCFi)
      • +
    • Name
      • +
    • Auth0 identifier (such as HEgEEJbfE0UfBzhmyprOjdZskl3H8KT3)
      • +
    +

    The following actions can be performed with the service account endpoints:

    +
      +
    • Create, Read, Update, and Delete (CRUD) operations
      • +
    • Generate the service account secret
      • +
    +
    +
    + data-introduced: '' + - title: User + entries: + - title: Overview + url: "/tenancy/user_overview.html" + - title: Retrieve users authorized for single resource + url: "/tenancy/get-tenancy-users-for-action--id.html" + swagger-title: GET /tenancy/users/for-action/{accountId}/{action}/{resourceId} + data-api-method: GET + data-api-path: "/tenancy/users/for-action/{accountId}/{action}/{resourceId}" + data-summary: Retrieve users authorized for single resource + data-deprecated: false + data-category: User + data-tag-description: | +
    + Overview +
    +

    The user component represents the end user in the BlueXP platform. Every user is associated with an account and a workspace.

    +

    Each user is defined through the following configuration information:

    +
      +
    • A unique identifier generated by the system at creation
      • +
    • A public visible identifier
      • +
    • An authorization (auth0) identifier
      • +
    +

    The following actions can be performed with the user endpoints:

    +
      +
    • Retrieve users authorized for actions on a particular resource
      • +
    • Retrieve users authorized for actions across all resources
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve users authorized for all resources + url: "/tenancy/get-tenancy-users-for-action-id.html" + swagger-title: GET /tenancy/users/for-action/{accountId}/{action} + data-api-method: GET + data-api-path: "/tenancy/users/for-action/{accountId}/{action}" + data-summary: Retrieve users authorized for all resources + data-deprecated: false + data-category: User + data-tag-description: | +
    + Overview +
    +

    The user component represents the end user in the BlueXP platform. Every user is associated with an account and a workspace.

    +

    Each user is defined through the following configuration information:

    +
      +
    • A unique identifier generated by the system at creation
      • +
    • A public visible identifier
      • +
    • An authorization (auth0) identifier
      • +
    +

    The following actions can be performed with the user endpoints:

    +
      +
    • Retrieve users authorized for actions on a particular resource
      • +
    • Retrieve users authorized for actions across all resources
      • +
    +
    +
    + data-introduced: '' + - title: Workspace + entries: + - title: Overview + url: "/tenancy/workspace_overview.html" + - title: Create a workspace + url: "/tenancy/post-tenancy-account-workspace-id.html" + swagger-title: POST /tenancy/account/{accountId}/workspace/{name} + data-api-method: POST + data-api-path: "/tenancy/account/{accountId}/workspace/{name}" + data-summary: Create a workspace + data-deprecated: false + data-category: Workspace + data-tag-description: | +
    + Overview +
    +

    The workspace endpoints provide more granular access control within a given account. An account can have one or more workspaces, although a specific workspace can only be owned by one account.

    +

    Each workspace is defined through the following configuration information:

    +
      +
    • Name as selected by the administrator
      • +
    • Unique identifier generated by the system at creation
      • +
    • Identifier of the owning account
      • +
    • One or more users allowed to operate within the workspace
      • +
    • One or more Connectors
      • +
    • One or more resources
      • +
    +

    Limiting which users can operate within a workspace, along with the set of Connectors and resources defined for the workspace, provides a natural way to enforce access control. Additional access restrictions can be defined for the Connectors and resources within the workspace.

    +

    Workspaces enable enhanced access control granularity by isolating resources. For example, company departments or projects can be assigned to different workspaces. This isolation provides a high level of security.

    +

    The following actions can be performed with the workspace endpoints:

    +
      +
    • Create a workspace
      • +
    • List the workspaces within an account
      • +
    • Add a user to a workspace
      • +
    • Remove a user from a workspace
      • +
    • List the workspaces associated with a user
      • +
    • Delete a workspace
      • +
    • Rename a workspace
      • +
    • Add a Connector to a workspace
      • +
    • Remove a Connector from a workspace
      • +
    • List the Connectors associated with a workspace
      • +
    +
    +
    + data-introduced: '' + - title: Add a user + url: "/tenancy/post-tenancy-account-workspace-add-user-id.html" + swagger-title: POST /tenancy/account/{accountId}/workspace/{workspacePublicId}/add-user/{userPublicId} + data-api-method: POST + data-api-path: "/tenancy/account/{accountId}/workspace/{workspacePublicId}/add-user/{userPublicId}" + data-summary: Add a user + data-deprecated: false + data-category: Workspace + data-tag-description: | +
    + Overview +
    +

    The workspace endpoints provide more granular access control within a given account. An account can have one or more workspaces, although a specific workspace can only be owned by one account.

    +

    Each workspace is defined through the following configuration information:

    +
      +
    • Name as selected by the administrator
      • +
    • Unique identifier generated by the system at creation
      • +
    • Identifier of the owning account
      • +
    • One or more users allowed to operate within the workspace
      • +
    • One or more Connectors
      • +
    • One or more resources
      • +
    +

    Limiting which users can operate within a workspace, along with the set of Connectors and resources defined for the workspace, provides a natural way to enforce access control. Additional access restrictions can be defined for the Connectors and resources within the workspace.

    +

    Workspaces enable enhanced access control granularity by isolating resources. For example, company departments or projects can be assigned to different workspaces. This isolation provides a high level of security.

    +

    The following actions can be performed with the workspace endpoints:

    +
      +
    • Create a workspace
      • +
    • List the workspaces within an account
      • +
    • Add a user to a workspace
      • +
    • Remove a user from a workspace
      • +
    • List the workspaces associated with a user
      • +
    • Delete a workspace
      • +
    • Rename a workspace
      • +
    • Add a Connector to a workspace
      • +
    • Remove a Connector from a workspace
      • +
    • List the Connectors associated with a workspace
      • +
    +
    +
    + data-introduced: '' + - title: Remove a user + url: "/tenancy/post-tenancy-account-workspace-remove-user-id.html" + swagger-title: POST /tenancy/account/{accountPublicId}/workspace/{workspacePublicId}/remove-user/{userPublicId} + data-api-method: POST + data-api-path: "/tenancy/account/{accountPublicId}/workspace/{workspacePublicId}/remove-user/{userPublicId}" + data-summary: Remove a user + data-deprecated: false + data-category: Workspace + data-tag-description: | +
    + Overview +
    +

    The workspace endpoints provide more granular access control within a given account. An account can have one or more workspaces, although a specific workspace can only be owned by one account.

    +

    Each workspace is defined through the following configuration information:

    +
      +
    • Name as selected by the administrator
      • +
    • Unique identifier generated by the system at creation
      • +
    • Identifier of the owning account
      • +
    • One or more users allowed to operate within the workspace
      • +
    • One or more Connectors
      • +
    • One or more resources
      • +
    +

    Limiting which users can operate within a workspace, along with the set of Connectors and resources defined for the workspace, provides a natural way to enforce access control. Additional access restrictions can be defined for the Connectors and resources within the workspace.

    +

    Workspaces enable enhanced access control granularity by isolating resources. For example, company departments or projects can be assigned to different workspaces. This isolation provides a high level of security.

    +

    The following actions can be performed with the workspace endpoints:

    +
      +
    • Create a workspace
      • +
    • List the workspaces within an account
      • +
    • Add a user to a workspace
      • +
    • Remove a user from a workspace
      • +
    • List the workspaces associated with a user
      • +
    • Delete a workspace
      • +
    • Rename a workspace
      • +
    • Add a Connector to a workspace
      • +
    • Remove a Connector from a workspace
      • +
    • List the Connectors associated with a workspace
      • +
    +
    +
    + data-introduced: '' + - title: Delete a workspace + url: "/tenancy/delete-tenancy-account-workspace-id.html" + swagger-title: DELETE /tenancy/account/{accountId}/workspace/{workspacePublicId} + data-api-method: DELETE + data-api-path: "/tenancy/account/{accountId}/workspace/{workspacePublicId}" + data-summary: Delete a workspace + data-deprecated: false + data-category: Workspace + data-tag-description: | +
    + Overview +
    +

    The workspace endpoints provide more granular access control within a given account. An account can have one or more workspaces, although a specific workspace can only be owned by one account.

    +

    Each workspace is defined through the following configuration information:

    +
      +
    • Name as selected by the administrator
      • +
    • Unique identifier generated by the system at creation
      • +
    • Identifier of the owning account
      • +
    • One or more users allowed to operate within the workspace
      • +
    • One or more Connectors
      • +
    • One or more resources
      • +
    +

    Limiting which users can operate within a workspace, along with the set of Connectors and resources defined for the workspace, provides a natural way to enforce access control. Additional access restrictions can be defined for the Connectors and resources within the workspace.

    +

    Workspaces enable enhanced access control granularity by isolating resources. For example, company departments or projects can be assigned to different workspaces. This isolation provides a high level of security.

    +

    The following actions can be performed with the workspace endpoints:

    +
      +
    • Create a workspace
      • +
    • List the workspaces within an account
      • +
    • Add a user to a workspace
      • +
    • Remove a user from a workspace
      • +
    • List the workspaces associated with a user
      • +
    • Delete a workspace
      • +
    • Rename a workspace
      • +
    • Add a Connector to a workspace
      • +
    • Remove a Connector from a workspace
      • +
    • List the Connectors associated with a workspace
      • +
    +
    +
    + data-introduced: '' + - title: Rename a workspace + url: "/tenancy/patch-tenancy-account-workspace-id.html" + swagger-title: PATCH /tenancy/account/{accountId}/workspace/{workspacePublicId} + data-api-method: PATCH + data-api-path: "/tenancy/account/{accountId}/workspace/{workspacePublicId}" + data-summary: Rename a workspace + data-deprecated: false + data-category: Workspace + data-tag-description: | +
    + Overview +
    +

    The workspace endpoints provide more granular access control within a given account. An account can have one or more workspaces, although a specific workspace can only be owned by one account.

    +

    Each workspace is defined through the following configuration information:

    +
      +
    • Name as selected by the administrator
      • +
    • Unique identifier generated by the system at creation
      • +
    • Identifier of the owning account
      • +
    • One or more users allowed to operate within the workspace
      • +
    • One or more Connectors
      • +
    • One or more resources
      • +
    +

    Limiting which users can operate within a workspace, along with the set of Connectors and resources defined for the workspace, provides a natural way to enforce access control. Additional access restrictions can be defined for the Connectors and resources within the workspace.

    +

    Workspaces enable enhanced access control granularity by isolating resources. For example, company departments or projects can be assigned to different workspaces. This isolation provides a high level of security.

    +

    The following actions can be performed with the workspace endpoints:

    +
      +
    • Create a workspace
      • +
    • List the workspaces within an account
      • +
    • Add a user to a workspace
      • +
    • Remove a user from a workspace
      • +
    • List the workspaces associated with a user
      • +
    • Delete a workspace
      • +
    • Rename a workspace
      • +
    • Add a Connector to a workspace
      • +
    • Remove a Connector from a workspace
      • +
    • List the Connectors associated with a workspace
      • +
    +
    +
    + data-introduced: '' + - title: Add an agent + url: "/tenancy/post-tenancy-account-workspace-add-agent-id.html" + swagger-title: POST /tenancy/account/{accountId}/workspace/{workspacePublicId}/add-agent/{agentAuth0Id} + data-api-method: POST + data-api-path: "/tenancy/account/{accountId}/workspace/{workspacePublicId}/add-agent/{agentAuth0Id}" + data-summary: Add an agent + data-deprecated: false + data-category: Workspace + data-tag-description: | +
    + Overview +
    +

    The workspace endpoints provide more granular access control within a given account. An account can have one or more workspaces, although a specific workspace can only be owned by one account.

    +

    Each workspace is defined through the following configuration information:

    +
      +
    • Name as selected by the administrator
      • +
    • Unique identifier generated by the system at creation
      • +
    • Identifier of the owning account
      • +
    • One or more users allowed to operate within the workspace
      • +
    • One or more Connectors
      • +
    • One or more resources
      • +
    +

    Limiting which users can operate within a workspace, along with the set of Connectors and resources defined for the workspace, provides a natural way to enforce access control. Additional access restrictions can be defined for the Connectors and resources within the workspace.

    +

    Workspaces enable enhanced access control granularity by isolating resources. For example, company departments or projects can be assigned to different workspaces. This isolation provides a high level of security.

    +

    The following actions can be performed with the workspace endpoints:

    +
      +
    • Create a workspace
      • +
    • List the workspaces within an account
      • +
    • Add a user to a workspace
      • +
    • Remove a user from a workspace
      • +
    • List the workspaces associated with a user
      • +
    • Delete a workspace
      • +
    • Rename a workspace
      • +
    • Add a Connector to a workspace
      • +
    • Remove a Connector from a workspace
      • +
    • List the Connectors associated with a workspace
      • +
    +
    +
    + data-introduced: '' + - title: Remove an agent + url: "/tenancy/post-tenancy-account-workspace-remove-agent-id.html" + swagger-title: POST /tenancy/account/{accountId}/workspace/{workspacePublicId}/remove-agent/{agentAuth0Id} + data-api-method: POST + data-api-path: "/tenancy/account/{accountId}/workspace/{workspacePublicId}/remove-agent/{agentAuth0Id}" + data-summary: Remove an agent + data-deprecated: false + data-category: Workspace + data-tag-description: | +
    + Overview +
    +

    The workspace endpoints provide more granular access control within a given account. An account can have one or more workspaces, although a specific workspace can only be owned by one account.

    +

    Each workspace is defined through the following configuration information:

    +
      +
    • Name as selected by the administrator
      • +
    • Unique identifier generated by the system at creation
      • +
    • Identifier of the owning account
      • +
    • One or more users allowed to operate within the workspace
      • +
    • One or more Connectors
      • +
    • One or more resources
      • +
    +

    Limiting which users can operate within a workspace, along with the set of Connectors and resources defined for the workspace, provides a natural way to enforce access control. Additional access restrictions can be defined for the Connectors and resources within the workspace.

    +

    Workspaces enable enhanced access control granularity by isolating resources. For example, company departments or projects can be assigned to different workspaces. This isolation provides a high level of security.

    +

    The following actions can be performed with the workspace endpoints:

    +
      +
    • Create a workspace
      • +
    • List the workspaces within an account
      • +
    • Add a user to a workspace
      • +
    • Remove a user from a workspace
      • +
    • List the workspaces associated with a user
      • +
    • Delete a workspace
      • +
    • Rename a workspace
      • +
    • Add a Connector to a workspace
      • +
    • Remove a Connector from a workspace
      • +
    • List the Connectors associated with a workspace
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve agents + url: "/tenancy/get-tenancy-account-workspace-agents.html" + swagger-title: GET /tenancy/account/{accountId}/workspace/{workspacePublicId}/agents + data-api-method: GET + data-api-path: "/tenancy/account/{accountId}/workspace/{workspacePublicId}/agents" + data-summary: Retrieve agents + data-deprecated: false + data-category: Workspace + data-tag-description: | +
    + Overview +
    +

    The workspace endpoints provide more granular access control within a given account. An account can have one or more workspaces, although a specific workspace can only be owned by one account.

    +

    Each workspace is defined through the following configuration information:

    +
      +
    • Name as selected by the administrator
      • +
    • Unique identifier generated by the system at creation
      • +
    • Identifier of the owning account
      • +
    • One or more users allowed to operate within the workspace
      • +
    • One or more Connectors
      • +
    • One or more resources
      • +
    +

    Limiting which users can operate within a workspace, along with the set of Connectors and resources defined for the workspace, provides a natural way to enforce access control. Additional access restrictions can be defined for the Connectors and resources within the workspace.

    +

    Workspaces enable enhanced access control granularity by isolating resources. For example, company departments or projects can be assigned to different workspaces. This isolation provides a high level of security.

    +

    The following actions can be performed with the workspace endpoints:

    +
      +
    • Create a workspace
      • +
    • List the workspaces within an account
      • +
    • Add a user to a workspace
      • +
    • Remove a user from a workspace
      • +
    • List the workspaces associated with a user
      • +
    • Delete a workspace
      • +
    • Rename a workspace
      • +
    • Add a Connector to a workspace
      • +
    • Remove a Connector from a workspace
      • +
    • List the Connectors associated with a workspace
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve workspaces + url: "/tenancy/get-tenancy-account-workspace.html" + swagger-title: GET /tenancy/account/{accountId}/workspace + data-api-method: GET + data-api-path: "/tenancy/account/{accountId}/workspace" + data-summary: Retrieve workspaces + data-deprecated: false + data-category: Workspace + data-tag-description: | +
    + Overview +
    +

    The workspace endpoints provide more granular access control within a given account. An account can have one or more workspaces, although a specific workspace can only be owned by one account.

    +

    Each workspace is defined through the following configuration information:

    +
      +
    • Name as selected by the administrator
      • +
    • Unique identifier generated by the system at creation
      • +
    • Identifier of the owning account
      • +
    • One or more users allowed to operate within the workspace
      • +
    • One or more Connectors
      • +
    • One or more resources
      • +
    +

    Limiting which users can operate within a workspace, along with the set of Connectors and resources defined for the workspace, provides a natural way to enforce access control. Additional access restrictions can be defined for the Connectors and resources within the workspace.

    +

    Workspaces enable enhanced access control granularity by isolating resources. For example, company departments or projects can be assigned to different workspaces. This isolation provides a high level of security.

    +

    The following actions can be performed with the workspace endpoints:

    +
      +
    • Create a workspace
      • +
    • List the workspaces within an account
      • +
    • Add a user to a workspace
      • +
    • Remove a user from a workspace
      • +
    • List the workspaces associated with a user
      • +
    • Delete a workspace
      • +
    • Rename a workspace
      • +
    • Add a Connector to a workspace
      • +
    • Remove a Connector from a workspace
      • +
    • List the Connectors associated with a workspace
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve user account workspaces + url: "/tenancy/get-tenancy-account-user-workspaces.html" + swagger-title: GET /tenancy/account/{accountId}/user/{userId}/workspaces + data-api-method: GET + data-api-path: "/tenancy/account/{accountId}/user/{userId}/workspaces" + data-summary: Retrieve user account workspaces + data-deprecated: false + data-category: Workspace + data-tag-description: | +
    + Overview +
    +

    The workspace endpoints provide more granular access control within a given account. An account can have one or more workspaces, although a specific workspace can only be owned by one account.

    +

    Each workspace is defined through the following configuration information:

    +
      +
    • Name as selected by the administrator
      • +
    • Unique identifier generated by the system at creation
      • +
    • Identifier of the owning account
      • +
    • One or more users allowed to operate within the workspace
      • +
    • One or more Connectors
      • +
    • One or more resources
      • +
    +

    Limiting which users can operate within a workspace, along with the set of Connectors and resources defined for the workspace, provides a natural way to enforce access control. Additional access restrictions can be defined for the Connectors and resources within the workspace.

    +

    Workspaces enable enhanced access control granularity by isolating resources. For example, company departments or projects can be assigned to different workspaces. This isolation provides a high level of security.

    +

    The following actions can be performed with the workspace endpoints:

    +
      +
    • Create a workspace
      • +
    • List the workspaces within an account
      • +
    • Add a user to a workspace
      • +
    • Remove a user from a workspace
      • +
    • List the workspaces associated with a user
      • +
    • Delete a workspace
      • +
    • Rename a workspace
      • +
    • Add a Connector to a workspace
      • +
    • Remove a Connector from a workspace
      • +
    • List the Connectors associated with a workspace
      • +
    +
    +
    + data-introduced: '' + - title: Amazon FSx for NetApp ONTAP management + entries: + - title: Overview + url: "/fsx/overview.html" + - title: AWS credentials + entries: + - title: Overview + url: "/fsx/aws_credentials_overview.html" + - title: Retrieve AWS credentials + url: "/fsx/get-aws-credentials-.html" + swagger-title: GET /aws-credentials/{accountId} + data-api-method: GET + data-api-path: "/aws-credentials/{accountId}" + data-summary: Retrieve AWS credentials + data-deprecated: false + data-category: AWS Credentials + data-tag-description: | +
    + Overview +
    + The AWS credentials endpoints interact with the Credentials service to retrieve appropriate AWS credentials. +

    You can perform the following actions with the AWS credentials endpoints:

    +
      +
    • Retrieve AWS credentials for a Tenancy account
      • +
    • [Deprecated] Create AWS credentials
      • +
    +
    +
    + data-introduced: '' + - title: Add AWS credentials + url: "/fsx/post-aws-credentials-.html" + swagger-title: POST /aws-credentials/{accountId} + data-api-method: POST + data-api-path: "/aws-credentials/{accountId}" + data-summary: Add AWS credentials + data-deprecated: true + data-category: AWS Credentials + data-tag-description: | +
    + Overview +
    + The AWS credentials endpoints interact with the Credentials service to retrieve appropriate AWS credentials. +

    You can perform the following actions with the AWS credentials endpoints:

    +
      +
    • Retrieve AWS credentials for a Tenancy account
      • +
    • [Deprecated] Create AWS credentials
      • +
    +
    +
    + data-introduced: '' + - title: AWS operations + entries: + - title: Overview + url: "/fsx/aws_operations_overview.html" + - title: Retrieve VPCs + url: "/fsx/get-aws-vpcs.html" + swagger-title: GET /aws/vpcs + data-api-method: GET + data-api-path: "/aws/vpcs" + data-summary: Retrieve VPCs + data-deprecated: false + data-category: AWS Operations + data-tag-description: | +
    + Overview +
    + The AWS operations endpoints manage operations made directly on AWS resources by using AWS credentials. +

    You can perform the following actions with the AWS operations endpoints:

    +
      +
    • Retrieve AWS VPCs
      • +
    • Retrieve AWS route tables
      • +
    • Retrieve AWS encryption keys
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve route tables + url: "/fsx/get-aws-route-tables.html" + swagger-title: GET /aws/route-tables + data-api-method: GET + data-api-path: "/aws/route-tables" + data-summary: Retrieve route tables + data-deprecated: false + data-category: AWS Operations + data-tag-description: | +
    + Overview +
    + The AWS operations endpoints manage operations made directly on AWS resources by using AWS credentials. +

    You can perform the following actions with the AWS operations endpoints:

    +
      +
    • Retrieve AWS VPCs
      • +
    • Retrieve AWS route tables
      • +
    • Retrieve AWS encryption keys
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve encryption keys + url: "/fsx/get-aws-encryption-keys.html" + swagger-title: GET /aws/encryption-keys + data-api-method: GET + data-api-path: "/aws/encryption-keys" + data-summary: Retrieve encryption keys + data-deprecated: false + data-category: AWS Operations + data-tag-description: | +
    + Overview +
    + The AWS operations endpoints manage operations made directly on AWS resources by using AWS credentials. +

    You can perform the following actions with the AWS operations endpoints:

    +
      +
    • Retrieve AWS VPCs
      • +
    • Retrieve AWS route tables
      • +
    • Retrieve AWS encryption keys
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve supported regions + url: "/fsx/get-aws-supported-regions.html" + swagger-title: GET /aws/supported-regions + data-api-method: GET + data-api-path: "/aws/supported-regions" + data-summary: Retrieve supported regions + data-deprecated: false + data-category: AWS Operations + data-tag-description: | +
    + Overview +
    + The AWS operations endpoints manage operations made directly on AWS resources by using AWS credentials. +

    You can perform the following actions with the AWS operations endpoints:

    +
      +
    • Retrieve AWS VPCs
      • +
    • Retrieve AWS route tables
      • +
    • Retrieve AWS encryption keys
      • +
    +
    +
    + data-introduced: '' + - title: FSx ONTAP discovery + entries: + - title: Overview + url: "/fsx/fsx_ontap_discovery_overview.html" + - title: Discover FSx ONTAP systems + url: "/fsx/get-discovery-discover.html" + swagger-title: GET /discovery/{accountId}/discover + data-api-method: GET + data-api-path: "/discovery/{accountId}/discover" + data-summary: Discover FSx ONTAP systems + data-deprecated: false + data-category: FSx ONTAP discovery + data-tag-description: | +
    + Overview +
    + The discovery endpoints provide an API for discovering FSx ONTAP systems for a specified account in Cloud Manager. +

    You can perform the following actions with the discovery endpoints:

    +
      +
    • Discover an FSx for ONTAP an account
      • +
    +
    +
    + data-introduced: '' + - title: Working environments + entries: + - title: Overview + url: "/fsx/working_environments_overview.html" + - title: Retrieve working environments + url: "/fsx/get-working-environments-.html" + swagger-title: GET /working-environments/{accountId} + data-api-method: GET + data-api-path: "/working-environments/{accountId}" + data-summary: Retrieve working environments + data-deprecated: false + data-category: Working Environments + data-tag-description: | +
    + Overview +
    + The working environment endpoints manage operations made on working environments in Cloud Manager. +

    You can perform the following actions with the working environment endpoints:

    +
      +
    • Create an FSx for ONTAP working environment
      • +
    • Retrieve FSx for ONTAP working environments by account
      • +
    • Discover an FSx for ONTAP working environment
      • +
    • Retrieve volume details for an FSx for ONTAP working environment
      • +
    • Retrieve ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Create ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Recover FSx for ONTAP as a working environment
      • +
    • Retrieve details for an FSx for ONTAP working environment
      • +
    • Delete an FSx for ONTAP working environment
      • +
    • Remove an FSx for ONTAP working environment from a workspace
      • +
    • Update the throughput capacity of an FSx for ONTAP working environment
      • +
    +
    +
    + data-introduced: '' + - title: Create FSx for ONTAP working environments + url: "/fsx/post-working-environments-.html" + swagger-title: POST /working-environments/{accountId} + data-api-method: POST + data-api-path: "/working-environments/{accountId}" + data-summary: Create FSx for ONTAP working environments + data-deprecated: false + data-category: Working Environments + data-tag-description: | +
    + Overview +
    + The working environment endpoints manage operations made on working environments in Cloud Manager. +

    You can perform the following actions with the working environment endpoints:

    +
      +
    • Create an FSx for ONTAP working environment
      • +
    • Retrieve FSx for ONTAP working environments by account
      • +
    • Discover an FSx for ONTAP working environment
      • +
    • Retrieve volume details for an FSx for ONTAP working environment
      • +
    • Retrieve ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Create ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Recover FSx for ONTAP as a working environment
      • +
    • Retrieve details for an FSx for ONTAP working environment
      • +
    • Delete an FSx for ONTAP working environment
      • +
    • Remove an FSx for ONTAP working environment from a workspace
      • +
    • Update the throughput capacity of an FSx for ONTAP working environment
      • +
    +
    +
    + data-introduced: '' + - title: Discover working environments + url: "/fsx/get-working-environments-discover.html" + swagger-title: GET /working-environments/{accountId}/discover + data-api-method: GET + data-api-path: "/working-environments/{accountId}/discover" + data-summary: Discover working environments + data-deprecated: false + data-category: Working Environments + data-tag-description: | +
    + Overview +
    + The working environment endpoints manage operations made on working environments in Cloud Manager. +

    You can perform the following actions with the working environment endpoints:

    +
      +
    • Create an FSx for ONTAP working environment
      • +
    • Retrieve FSx for ONTAP working environments by account
      • +
    • Discover an FSx for ONTAP working environment
      • +
    • Retrieve volume details for an FSx for ONTAP working environment
      • +
    • Retrieve ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Create ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Recover FSx for ONTAP as a working environment
      • +
    • Retrieve details for an FSx for ONTAP working environment
      • +
    • Delete an FSx for ONTAP working environment
      • +
    • Remove an FSx for ONTAP working environment from a workspace
      • +
    • Update the throughput capacity of an FSx for ONTAP working environment
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve volumes + url: "/fsx/get-working-environments--volumes.html" + swagger-title: GET /working-environments/{accountId}/{workingEnvironmentId}/volumes + data-api-method: GET + data-api-path: "/working-environments/{accountId}/{workingEnvironmentId}/volumes" + data-summary: Retrieve volumes + data-deprecated: false + data-category: Working Environments + data-tag-description: | +
    + Overview +
    + The working environment endpoints manage operations made on working environments in Cloud Manager. +

    You can perform the following actions with the working environment endpoints:

    +
      +
    • Create an FSx for ONTAP working environment
      • +
    • Retrieve FSx for ONTAP working environments by account
      • +
    • Discover an FSx for ONTAP working environment
      • +
    • Retrieve volume details for an FSx for ONTAP working environment
      • +
    • Retrieve ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Create ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Recover FSx for ONTAP as a working environment
      • +
    • Retrieve details for an FSx for ONTAP working environment
      • +
    • Delete an FSx for ONTAP working environment
      • +
    • Remove an FSx for ONTAP working environment from a workspace
      • +
    • Update the throughput capacity of an FSx for ONTAP working environment
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve ONTAP credentials + url: "/fsx/get-working-environments--credentials.html" + swagger-title: GET /working-environments/{accountId}/{workingEnvironmentId}/credentials + data-api-method: GET + data-api-path: "/working-environments/{accountId}/{workingEnvironmentId}/credentials" + data-summary: Retrieve ONTAP credentials + data-deprecated: false + data-category: Working Environments + data-tag-description: | +
    + Overview +
    + The working environment endpoints manage operations made on working environments in Cloud Manager. +

    You can perform the following actions with the working environment endpoints:

    +
      +
    • Create an FSx for ONTAP working environment
      • +
    • Retrieve FSx for ONTAP working environments by account
      • +
    • Discover an FSx for ONTAP working environment
      • +
    • Retrieve volume details for an FSx for ONTAP working environment
      • +
    • Retrieve ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Create ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Recover FSx for ONTAP as a working environment
      • +
    • Retrieve details for an FSx for ONTAP working environment
      • +
    • Delete an FSx for ONTAP working environment
      • +
    • Remove an FSx for ONTAP working environment from a workspace
      • +
    • Update the throughput capacity of an FSx for ONTAP working environment
      • +
    +
    +
    + data-introduced: '' + - title: Create ONTAP credentials + url: "/fsx/post-working-environments--credentials.html" + swagger-title: POST /working-environments/{accountId}/{workingEnvironmentId}/credentials + data-api-method: POST + data-api-path: "/working-environments/{accountId}/{workingEnvironmentId}/credentials" + data-summary: Create ONTAP credentials + data-deprecated: false + data-category: Working Environments + data-tag-description: | +
    + Overview +
    + The working environment endpoints manage operations made on working environments in Cloud Manager. +

    You can perform the following actions with the working environment endpoints:

    +
      +
    • Create an FSx for ONTAP working environment
      • +
    • Retrieve FSx for ONTAP working environments by account
      • +
    • Discover an FSx for ONTAP working environment
      • +
    • Retrieve volume details for an FSx for ONTAP working environment
      • +
    • Retrieve ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Create ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Recover FSx for ONTAP as a working environment
      • +
    • Retrieve details for an FSx for ONTAP working environment
      • +
    • Delete an FSx for ONTAP working environment
      • +
    • Remove an FSx for ONTAP working environment from a workspace
      • +
    • Update the throughput capacity of an FSx for ONTAP working environment
      • +
    +
    +
    + data-introduced: '' + - title: Recover working environments + url: "/fsx/post-working-environments-recover.html" + swagger-title: POST /working-environments/{accountId}/recover + data-api-method: POST + data-api-path: "/working-environments/{accountId}/recover" + data-summary: Recover working environments + data-deprecated: false + data-category: Working Environments + data-tag-description: | +
    + Overview +
    + The working environment endpoints manage operations made on working environments in Cloud Manager. +

    You can perform the following actions with the working environment endpoints:

    +
      +
    • Create an FSx for ONTAP working environment
      • +
    • Retrieve FSx for ONTAP working environments by account
      • +
    • Discover an FSx for ONTAP working environment
      • +
    • Retrieve volume details for an FSx for ONTAP working environment
      • +
    • Retrieve ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Create ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Recover FSx for ONTAP as a working environment
      • +
    • Retrieve details for an FSx for ONTAP working environment
      • +
    • Delete an FSx for ONTAP working environment
      • +
    • Remove an FSx for ONTAP working environment from a workspace
      • +
    • Update the throughput capacity of an FSx for ONTAP working environment
      • +
    +
    +
    + data-introduced: '' + - title: Retrieve working environments by account + url: "/fsx/get-working-environments-id-.html" + swagger-title: GET /working-environments/{accountId}/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/working-environments/{accountId}/{workingEnvironmentId}" + data-summary: Retrieve working environments by account + data-deprecated: false + data-category: Working Environments + data-tag-description: | +
    + Overview +
    + The working environment endpoints manage operations made on working environments in Cloud Manager. +

    You can perform the following actions with the working environment endpoints:

    +
      +
    • Create an FSx for ONTAP working environment
      • +
    • Retrieve FSx for ONTAP working environments by account
      • +
    • Discover an FSx for ONTAP working environment
      • +
    • Retrieve volume details for an FSx for ONTAP working environment
      • +
    • Retrieve ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Create ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Recover FSx for ONTAP as a working environment
      • +
    • Retrieve details for an FSx for ONTAP working environment
      • +
    • Delete an FSx for ONTAP working environment
      • +
    • Remove an FSx for ONTAP working environment from a workspace
      • +
    • Update the throughput capacity of an FSx for ONTAP working environment
      • +
    +
    +
    + data-introduced: '' + - title: Delete an FSX working environment + url: "/fsx/delete-working-environments-.html" + swagger-title: DELETE /working-environments/{accountId}/{workingEnvironmentId} + data-api-method: DELETE + data-api-path: "/working-environments/{accountId}/{workingEnvironmentId}" + data-summary: Delete an FSX working environment + data-deprecated: false + data-category: Working Environments + data-tag-description: | +
    + Overview +
    + The working environment endpoints manage operations made on working environments in Cloud Manager. +

    You can perform the following actions with the working environment endpoints:

    +
      +
    • Create an FSx for ONTAP working environment
      • +
    • Retrieve FSx for ONTAP working environments by account
      • +
    • Discover an FSx for ONTAP working environment
      • +
    • Retrieve volume details for an FSx for ONTAP working environment
      • +
    • Retrieve ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Create ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Recover FSx for ONTAP as a working environment
      • +
    • Retrieve details for an FSx for ONTAP working environment
      • +
    • Delete an FSx for ONTAP working environment
      • +
    • Remove an FSx for ONTAP working environment from a workspace
      • +
    • Update the throughput capacity of an FSx for ONTAP working environment
      • +
    +
    +
    + data-introduced: '' + - title: Remove working environment from workspace + url: "/fsx/delete-working-environments--workspace-.html" + swagger-title: DELETE /working-environments/{accountId}/{workingEnvironmentId}/workspace/{workspaceId} + data-api-method: DELETE + data-api-path: "/working-environments/{accountId}/{workingEnvironmentId}/workspace/{workspaceId}" + data-summary: Remove working environment from workspace + data-deprecated: false + data-category: Working Environments + data-tag-description: | +
    + Overview +
    + The working environment endpoints manage operations made on working environments in Cloud Manager. +

    You can perform the following actions with the working environment endpoints:

    +
      +
    • Create an FSx for ONTAP working environment
      • +
    • Retrieve FSx for ONTAP working environments by account
      • +
    • Discover an FSx for ONTAP working environment
      • +
    • Retrieve volume details for an FSx for ONTAP working environment
      • +
    • Retrieve ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Create ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Recover FSx for ONTAP as a working environment
      • +
    • Retrieve details for an FSx for ONTAP working environment
      • +
    • Delete an FSx for ONTAP working environment
      • +
    • Remove an FSx for ONTAP working environment from a workspace
      • +
    • Update the throughput capacity of an FSx for ONTAP working environment
      • +
    +
    +
    + data-introduced: '' + - title: Update FSx ONTAP systems + url: "/fsx/patch-working-environments-.html" + swagger-title: PATCH /working-environments/{accountId}/{fileSystemId} + data-api-method: PATCH + data-api-path: "/working-environments/{accountId}/{fileSystemId}" + data-summary: Update FSx ONTAP systems + data-deprecated: false + data-category: Working Environments + data-tag-description: | +
    + Overview +
    + The working environment endpoints manage operations made on working environments in Cloud Manager. +

    You can perform the following actions with the working environment endpoints:

    +
      +
    • Create an FSx for ONTAP working environment
      • +
    • Retrieve FSx for ONTAP working environments by account
      • +
    • Discover an FSx for ONTAP working environment
      • +
    • Retrieve volume details for an FSx for ONTAP working environment
      • +
    • Retrieve ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Create ONTAP credentials for an FSx for ONTAP working environment
      • +
    • Recover FSx for ONTAP as a working environment
      • +
    • Retrieve details for an FSx for ONTAP working environment
      • +
    • Delete an FSx for ONTAP working environment
      • +
    • Remove an FSx for ONTAP working environment from a workspace
      • +
    • Update the throughput capacity of an FSx for ONTAP working environment
      • +
    +
    +
    + data-introduced: '' + - title: Audit + entries: + - title: Overview + url: "/audit/overview.html" + - title: Retrieve account records + url: "/audit/get-audit.html" + swagger-title: GET /audit/{accountId} + data-api-method: GET + data-api-path: "/audit/{accountId}" + data-summary: Retrieve account records + data-deprecated: false + data-category: '' + data-tag-description: '' + data-introduced: '' + - title: Retrieve audit options + url: "/audit/get-audit-options.html" + swagger-title: GET /audit/{accountId}/options + data-api-method: GET + data-api-path: "/audit/{accountId}/options" + data-summary: Retrieve audit options + data-deprecated: false + data-category: '' + data-tag-description: '' + data-introduced: '' + - title: Retrieve records by service + url: "/audit/get-audit--records.html" + swagger-title: GET /audit/{accountId}/{service}/{requestId}/records + data-api-method: GET + data-api-path: "/audit/{accountId}/{service}/{requestId}/records" + data-summary: Retrieve records by service + data-deprecated: false + data-category: '' + data-tag-description: '' + data-introduced: '' + - title: Backup and Recovery + entries: + - title: Overview + url: "/cbs/overview.html" + - title: Backup + entries: + - title: Overview + url: "/cbs/backup_overview.html" + - title: Retrieve system details + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment" + data-summary: Retrieve system details + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Retrieve the details of all the systems that are backed up + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v2-backup-working-environment.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment" + data-summary: Retrieve the details of all the systems that are backed up + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Retrieve specific system details + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}" + data-summary: Retrieve specific system details + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Unregister a system + url: "/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-.html" + swagger-title: DELETE /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId} + data-api-method: DELETE + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}" + data-summary: Unregister a system + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Retrieve the backup status + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-status.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/status + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/status" + data-summary: Retrieve the backup status + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Modify the Backup and Recovery service backup configuration + url: "/cbs/put-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-.html" + swagger-title: PUT /account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment/{workingEnvironmentId} + data-api-method: PUT + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment/{workingEnvironmentId}" + data-summary: Modify the Backup and Recovery service backup configuration + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Retrieve volume information + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}" + data-summary: Retrieve volume information + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Modify a backed up volume + url: "/cbs/put-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.html" + swagger-title: PUT /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId} + data-api-method: PUT + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}" + data-summary: Modify a backed up volume + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Remove backup settings + url: "/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-.html" + swagger-title: DELETE /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId} + data-api-method: DELETE + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}" + data-summary: Remove backup settings + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Enable backup for a volume (v3) + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v3-backup-working-environment-volume-.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v3/backup/working-environment/{workingEnvironmentId}/volume/{volumeId} + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v3/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}" + data-summary: Enable backup for a volume (v3) + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Retrieve volume details + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume" + data-summary: Retrieve volume details + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Modify multiple backed up volumes + url: "/cbs/put-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume.html" + swagger-title: PUT /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume + data-api-method: PUT + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume" + data-summary: Modify multiple backed up volumes + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Retrieve specific snapshot information for a volume + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}" + data-summary: Retrieve specific snapshot information for a volume + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Delete a snapshot + url: "/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot-.html" + swagger-title: DELETE /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId} + data-api-method: DELETE + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}" + data-summary: Delete a snapshot + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Retrieve snapshot information for a volume + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot" + data-summary: Retrieve snapshot information for a volume + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Delete all snapshots (volume) + url: "/cbs/delete-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-volume-snapshot.html" + swagger-title: DELETE /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot + data-api-method: DELETE + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot" + data-summary: Delete all snapshots (volume) + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Retrieve a list of snapshots using the account ID + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-snapshot.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/snapshot + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/snapshot" + data-summary: Retrieve a list of snapshots using the account ID + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Delete all snapshots (system) + url: "/cbs/delete-account-providers-cloudmanager_cbs-api-v2-backup-working-environment-snapshot.html" + swagger-title: DELETE /account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment/{workingEnvironmentId}/snapshot + data-api-method: DELETE + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment/{workingEnvironmentId}/snapshot" + data-summary: Delete all snapshots (system) + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Retrieve snapshot information for a volume + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-backup-working-environment-snapshot.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/snapshot + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/snapshot" + data-summary: Retrieve snapshot information for a volume + data-deprecated: false + data-category: Backup + data-tag-description: "
    Overview

    The backup endpoints + manage backup operations of cloud and on-premises resources and retrieve + details of the backup data when required. You can perform the following + operations by using the Backup endpoints:

    • Retrieve details of + the backup data of a system, volumes, and snapshots.

    • Enable + cloud backup on a system, back up volumes, and create on-demand backups.

    • Modify + the backup configuration of systems and volumes.

    • Disable backups + for systems and volumes, and delete backups.
    " + data-introduced: '' + - title: Catalog + entries: + - title: Overview + url: "/cbs/catalog_overview.html" + - title: Configure a service + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v2-catalog-working-environments-setup.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v2/catalog/working-environments/{workingEnvironmentId}/setup + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/catalog/working-environments/{workingEnvironmentId}/setup" + data-summary: Configure a service + data-deprecated: false + data-category: Catalog + data-tag-description: "
    Overview

    The catalog + endpoints manage the indexed catalog search for files based on a query. + You can perform the following operations by using the Catalog endpoints:

    • Initiate + an indexed catalog search based on a query

    • Retrieve a list + of snapshots related to a particular volume by using the Catalog Index query

    • Configure + an indexed catalog service on AWS, Azure, Google Cloud and on-premises or + dark sites.

    • Modify the state of an indexed catalog service.
    " + data-introduced: '' + - title: Re-index the catalog for all of the systems in an account + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v2-catalog-re-index.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v2/catalog/re-index + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/catalog/re-index" + data-summary: Re-index the catalog for all of the systems in an account + data-deprecated: false + data-category: Catalog + data-tag-description: "
    Overview

    The catalog + endpoints manage the indexed catalog search for files based on a query. + You can perform the following operations by using the Catalog endpoints:

    • Initiate + an indexed catalog search based on a query

    • Retrieve a list + of snapshots related to a particular volume by using the Catalog Index query

    • Configure + an indexed catalog service on AWS, Azure, Google Cloud and on-premises or + dark sites.

    • Modify the state of an indexed catalog service.
    " + data-introduced: '' + - title: Search a specific file + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-catalog-search.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/search + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/search" + data-summary: Search a specific file + data-deprecated: false + data-category: Catalog + data-tag-description: "
    Overview

    The catalog + endpoints manage the indexed catalog search for files based on a query. + You can perform the following operations by using the Catalog endpoints:

    • Initiate + an indexed catalog search based on a query

    • Retrieve a list + of snapshots related to a particular volume by using the Catalog Index query

    • Configure + an indexed catalog service on AWS, Azure, Google Cloud and on-premises or + dark sites.

    • Modify the state of an indexed catalog service.
    " + data-introduced: '' + - title: Search for a specific file (on premises) + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-catalog-search-job.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/search/job + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/search/job" + data-summary: Search for a specific file (on premises) + data-deprecated: false + data-category: Catalog + data-tag-description: "
    Overview

    The catalog + endpoints manage the indexed catalog search for files based on a query. + You can perform the following operations by using the Catalog endpoints:

    • Initiate + an indexed catalog search based on a query

    • Retrieve a list + of snapshots related to a particular volume by using the Catalog Index query

    • Configure + an indexed catalog service on AWS, Azure, Google Cloud and on-premises or + dark sites.

    • Modify the state of an indexed catalog service.
    " + data-introduced: '' + - title: Retrieve snapshots + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-catalog-snapshots.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/snapshots + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/snapshots" + data-summary: Retrieve snapshots + data-deprecated: false + data-category: Catalog + data-tag-description: "
    Overview

    The catalog + endpoints manage the indexed catalog search for files based on a query. + You can perform the following operations by using the Catalog endpoints:

    • Initiate + an indexed catalog search based on a query

    • Retrieve a list + of snapshots related to a particular volume by using the Catalog Index query

    • Configure + an indexed catalog service on AWS, Azure, Google Cloud and on-premises or + dark sites.

    • Modify the state of an indexed catalog service.
    " + data-introduced: '' + - title: Enable or disable the service + url: "/cbs/put-account-providers-cloudmanager_cbs-api-v1-catalog-working-environments-.html" + swagger-title: PUT /account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/working-environments/{workingEnvironmentId} + data-api-method: PUT + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/working-environments/{workingEnvironmentId}" + data-summary: Enable or disable the service + data-deprecated: false + data-category: Catalog + data-tag-description: "
    Overview

    The catalog + endpoints manage the indexed catalog search for files based on a query. + You can perform the following operations by using the Catalog endpoints:

    • Initiate + an indexed catalog search based on a query

    • Retrieve a list + of snapshots related to a particular volume by using the Catalog Index query

    • Configure + an indexed catalog service on AWS, Azure, Google Cloud and on-premises or + dark sites.

    • Modify the state of an indexed catalog service.
    " + data-introduced: '' + - title: Cloud + entries: + - title: Overview + url: "/cbs/cloud_overview.html" + - title: Retrieve AWS accounts + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-account.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/account + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/account" + data-summary: Retrieve AWS accounts + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve subscribed AWS regions + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-region.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/region + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/region" + data-summary: Retrieve subscribed AWS regions + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve AWS keys + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-region-key.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/region/{regionCode}/key + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/region/{regionCode}/key" + data-summary: Retrieve AWS keys + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve AWS private links + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-region-privatelink.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/region/{regionCode}/privateLink + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/region/{regionCode}/privateLink" + data-summary: Retrieve AWS private links + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve AWS storage classes + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-archival-storage-class.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/archival-storage-class + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/archival-storage-class" + data-summary: Retrieve AWS storage classes + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve a list of AWS S3 buckets from a region + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-buckets.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/buckets + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/buckets" + data-summary: Retrieve a list of AWS S3 buckets from a region + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve an AWS S3 bucket from a region + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-aws-awsaccountid-buckets-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/buckets/{bucketName} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/aws/awsAccountId/{awsAccountId}/buckets/{bucketName}" + data-summary: Retrieve an AWS S3 bucket from a region + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve regions + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-region.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/region + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/region" + data-summary: Retrieve regions + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Create an Azure resource group + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resource-group.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resource-group + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resource-group" + data-summary: Create an Azure resource group + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve Azure resource groups + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resource-group.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resource-group + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resource-group" + data-summary: Retrieve Azure resource groups + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve Azure virtual networks + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vnet.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vnet + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vnet" + data-summary: Retrieve Azure virtual networks + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve Azure subscriptions + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription" + data-summary: Retrieve Azure subscriptions + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve Azure vault keys + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vault-key.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vault/{vaultName}/key + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vault/{vaultName}/key" + data-summary: Retrieve Azure vault keys + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve Azure vaults + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-vault.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vault + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/vault" + data-summary: Retrieve Azure vaults + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve a list of Azure storage accounts for a subscription ID + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resourcegroup-storageaccounts.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resourceGroup/{resourceGroup}/storageAccounts + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resourceGroup/{resourceGroup}/storageAccounts" + data-summary: Retrieve a list of Azure storage accounts for a subscription + ID + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve a specific Azure storage account for a subscription ID + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-azure-subscription-resourcegroup-storageaccounts-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resourceGroup/{resourceGroup}/storageAccounts/{storageAccountName} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/azure/subscription/{subscriptionId}/resourceGroup/{resourceGroup}/storageAccounts/{storageAccountName}" + data-summary: Retrieve a specific Azure storage account for a subscription + ID + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve Google Cloud projects + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project" + data-summary: Retrieve Google Cloud projects + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve Google Cloud regions + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region" + data-summary: Retrieve Google Cloud regions + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve a list of KeyRings for a region + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region-keyrings.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region/{locationId}/keyrings + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region/{locationId}/keyrings" + data-summary: Retrieve a list of KeyRings for a region + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve a list of CryptoKeys + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-region-keyrings-cryptokey.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region/{locationId}/keyrings/{keyRingId}/cryptokey + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/region/{locationId}/keyrings/{keyRingId}/cryptokey" + data-summary: Retrieve a list of CryptoKeys + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve a list of Google Cloud buckets in a region + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-buckets.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/buckets + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/buckets" + data-summary: Retrieve a list of Google Cloud buckets in a region + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Retrieve a Google Cloud bucket in a region + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-gcp-project-buckets-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/buckets/{bucketName} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/gcp/project/{projectId}/buckets/{bucketName}" + data-summary: Retrieve a Google Cloud bucket in a region + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: List Google Cloud credentials + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v2-gcp-credentials.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials" + data-summary: List Google Cloud credentials + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Register Google Cloud credentials + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v2-gcp-credentials.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials" + data-summary: Register Google Cloud credentials + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Update Google Cloud credentials + url: "/cbs/put-account-providers-cloudmanager_cbs-api-v2-gcp-credentials-.html" + swagger-title: PUT /account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials/{credentialsId} + data-api-method: PUT + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials/{credentialsId}" + data-summary: Update Google Cloud credentials + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Delete Google Cloud credentials + url: "/cbs/delete-account-providers-cloudmanager_cbs-api-v2-gcp-credentials-.html" + swagger-title: DELETE /account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials/{credentialsId} + data-api-method: DELETE + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/gcp/credentials/{credentialsId}" + data-summary: Delete Google Cloud credentials + data-deprecated: false + data-category: Cloud + data-tag-description: "
    Overview

    The cloud endpoints + enable you to retrieve information about various resources of the AWS, Azure, + Google Cloud providers from the NetApp Console SaaS application.

    You + can perform the following actions by using the cloud endpoints:

    • Retrieve + the accounts, AWS region keys, AWS region private links, AWS archival storage + class, Azure subscription, Azure subscription regions, Azure subscription + resource-group, Azure subscription VNet, Azure subscription vault key, Google + Cloud projects, Google Cloud project region, Google KeyRings and more.

    • Create + a subscription resource-group.

    " + data-introduced: '' + - title: Configuration + entries: + - title: Modify the configuration + url: "/cbs/put-account-providers-cloudmanager_cbs-api-v1-configurations.html" + swagger-title: PUT /account/{accountId}/providers/cloudmanager_cbs/api/v1/configurations + data-api-method: PUT + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/configurations" + data-summary: Modify the configuration + data-deprecated: false + data-category: Configuration + data-tag-description: '' + data-introduced: '' + - title: Retrieve the configuration value for the specified key + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-configurations-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/configurations/{key} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/configurations/{key}" + data-summary: Retrieve the configuration value for the specified key + data-deprecated: false + data-category: Configuration + data-tag-description: '' + data-introduced: '' + - title: Features + entries: + - title: Retrieve a list of features which are enabled or disabled for the account + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-feature-flags.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/feature-flags + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/feature-flags" + data-summary: Retrieve a list of features which are enabled or disabled for + the account + data-deprecated: false + data-category: Features + data-tag-description: '' + data-introduced: '' + - title: Job + entries: + - title: Overview + url: "/cbs/job_overview.html" + - title: Retrieve jobs + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-job.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/job + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/job" + data-summary: Retrieve jobs + data-deprecated: false + data-category: Job + data-tag-description: "
    Overview

    The Job endpoints + display information about jobs executed on the NetApp Console SaaS application.

    You + can perform the following operation by using the Job endpoints:

    • Retrieve + a list of jobs and job details.
    " + data-introduced: '' + - title: Retrieve particular job details + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-job-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/job/{jobId} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/job/{jobId}" + data-summary: Retrieve particular job details + data-deprecated: false + data-category: Job + data-tag-description: "
    Overview

    The Job endpoints + display information about jobs executed on the NetApp Console SaaS application.

    You + can perform the following operation by using the Job endpoints:

    • Retrieve + a list of jobs and job details.
    " + data-introduced: '' + - title: License + entries: + - title: Overview + url: "/cbs/license_overview.html" + - title: Retrieve license validity + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-license-working-environment-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/license/working-environment/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/license/working-environment/{workingEnvironmentId}" + data-summary: Retrieve license validity + data-deprecated: false + data-category: License + data-tag-description: "
    Overview

    The license + endpoints enable you to retrieve the license validity of the systems from + the NetApp Console SaaS application. A valid license is required to activate + NetApp Backup and Recovery on a system, create backups of your production + data, and restore backup data on a production system. This API retrieves + the eligibility of the current license used and returns the days remaining + if you are using a trial license.

    " + data-introduced: '' + - title: Verify the valid licenses in a system + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-license-working-environment-validity.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/license/working-environment/{workingEnvironmentId}/validity + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/license/working-environment/{workingEnvironmentId}/validity" + data-summary: Verify the valid licenses in a system + data-deprecated: false + data-category: License + data-tag-description: "
    Overview

    The license + endpoints enable you to retrieve the license validity of the systems from + the NetApp Console SaaS application. A valid license is required to activate + NetApp Backup and Recovery on a system, create backups of your production + data, and restore backup data on a production system. This API retrieves + the eligibility of the current license used and returns the days remaining + if you are using a trial license.

    " + data-introduced: '' + - title: Migration + entries: + - title: Validate migration operations + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-migration-validate.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/migration/validate + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/migration/validate" + data-summary: Validate migration operations + data-deprecated: false + data-category: Migration + data-tag-description: '' + data-introduced: '' + - title: Trigger backup migration + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-migration.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/migration + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/migration" + data-summary: Trigger backup migration + data-deprecated: false + data-category: Migration + data-tag-description: '' + data-introduced: '' + - title: Object storage + entries: + - title: Create a bucket for a cloud provider + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-object-storage.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage" + data-summary: Create a bucket for a cloud provider + data-deprecated: false + data-category: Object storage + data-tag-description: '' + data-introduced: '' + - title: Modify bucket properties for a cloud provider + url: "/cbs/put-account-providers-cloudmanager_cbs-api-v1-object-storage.html" + swagger-title: PUT /account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage + data-api-method: PUT + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage" + data-summary: Modify bucket properties for a cloud provider + data-deprecated: false + data-category: Object storage + data-tag-description: '' + data-introduced: '' + - title: Retrieve buckets for a cloud provider + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-object-storage-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage/{provider} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage/{provider}" + data-summary: Retrieve buckets for a cloud provider + data-deprecated: false + data-category: Object storage + data-tag-description: '' + data-introduced: '' + - title: Retrieve a bucket for a cloud provider + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-object-storage-provider.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage/{provider}/{objectStoreName} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage/{provider}/{objectStoreName}" + data-summary: Retrieve a bucket for a cloud provider + data-deprecated: false + data-category: Object storage + data-tag-description: '' + data-introduced: '' + - title: Panoramic protection + entries: + - title: Overview + url: "/cbs/panoramic_protection_overview.html" + - title: Activate comprehensive protection in a system (v1) + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId} + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}" + data-summary: Activate comprehensive protection in a system (v1) + data-deprecated: false + data-category: Panoramic Protection + data-tag-description: "
    Overview

    The Panoramic + Protection API enables you to automate the complete 3-2-1 backup spectrum + using a single control plane to simplify your implementation of the various + components of 3-2-1 model where they are needed, without using multiple + resource managers and assistance from specially trained personnel. You can + configure backups either in a cascading workflow or fan-out workflow. You + can perform the following operations by using the Panoramic Protection endpoints:

    • Enable + 3-2-1 backup on systems by creating the required cluster-peering for replication + and the required object-store buckets for backup to cloud in cascading or + fan-out topologies.

    • Modify 3-2-1 backup on systems by configuring + the setup required for replication or backup to cloud, to create cascading + or fan-out topologies.

    • Create 3-2-1 cascading or fan-out backup + topologies by configuring volume replication and backup to cloud relationship. +

    • Modify or add 3-2-1 backup on volumes by configuring replication + or backup to cloud, to create cascading or fan-out topologies.
    " + data-introduced: '' + - title: Modify the comprehensive protection configuration in a system (v2) + url: "/cbs/put-account-providers-cloudmanager_cbs-api-v2-panoramic-protection-working-environment-.html" + swagger-title: PUT /account/{accountId}/providers/cloudmanager_cbs/api/v2/panoramic-protection/working-environment/{workingEnvironmentId} + data-api-method: PUT + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/panoramic-protection/working-environment/{workingEnvironmentId}" + data-summary: Modify the comprehensive protection configuration in a system + (v2) + data-deprecated: false + data-category: Panoramic Protection + data-tag-description: "
    Overview

    The Panoramic + Protection API enables you to automate the complete 3-2-1 backup spectrum + using a single control plane to simplify your implementation of the various + components of 3-2-1 model where they are needed, without using multiple + resource managers and assistance from specially trained personnel. You can + configure backups either in a cascading workflow or fan-out workflow. You + can perform the following operations by using the Panoramic Protection endpoints:

    • Enable + 3-2-1 backup on systems by creating the required cluster-peering for replication + and the required object-store buckets for backup to cloud in cascading or + fan-out topologies.

    • Modify 3-2-1 backup on systems by configuring + the setup required for replication or backup to cloud, to create cascading + or fan-out topologies.

    • Create 3-2-1 cascading or fan-out backup + topologies by configuring volume replication and backup to cloud relationship. +

    • Modify or add 3-2-1 backup on volumes by configuring replication + or backup to cloud, to create cascading or fan-out topologies.
    " + data-introduced: '' + - title: Enable comprehensive panoramic protection for multiple volumes (v1) + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-volume.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}/volume + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}/volume" + data-summary: Enable comprehensive panoramic protection for multiple volumes + (v1) + data-deprecated: false + data-category: Panoramic Protection + data-tag-description: "
    Overview

    The Panoramic + Protection API enables you to automate the complete 3-2-1 backup spectrum + using a single control plane to simplify your implementation of the various + components of 3-2-1 model where they are needed, without using multiple + resource managers and assistance from specially trained personnel. You can + configure backups either in a cascading workflow or fan-out workflow. You + can perform the following operations by using the Panoramic Protection endpoints:

    • Enable + 3-2-1 backup on systems by creating the required cluster-peering for replication + and the required object-store buckets for backup to cloud in cascading or + fan-out topologies.

    • Modify 3-2-1 backup on systems by configuring + the setup required for replication or backup to cloud, to create cascading + or fan-out topologies.

    • Create 3-2-1 cascading or fan-out backup + topologies by configuring volume replication and backup to cloud relationship. +

    • Modify or add 3-2-1 backup on volumes by configuring replication + or backup to cloud, to create cascading or fan-out topologies.
    " + data-introduced: '' + - title: Modify comprehensive protection for multiple volumes (v1) + url: "/cbs/put-account-providers-cloudmanager_cbs-api-v1-panoramic-protection-working-environment-volume.html" + swagger-title: PUT /account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}/volume + data-api-method: PUT + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}/volume" + data-summary: Modify comprehensive protection for multiple volumes (v1) + data-deprecated: false + data-category: Panoramic Protection + data-tag-description: "
    Overview

    The Panoramic + Protection API enables you to automate the complete 3-2-1 backup spectrum + using a single control plane to simplify your implementation of the various + components of 3-2-1 model where they are needed, without using multiple + resource managers and assistance from specially trained personnel. You can + configure backups either in a cascading workflow or fan-out workflow. You + can perform the following operations by using the Panoramic Protection endpoints:

    • Enable + 3-2-1 backup on systems by creating the required cluster-peering for replication + and the required object-store buckets for backup to cloud in cascading or + fan-out topologies.

    • Modify 3-2-1 backup on systems by configuring + the setup required for replication or backup to cloud, to create cascading + or fan-out topologies.

    • Create 3-2-1 cascading or fan-out backup + topologies by configuring volume replication and backup to cloud relationship. +

    • Modify or add 3-2-1 backup on volumes by configuring replication + or backup to cloud, to create cascading or fan-out topologies.
    " + data-introduced: '' + - title: Ransomware scan + entries: + - title: Overview + url: "/cbs/ransomware_scan_overview.html" + - title: Initiate a ransomware scan + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-ransomware-working-environment-volume-snapshot-.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/ransomware/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId} + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/ransomware/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}" + data-summary: Initiate a ransomware scan + data-deprecated: false + data-category: Ransomware Scan + data-tag-description: "
    Overview

    The Ransomware + scan API endpoint enables you to initiate a ransomware scan on a specified + snapshot available in the cloud object-store bucket. It scans only cloud + backups. It does not support scanning local snapshots. Ransomware attacks + on local snapshots cannot be detected.

    " + data-introduced: '' + - title: Replication + entries: + - title: Overview + url: "/cbs/replication_overview.html" + - title: Perform an action on a volume with SnapMirror replication + url: "/cbs/patch-account-providers-cloudmanager_cbs-api-v1-replication-working-environment-relationship.html" + swagger-title: PATCH /account/{accountId}/providers/cloudmanager_cbs/api/v1/replication/working-environment/{workingEnvironmentId}/relationship + data-api-method: PATCH + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/replication/working-environment/{workingEnvironmentId}/relationship" + data-summary: Perform an action on a volume with SnapMirror replication + data-deprecated: false + data-category: Replication + data-tag-description: "
    Overview

    The Replication + enpoint enables you to perform an action on a volume on which SnapMirror + replication is enabled. Using this API, you will be able to perform a SnapMirror + relationship update, delete, pause, resync, reverse-resync, abort, and resume + functionality on a replicated volume.

    " + data-introduced: '' + - title: Report + entries: + - title: Overview + url: "/cbs/report_overview.html" + - title: Generate an inventory report + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-report.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/report + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/report" + data-summary: Generate an inventory report + data-deprecated: false + data-category: Report + data-tag-description: "
    Overview

    The report endpoints + enable users to create and retrieve an inventory report for the whole account + or a specific list of systems. It is also possible to generate reports for + specific storage VMs under a system. You can perform the following operations + by using the report endpoints:

    • Generate an inventory report

    • Retrieve + inventory reports
    " + data-introduced: '' + - title: Retrieve inventory report data + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-report-job-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/report/job/{jobId} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/report/job/{jobId}" + data-summary: Retrieve inventory report data + data-deprecated: false + data-category: Report + data-tag-description: "
    Overview

    The report endpoints + enable users to create and retrieve an inventory report for the whole account + or a specific list of systems. It is also possible to generate reports for + specific storage VMs under a system. You can perform the following operations + by using the report endpoints:

    • Generate an inventory report

    • Retrieve + inventory reports
    " + data-introduced: '' + - title: Retrieve the local snapshots report + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-report-snapshot-job-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/report/snapshot/job/{jobId} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/report/snapshot/job/{jobId}" + data-summary: Retrieve the local snapshots report + data-deprecated: false + data-category: Report + data-tag-description: "
    Overview

    The report endpoints + enable users to create and retrieve an inventory report for the whole account + or a specific list of systems. It is also possible to generate reports for + specific storage VMs under a system. You can perform the following operations + by using the report endpoints:

    • Generate an inventory report

    • Retrieve + inventory reports
    " + data-introduced: '' + - title: Retrieve replication report data + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-report-replication-job-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/report/replication/job/{jobId} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/report/replication/job/{jobId}" + data-summary: Retrieve replication report data + data-deprecated: false + data-category: Report + data-tag-description: "
    Overview

    The report endpoints + enable users to create and retrieve an inventory report for the whole account + or a specific list of systems. It is also possible to generate reports for + specific storage VMs under a system. You can perform the following operations + by using the report endpoints:

    • Generate an inventory report

    • Retrieve + inventory reports
    " + data-introduced: '' + - title: Restore + entries: + - title: Overview + url: "/cbs/restore_overview.html" + - title: Perform a volume and file-level restore (v2) + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v2-restore.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v2/restore + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/restore" + data-summary: Perform a volume and file-level restore (v2) + data-deprecated: false + data-category: Restore + data-tag-description: "
    Overview

    The restore + endpoints enable you to perform volume, folder and file-level restore operations. + You can perform the following operations by using the Restore endpoints:

    • Restore + volumes, folder, and files.

    • Retrieve volume, folder, and file + restore status.

    " + data-introduced: '' + - title: Perform a volume, file, and folder-level restore operation (v3) + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v3-restore.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v3/restore + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v3/restore" + data-summary: Perform a volume, file, and folder-level restore operation (v3) + data-deprecated: false + data-category: Restore + data-tag-description: "
    Overview

    The restore + endpoints enable you to perform volume, folder and file-level restore operations. + You can perform the following operations by using the Restore endpoints:

    • Restore + volumes, folder, and files.

    • Retrieve volume, folder, and file + restore status.

    " + data-introduced: '' + - title: Revert a snapshot for a volume + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-revert-working-environment-volume-.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/revert/working-environment/{workingEnvironmentId}/volume/{volumeId} + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/revert/working-environment/{workingEnvironmentId}/volume/{volumeId}" + data-summary: Revert a snapshot for a volume + data-deprecated: false + data-category: Restore + data-tag-description: "
    Overview

    The restore + endpoints enable you to perform volume, folder and file-level restore operations. + You can perform the following operations by using the Restore endpoints:

    • Restore + volumes, folder, and files.

    • Retrieve volume, folder, and file + restore status.

    " + data-introduced: '' + - title: SFR + entries: + - title: Overview + url: "/cbs/sfr_overview.html" + - title: Start a file and folder explore operation (v1) + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-file-explore-start.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/file-explore/start + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/file-explore/start" + data-summary: Start a file and folder explore operation (v1) + data-deprecated: false + data-category: SFR + data-tag-description: "
    Overview

    The single file + restore (SFR) endpoints retrieve files from the volume snapshots.

    You + can perform the following operations by using the SFR endpoints:

    • Start + a snapshot backup file explore operation.
    • Retrieve the snapshot + backup file explore status.
    • List files during snapshot backup file + explore operations.

    " + data-introduced: '' + - title: Retrieve a list of files and folders + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-snapshot-file-explore-list.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}/file-explore/list + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}/file-explore/list" + data-summary: Retrieve a list of files and folders + data-deprecated: false + data-category: SFR + data-tag-description: "
    Overview

    The single file + restore (SFR) endpoints retrieve files from the volume snapshots.

    You + can perform the following operations by using the SFR endpoints:

    • Start + a snapshot backup file explore operation.
    • Retrieve the snapshot + backup file explore status.
    • List files during snapshot backup file + explore operations.

    " + data-introduced: '' + - title: Retrieve the file and folder status + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-sfr-working-environment-volume-snapshot-files-status.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}/files/status + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}/files/status" + data-summary: Retrieve the file and folder status + data-deprecated: false + data-category: SFR + data-tag-description: "
    Overview

    The single file + restore (SFR) endpoints retrieve files from the volume snapshots.

    You + can perform the following operations by using the SFR endpoints:

    • Start + a snapshot backup file explore operation.
    • Retrieve the snapshot + backup file explore status.
    • List files during snapshot backup file + explore operations.

    " + data-introduced: '' + - title: StorageGRID + entries: + - title: Overview + url: "/cbs/storagegrid_overview.html" + - title: Retrieve StorageGRID server version + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-version.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/version + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/version" + data-summary: Retrieve StorageGRID server version + data-deprecated: false + data-category: StorageGRID + data-tag-description: "
    Overview

    The StorageGRID + API endpoints retrieve version and other details for the StorageGRID server. + You can also discover StorageGRID WebScale server in the NetApp Console + SaaS application.

    You can perform the following operations by using + the StorageGRID endpoints:

    • Retrieve StorageGRID server version
    • Retrieve + details of the StorageGRID server.
    • Discover or add new StorageGRID + server into the NetApp Console.

    " + data-introduced: '' + - title: Discover a new StorageGRID WebScale server + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/sg + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg" + data-summary: Discover a new StorageGRID WebScale server + data-deprecated: false + data-category: StorageGRID + data-tag-description: "
    Overview

    The StorageGRID + API endpoints retrieve version and other details for the StorageGRID server. + You can also discover StorageGRID WebScale server in the NetApp Console + SaaS application.

    You can perform the following operations by using + the StorageGRID endpoints:

    • Retrieve StorageGRID server version
    • Retrieve + details of the StorageGRID server.
    • Discover or add new StorageGRID + server into the NetApp Console.

    " + data-introduced: '' + - title: Save StorageGRID credentials + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-credentials-working-environment-.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/credentials/working-environment/{workingEnvironmentId} + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/credentials/working-environment/{workingEnvironmentId}" + data-summary: Save StorageGRID credentials + data-deprecated: false + data-category: StorageGRID + data-tag-description: "
    Overview

    The StorageGRID + API endpoints retrieve version and other details for the StorageGRID server. + You can also discover StorageGRID WebScale server in the NetApp Console + SaaS application.

    You can perform the following operations by using + the StorageGRID endpoints:

    • Retrieve StorageGRID server version
    • Retrieve + details of the StorageGRID server.
    • Discover or add new StorageGRID + server into the NetApp Console.

    " + data-introduced: '' + - title: Retrieve a list of StorageGRID buckets + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-buckets.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/buckets + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/buckets" + data-summary: Retrieve a list of StorageGRID buckets + data-deprecated: false + data-category: StorageGRID + data-tag-description: "
    Overview

    The StorageGRID + API endpoints retrieve version and other details for the StorageGRID server. + You can also discover StorageGRID WebScale server in the NetApp Console + SaaS application.

    You can perform the following operations by using + the StorageGRID endpoints:

    • Retrieve StorageGRID server version
    • Retrieve + details of the StorageGRID server.
    • Discover or add new StorageGRID + server into the NetApp Console.

    " + data-introduced: '' + - title: Retrieve details of a bucket from the StorageGRID server + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-sg-buckets-.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/buckets/{bucketName} + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/buckets/{bucketName}" + data-summary: Retrieve details of a bucket from the StorageGRID server + data-deprecated: false + data-category: StorageGRID + data-tag-description: "
    Overview

    The StorageGRID + API endpoints retrieve version and other details for the StorageGRID server. + You can also discover StorageGRID WebScale server in the NetApp Console + SaaS application.

    You can perform the following operations by using + the StorageGRID endpoints:

    • Retrieve StorageGRID server version
    • Retrieve + details of the StorageGRID server.
    • Discover or add new StorageGRID + server into the NetApp Console.

    " + data-introduced: '' + - title: List StorageGRID servers + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v2-sg.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v2/sg + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/sg" + data-summary: List StorageGRID servers + data-deprecated: false + data-category: StorageGRID + data-tag-description: "
    Overview

    The StorageGRID + API endpoints retrieve version and other details for the StorageGRID server. + You can also discover StorageGRID WebScale server in the NetApp Console + SaaS application.

    You can perform the following operations by using + the StorageGRID endpoints:

    • Retrieve StorageGRID server version
    • Retrieve + details of the StorageGRID server.
    • Discover or add new StorageGRID + server into the NetApp Console.

    " + data-introduced: '' + - title: Register new StorageGRID credentials + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v2-sg-credentials.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v2/sg/credentials + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/sg/credentials" + data-summary: Register new StorageGRID credentials + data-deprecated: false + data-category: StorageGRID + data-tag-description: "
    Overview

    The StorageGRID + API endpoints retrieve version and other details for the StorageGRID server. + You can also discover StorageGRID WebScale server in the NetApp Console + SaaS application.

    You can perform the following operations by using + the StorageGRID endpoints:

    • Retrieve StorageGRID server version
    • Retrieve + details of the StorageGRID server.
    • Discover or add new StorageGRID + server into the NetApp Console.

    " + data-introduced: '' + - title: Update StorageGRID credentials + url: "/cbs/put-account-providers-cloudmanager_cbs-api-v2-sg-credentials-.html" + swagger-title: PUT /account/{accountId}/providers/cloudmanager_cbs/api/v2/sg/credentials/{storageServerName} + data-api-method: PUT + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/sg/credentials/{storageServerName}" + data-summary: Update StorageGRID credentials + data-deprecated: false + data-category: StorageGRID + data-tag-description: "
    Overview

    The StorageGRID + API endpoints retrieve version and other details for the StorageGRID server. + You can also discover StorageGRID WebScale server in the NetApp Console + SaaS application.

    You can perform the following operations by using + the StorageGRID endpoints:

    • Retrieve StorageGRID server version
    • Retrieve + details of the StorageGRID server.
    • Discover or add new StorageGRID + server into the NetApp Console.

    " + data-introduced: '' + - title: Delete StorageGRID credentials + url: "/cbs/delete-account-providers-cloudmanager_cbs-api-v2-sg-credentials-.html" + swagger-title: DELETE /account/{accountId}/providers/cloudmanager_cbs/api/v2/sg/credentials/{storageServerName} + data-api-method: DELETE + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/sg/credentials/{storageServerName}" + data-summary: Delete StorageGRID credentials + data-deprecated: false + data-category: StorageGRID + data-tag-description: "
    Overview

    The StorageGRID + API endpoints retrieve version and other details for the StorageGRID server. + You can also discover StorageGRID WebScale server in the NetApp Console + SaaS application.

    You can perform the following operations by using + the StorageGRID endpoints:

    • Retrieve StorageGRID server version
    • Retrieve + details of the StorageGRID server.
    • Discover or add new StorageGRID + server into the NetApp Console.

    " + data-introduced: '' + - title: System + entries: + - title: Overview + url: "/cbs/system_overview.html" + - title: Retrieve ONTAP backup policies + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy" + data-summary: Retrieve ONTAP backup policies + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Create a backup policy + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy" + data-summary: Create a backup policy + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Delete a backup policy + url: "/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-backup-policy-.html" + swagger-title: DELETE /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy/{policyId} + data-api-method: DELETE + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy/{policyId}" + data-summary: Delete a backup policy + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Update a backup policy (v2) + url: "/cbs/put-account-providers-cloudmanager_cbs-api-v2-working-environment-backup-policy.html" + swagger-title: PUT /account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/backup-policy + data-api-method: PUT + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/backup-policy" + data-summary: Update a backup policy (v2) + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Retrieve IP spaces + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-ip-space.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/ip-space + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/ip-space" + data-summary: Retrieve IP spaces + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Retrieve systems + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment" + data-summary: Retrieve systems + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Retrieve system details + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}" + data-summary: Retrieve system details + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Retrieve a list of storage VMs + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v2-working-environment-svm.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/svm + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/svm" + data-summary: Retrieve a list of storage VMs + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Retrieve volumes + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume" + data-summary: Retrieve volumes + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Configure object storage (v2) + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v2-working-environment-configure-object-store.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/configure-object-store + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/configure-object-store" + data-summary: Configure object storage (v2) + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Retrieve system volume directories + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-list.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/list + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/list" + data-summary: Retrieve system volume directories + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Retrieve an object store configuration status + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-object-store-config-status.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/object-store-config/status + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/object-store-config/status" + data-summary: Retrieve an object store configuration status + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: List the snapshot policies associated with a system + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policies.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policies + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policies" + data-summary: List the snapshot policies associated with a system + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Delete a snapshot policy using the UUID + url: "/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policies-.html" + swagger-title: DELETE /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policies/{policyId} + data-api-method: DELETE + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policies/{policyId}" + data-summary: Delete a snapshot policy using the UUID + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Retrieve a list of ONTAP replication policies + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy" + data-summary: Retrieve a list of ONTAP replication policies + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Create a replication policy in a system + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy" + data-summary: Create a replication policy in a system + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Delete a replication policy + url: "/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy-.html" + swagger-title: DELETE /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy/{policyId} + data-api-method: DELETE + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy/{policyId}" + data-summary: Delete a replication policy + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Modify a replication policy in a system + url: "/cbs/patch-account-providers-cloudmanager_cbs-api-v1-working-environment-replication-policy-.html" + swagger-title: PATCH /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy/{policyId} + data-api-method: PATCH + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/replication-policy/{policyId}" + data-summary: Modify a replication policy in a system + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Retrieve a list of ONTAP relationships associated with a system + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-relationship.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/relationship + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/relationship" + data-summary: Retrieve a list of ONTAP relationships associated with a system + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Retrieve a list of ONTAP clusters peered to a system + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-peercluster.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/peercluster + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/peercluster" + data-summary: Retrieve a list of ONTAP clusters peered to a system + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Retrieve a list of snapshot details for a volume + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot" + data-summary: Retrieve a list of snapshot details for a volume + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Create a snapshot for a volume + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot" + data-summary: Create a snapshot for a volume + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Delete a snapshot for a volume + url: "/cbs/delete-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot-.html" + swagger-title: DELETE /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId} + data-api-method: DELETE + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}" + data-summary: Delete a snapshot for a volume + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: List the relationship details associated with a volume SnapMirror replication + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-relationship-.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/relationship/{relationshipId} + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/relationship/{relationshipId}" + data-summary: List the relationship details associated with a volume SnapMirror + replication + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Modify a snapshot policy + url: "/cbs/put-account-providers-cloudmanager_cbs-api-v1-working-environment-volume-snapshot-policy.html" + swagger-title: PUT /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot-policy + data-api-method: PUT + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot-policy" + data-summary: Modify a snapshot policy + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Retrieve a list of schedules in a system + url: "/cbs/get-account-providers-cloudmanager_cbs-api-v1-working-environment-schedules.html" + swagger-title: GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/schedules + data-api-method: GET + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/schedules" + data-summary: Retrieve a list of schedules in a system + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Create a new cron schedule in a system + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-schedules.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/schedules + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/schedules" + data-summary: Create a new cron schedule in a system + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Create a snapshot policy + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policy.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policy + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policy" + data-summary: Create a snapshot policy + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Modify the snapshot policy in a system + url: "/cbs/patch-account-providers-cloudmanager_cbs-api-v1-working-environment-snapshot-policy-.html" + swagger-title: PATCH /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policy/{policyId} + data-api-method: PATCH + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policy/{policyId}" + data-summary: Modify the snapshot policy in a system + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Discover all volumes with relationships for a list of systems + url: "/cbs/post-account-providers-cloudmanager_cbs-api-v2-working-environment-discover-volumes.html" + swagger-title: POST /account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/discover/volumes + data-api-method: POST + data-api-path: "/account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/discover/volumes" + data-summary: Discover all volumes with relationships for a list of systems + data-deprecated: false + data-category: System + data-tag-description: "
    Overview

    The system endpoints + retrieves details of the systems, manage the backup policies and configure + an object store associated with a system.

    You can perform the following + operations by using the system endpoints:

    • Retrieve the list and + details of systems, backup policies, IP spaces, storage VMs, and volumes, + snapshot-policies, peer-cluster relationships, and SnapMirror relationships.

    • Create + a backup policy and configure an object store.

    • List system volume + directories.

    • Modify a backup policy.
    " + data-introduced: '' + - title: Copy and Sync + entries: + - title: Overview + url: "/copysync/overview.html" + - title: Accounts + entries: + - title: Overview + url: "/copysync/accounts_overview.html" + - title: Retrieve the tenancy accounts + url: "/copysync/get-api-accounts.html" + swagger-title: GET /api/accounts + data-api-method: GET + data-api-path: "/api/accounts" + data-summary: Retrieve the tenancy accounts + data-deprecated: false + data-category: Accounts + data-tag-description: |- +
    Overview + The accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations. + The following actions can be performed with the accounts endpoints: +
      +
    • Retrieve account statistics information
      • +
    • Add a BYOL license
      • +
    • Retrieve a list of NSS credentials associated with an account
      • +
    • Retrieve license information of an account
      • +
    • Update subscription information (using the /register API call)
      • +
    +
    + data-introduced: '' + - title: Delete the current account + url: "/copysync/delete-api-accounts.html" + swagger-title: DELETE /api/accounts + data-api-method: DELETE + data-api-path: "/api/accounts" + data-summary: Delete the current account + data-deprecated: false + data-category: Accounts + data-tag-description: |- +
    Overview + The accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations. + The following actions can be performed with the accounts endpoints: +
      +
    • Retrieve account statistics information
      • +
    • Add a BYOL license
      • +
    • Retrieve a list of NSS credentials associated with an account
      • +
    • Retrieve license information of an account
      • +
    • Update subscription information (using the /register API call)
      • +
    +
    + data-introduced: '' + - title: Retrieve the account information + url: "/copysync/get-api-accounts-info.html" + swagger-title: GET /api/accounts/info + data-api-method: GET + data-api-path: "/api/accounts/info" + data-summary: Retrieve the account information + data-deprecated: false + data-category: Accounts + data-tag-description: |- +
    Overview + The accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations. + The following actions can be performed with the accounts endpoints: +
      +
    • Retrieve account statistics information
      • +
    • Add a BYOL license
      • +
    • Retrieve a list of NSS credentials associated with an account
      • +
    • Retrieve license information of an account
      • +
    • Update subscription information (using the /register API call)
      • +
    +
    + data-introduced: '' + - title: Register an account to a marketplace + url: "/copysync/put-api-accounts-register.html" + swagger-title: PUT /api/accounts/register + data-api-method: PUT + data-api-path: "/api/accounts/register" + data-summary: Register an account to a marketplace + data-deprecated: false + data-category: Accounts + data-tag-description: |- +
    Overview + The accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations. + The following actions can be performed with the accounts endpoints: +
      +
    • Retrieve account statistics information
      • +
    • Add a BYOL license
      • +
    • Retrieve a list of NSS credentials associated with an account
      • +
    • Retrieve license information of an account
      • +
    • Update subscription information (using the /register API call)
      • +
    +
    + data-introduced: '' + - title: Retrieve the logged-in account's relationship status + url: "/copysync/get-api-accounts-relationships-stats.html" + swagger-title: GET /api/accounts/relationships-stats + data-api-method: GET + data-api-path: "/api/accounts/relationships-stats" + data-summary: Retrieve the logged-in accounts relationship status + data-deprecated: false + data-category: Accounts + data-tag-description: |- +
    Overview + The accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations. + The following actions can be performed with the accounts endpoints: +
      +
    • Retrieve account statistics information
      • +
    • Add a BYOL license
      • +
    • Retrieve a list of NSS credentials associated with an account
      • +
    • Retrieve license information of an account
      • +
    • Update subscription information (using the /register API call)
      • +
    +
    + data-introduced: '' + - title: Add NetApp support site credentials + url: "/copysync/put-api-v2-accounts-nss-credentials.html" + swagger-title: PUT /api/v2/accounts/{accountId}/nss-credentials + data-api-method: PUT + data-api-path: "/api/v2/accounts/{accountId}/nss-credentials" + data-summary: Add NetApp support site credentials + data-deprecated: true + data-category: Accounts + data-tag-description: |- +
    Overview + The accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations. + The following actions can be performed with the accounts endpoints: +
      +
    • Retrieve account statistics information
      • +
    • Add a BYOL license
      • +
    • Retrieve a list of NSS credentials associated with an account
      • +
    • Retrieve license information of an account
      • +
    • Update subscription information (using the /register API call)
      • +
    +
    + data-introduced: '' + - title: Retrieve NetApp support site credentials + url: "/copysync/get-api-v2-accounts-nss-credentials.html" + swagger-title: GET /api/v2/accounts/{accountId}/nss-credentials + data-api-method: GET + data-api-path: "/api/v2/accounts/{accountId}/nss-credentials" + data-summary: Retrieve NetApp support site credentials + data-deprecated: false + data-category: Accounts + data-tag-description: |- +
    Overview + The accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations. + The following actions can be performed with the accounts endpoints: +
      +
    • Retrieve account statistics information
      • +
    • Add a BYOL license
      • +
    • Retrieve a list of NSS credentials associated with an account
      • +
    • Retrieve license information of an account
      • +
    • Update subscription information (using the /register API call)
      • +
    +
    + data-introduced: '' + - title: Add a license + url: "/copysync/put-api-accounts-licenses-v2.html" + swagger-title: PUT /api/accounts/{accountId}/licenses-v2 + data-api-method: PUT + data-api-path: "/api/accounts/{accountId}/licenses-v2" + data-summary: Add a license + data-deprecated: false + data-category: Accounts + data-tag-description: |- +
    Overview + The accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations. + The following actions can be performed with the accounts endpoints: +
      +
    • Retrieve account statistics information
      • +
    • Add a BYOL license
      • +
    • Retrieve a list of NSS credentials associated with an account
      • +
    • Retrieve license information of an account
      • +
    • Update subscription information (using the /register API call)
      • +
    +
    + data-introduced: '' + - title: Retrieve a list of all licenses + url: "/copysync/get-api-accounts-licenses.html" + swagger-title: GET /api/accounts/licenses + data-api-method: GET + data-api-path: "/api/accounts/licenses" + data-summary: Retrieve a list of all licenses + data-deprecated: false + data-category: Accounts + data-tag-description: |- +
    Overview + The accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations. + The following actions can be performed with the accounts endpoints: +
      +
    • Retrieve account statistics information
      • +
    • Add a BYOL license
      • +
    • Retrieve a list of NSS credentials associated with an account
      • +
    • Retrieve license information of an account
      • +
    • Update subscription information (using the /register API call)
      • +
    +
    + data-introduced: '' + - title: Retrieve license settings + url: "/copysync/get-api-accounts-license-settings.html" + swagger-title: GET /api/accounts/license-settings + data-api-method: GET + data-api-path: "/api/accounts/license-settings" + data-summary: Retrieve license settings + data-deprecated: false + data-category: Accounts + data-tag-description: |- +
    Overview + The accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations. + The following actions can be performed with the accounts endpoints: +
      +
    • Retrieve account statistics information
      • +
    • Add a BYOL license
      • +
    • Retrieve a list of NSS credentials associated with an account
      • +
    • Retrieve license information of an account
      • +
    • Update subscription information (using the /register API call)
      • +
    +
    + data-introduced: '' + - title: Delete a license serial number + url: "/copysync/delete-api-accounts-licenses-v2-.html" + swagger-title: DELETE /api/accounts/{accountId}/licenses-v2/{serialNumber} + data-api-method: DELETE + data-api-path: "/api/accounts/{accountId}/licenses-v2/{serialNumber}" + data-summary: Delete a license serial number + data-deprecated: false + data-category: Accounts + data-tag-description: |- +
    Overview + The accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations. + The following actions can be performed with the accounts endpoints: +
      +
    • Retrieve account statistics information
      • +
    • Add a BYOL license
      • +
    • Retrieve a list of NSS credentials associated with an account
      • +
    • Retrieve license information of an account
      • +
    • Update subscription information (using the /register API call)
      • +
    +
    + data-introduced: '' + - title: Delete NetApp support site credentials + url: "/copysync/delete-api-v2-accounts-nss-credentials-v2-.html" + swagger-title: DELETE /api/v2/accounts/{accountId}/nss-credentials/v2/{nssKeyId} + data-api-method: DELETE + data-api-path: "/api/v2/accounts/{accountId}/nss-credentials/v2/{nssKeyId}" + data-summary: Delete NetApp support site credentials + data-deprecated: true + data-category: Accounts + data-tag-description: |- +
    Overview + The accounts endpoints provide information about the identity of the user's tenancy account. The endpoints enable you to receive information about licensing ( PAYGO or CONTRACT subscriptions from Microsoft Azure, AWS marketplace, or bring your own license (BYOL from NetApp) and perform licensing-related operations. + The following actions can be performed with the accounts endpoints: +
      +
    • Retrieve account statistics information
      • +
    • Add a BYOL license
      • +
    • Retrieve a list of NSS credentials associated with an account
      • +
    • Retrieve license information of an account
      • +
    • Update subscription information (using the /register API call)
      • +
    +
    + data-introduced: '' + - title: Data brokers + entries: + - title: Overview + url: "/copysync/data_brokers_overview.html" + - title: Retrieve all the data brokers + url: "/copysync/get-api-data-brokers.html" + swagger-title: GET /api/data-brokers + data-api-method: GET + data-api-path: "/api/data-brokers" + data-summary: Retrieve all the data brokers + data-deprecated: false + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Create a new installer for the NetApp data broker instance + url: "/copysync/post-api-data-brokers.html" + swagger-title: POST /api/data-brokers + data-api-method: POST + data-api-path: "/api/data-brokers" + data-summary: Create a new installer for the NetApp data broker instance + data-deprecated: false + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Delete an existing NetApp data broker + url: "/copysync/delete-api-data-brokers-.html" + swagger-title: DELETE /api/data-brokers/{id} + data-api-method: DELETE + data-api-path: "/api/data-brokers/{id}" + data-summary: Delete an existing NetApp data broker + data-deprecated: false + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Restart a data broker + url: "/copysync/put-api-accounts-data-brokers-restart.html" + swagger-title: PUT /api/accounts/{accountId}/data-brokers/{id}/restart + data-api-method: PUT + data-api-path: "/api/accounts/{accountId}/data-brokers/{id}/restart" + data-summary: Restart a data broker + data-deprecated: false + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Update the proxy configuration for a data broker + url: "/copysync/put-api-accounts-data-brokers-proxy.html" + swagger-title: PUT /api/accounts/{accountId}/data-brokers/{id}/proxy + data-api-method: PUT + data-api-path: "/api/accounts/{accountId}/data-brokers/{id}/proxy" + data-summary: Update the proxy configuration for a data broker + data-deprecated: false + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Move the data broker between groups + url: "/copysync/put-api-accounts-data-brokers-move.html" + swagger-title: PUT /api/accounts/{accountId}/data-brokers/{id}/move + data-api-method: PUT + data-api-path: "/api/accounts/{accountId}/data-brokers/{id}/move" + data-summary: Move the data broker between groups + data-deprecated: false + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the CIFS shares + url: "/copysync/get-api-data-brokers-list-cifs-shares.html" + swagger-title: GET /api/data-brokers/{id}/list-cifs-shares + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-cifs-shares" + data-summary: Retrieve the CIFS shares + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the CIFS server folders + url: "/copysync/get-api-data-brokers-list-cifs-share-folders.html" + swagger-title: GET /api/data-brokers/{id}/list-cifs-share-folders + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-cifs-share-folders" + data-summary: Retrieve the CIFS server folders + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the NFS server folders + url: "/copysync/get-api-data-brokers-list-nfs-exports.html" + swagger-title: GET /api/data-brokers/{id}/list-nfs-exports + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-nfs-exports" + data-summary: Retrieve the NFS server folders + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the NFS server folders by ID + url: "/copysync/get-api-data-brokers-list-nfs-export-folders.html" + swagger-title: GET /api/data-brokers/{id}/list-nfs-export-folders + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-nfs-export-folders" + data-summary: Retrieve the NFS server folders by ID + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the S3 buckets + url: "/copysync/get-api-data-brokers-list-s3-buckets.html" + swagger-title: GET /api/data-brokers/{id}/list-s3-buckets + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-s3-buckets" + data-summary: Retrieve the S3 buckets + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the S3 bucket folders + url: "/copysync/get-api-data-brokers-list-s3-bucket-folders.html" + swagger-title: GET /api/data-brokers/{id}/list-s3-bucket-folders + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-s3-bucket-folders" + data-summary: Retrieve the S3 bucket folders + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the StorageGRID buckets + url: "/copysync/get-api-data-brokers-list-sgws-buckets.html" + swagger-title: GET /api/data-brokers/{id}/list-sgws-buckets + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-sgws-buckets" + data-summary: Retrieve the StorageGRID buckets + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the StorageGRID bucket folders + url: "/copysync/get-api-data-brokers-list-sgws-bucket-folders.html" + swagger-title: GET /api/data-brokers/{id}/list-sgws-bucket-folders + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-sgws-bucket-folders" + data-summary: Retrieve the StorageGRID bucket folders + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the IBM buckets + url: "/copysync/get-api-data-brokers-list-ibm-buckets.html" + swagger-title: GET /api/data-brokers/{id}/list-ibm-buckets + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-ibm-buckets" + data-summary: Retrieve the IBM buckets + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the IBM bucket folders + url: "/copysync/get-api-data-brokers-list-ibm-bucket-folders.html" + swagger-title: GET /api/data-brokers/{id}/list-ibm-bucket-folders + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-ibm-bucket-folders" + data-summary: Retrieve the IBM bucket folders + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the ONTAP S3 buckets + url: "/copysync/get-api-data-brokers-list-ontap-s3-buckets.html" + swagger-title: GET /api/data-brokers/{id}/list-ontap-s3-buckets + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-ontap-s3-buckets" + data-summary: Retrieve the ONTAP S3 buckets + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the ONTAP S3 bucket folders + url: "/copysync/get-api-data-brokers-list-ontap-s3-bucket-folders.html" + swagger-title: GET /api/data-brokers/{id}/list-ontap-s3-bucket-folders + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-ontap-s3-bucket-folders" + data-summary: Retrieve the ONTAP S3 bucket folders + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the Alibaba buckets + url: "/copysync/get-api-data-brokers-list-alibaba-buckets.html" + swagger-title: GET /api/data-brokers/{id}/list-alibaba-buckets + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-alibaba-buckets" + data-summary: Retrieve the Alibaba buckets + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the Alibaba bucket folders + url: "/copysync/get-api-data-brokers-list-alibaba-bucket-folders.html" + swagger-title: GET /api/data-brokers/{id}/list-alibaba-bucket-folders + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-alibaba-bucket-folders" + data-summary: Retrieve the Alibaba bucket folders + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the Azure blob storage containers + url: "/copysync/get-api-data-brokers-list-azure-blob-storage-containers.html" + swagger-title: GET /api/data-brokers/{id}/list-azure-blob-storage-containers + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-azure-blob-storage-containers" + data-summary: Retrieve the Azure blob storage containers + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the Azure blob storage container folders + url: "/copysync/get-api-data-brokers-list-azure-blob-storage-container-folders.html" + swagger-title: GET /api/data-brokers/{id}/list-azure-blob-storage-container-folders + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-azure-blob-storage-container-folders" + data-summary: Retrieve the Azure blob storage container folders + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the Google Cloud buckets + url: "/copysync/get-api-data-brokers-list-gcp-buckets.html" + swagger-title: GET /api/data-brokers/{id}/list-gcp-buckets + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-gcp-buckets" + data-summary: Retrieve the Google Cloud buckets + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the Google Cloud bucket folders + url: "/copysync/get-api-data-brokers-list-gcp-bucket-folders.html" + swagger-title: GET /api/data-brokers/{id}/list-gcp-bucket-folders + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-gcp-bucket-folders" + data-summary: Retrieve the Google Cloud bucket folders + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the AWS KMS keys + url: "/copysync/get-api-data-brokers-list-aws-kms-keys.html" + swagger-title: GET /api/data-brokers/{id}/list-aws-kms-keys + data-api-method: GET + data-api-path: "/api/data-brokers/{id}/list-aws-kms-keys" + data-summary: Retrieve the AWS KMS keys + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the S3 private links + url: "/copysync/get-api-accounts-data-brokers-list-s3-private-links.html" + swagger-title: GET /api/accounts/{accountId}/data-brokers/{id}/list-s3-private-links + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/data-brokers/{id}/list-s3-private-links" + data-summary: Retrieve the S3 private links + data-deprecated: true + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Retrieve the data broker local configuration + url: "/copysync/get-api-accounts-data-brokers-local-configuration.html" + swagger-title: GET /api/accounts/{accountId}/data-brokers/{id}/local-configuration + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/data-brokers/{id}/local-configuration" + data-summary: Retrieve the data broker local configuration + data-deprecated: false + data-category: Data Brokers + data-tag-description: |- +
    Overview + The data brokers endpoints provide information about the data brokers in an account and enable you to perform various operations on the data brokers. + The following actions can be performed with the data brokers endpoints: +
      +
    • Retrieve data broker information (including type, groupId, address, operating system, node version , VPC, Vnet, and more)
      • +
    • Delete a data broker
      • +
    • Restart a data broker
      • +
    • Change a data broker's proxy configuration
      • +
    • Move a data broker between groups
      • +
    • Retrieve data broker's local configuration
      • +
    +

    There are a few deprecated API calls to use a data broker to retrieve information from the customer network utilizing the network permissions, such as list S3 buckets, list CIFS shares, and more.
    + The deprecated operations are as follows:

    +
      +
    • List S3 buckets
      • +
    • List CIFS shares
      • +
    • List NFS exports
      • +
    • List Azure containers
      • +
    • List NFS export folders
      • +
    • List CIFS share folders
      • +
    • List S3 buckets folders
      • +
    • List StorageGRID buckets
      • +
    • List StorageGRID bucket folders
      • +
    • List IBM buckets
      • +
    • List IBM bucket folders
      • +
    • List ONTAP S3 buckets
      • +
    • List ONTAP S3 bucket folders
      • +
    • List KMS keys
      • +
    • List S3 private endpoints
      • +
    • List Google buckets
      • +
    • List Google bucket folders
      • +
    +
    + data-introduced: '' + - title: Groups + entries: + - title: Overview + url: "/copysync/groups_overview.html" + - title: Retrieve all groups + url: "/copysync/get-api-groups.html" + swagger-title: GET /api/groups + data-api-method: GET + data-api-path: "/api/groups" + data-summary: Retrieve all groups + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Download the data broker group logs + url: "/copysync/put-api-groups-download-data-brokers-logs.html" + swagger-title: PUT /api/groups/{id}/download-data-brokers-logs + data-api-method: PUT + data-api-path: "/api/groups/{id}/download-data-brokers-logs" + data-summary: Download the data broker group logs + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Modify the group settings + url: "/copysync/put-api-accounts-groups-settings.html" + swagger-title: PUT /api/accounts/{accountId}/groups/{id}/settings + data-api-method: PUT + data-api-path: "/api/accounts/{accountId}/groups/{id}/settings" + data-summary: Modify the group settings + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the SFTP root directory + url: "/copysync/get-api-accounts-groups-list-sftp-root-directory.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-sftp-root-directory + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-sftp-root-directory" + data-summary: Retrieve the SFTP root directory + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the SFTP server folders + url: "/copysync/get-api-accounts-groups-list-sftp-directories.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-sftp-directories + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-sftp-directories" + data-summary: Retrieve the SFTP server folders + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the CIFS shares + url: "/copysync/get-api-accounts-groups-list-cifs-shares.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-cifs-shares + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-cifs-shares" + data-summary: Retrieve the CIFS shares + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the CIFS server folders + url: "/copysync/get-api-accounts-groups-list-cifs-share-folders.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-cifs-share-folders + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-cifs-share-folders" + data-summary: Retrieve the CIFS server folders + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the NFS server exports + url: "/copysync/get-api-accounts-groups-list-nfs-exports.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-nfs-exports + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-nfs-exports" + data-summary: Retrieve the NFS server exports + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the NFS server folders + url: "/copysync/get-api-accounts-groups-list-nfs-export-folders.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-nfs-export-folders + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-nfs-export-folders" + data-summary: Retrieve the NFS server folders + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the AWS KMS keys + url: "/copysync/get-api-accounts-groups-list-aws-kms-keys.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-aws-kms-keys + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-aws-kms-keys" + data-summary: Retrieve the AWS KMS keys + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the S3 buckets + url: "/copysync/get-api-accounts-groups-list-s3-buckets.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-s3-buckets + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-s3-buckets" + data-summary: Retrieve the S3 buckets + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the S3 bucket folders + url: "/copysync/get-api-accounts-groups-list-s3-bucket-folders.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-s3-bucket-folders + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-s3-bucket-folders" + data-summary: Retrieve the S3 bucket folders + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the StorageGRID buckets + url: "/copysync/get-api-accounts-groups-list-sgws-buckets.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-sgws-buckets + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-sgws-buckets" + data-summary: Retrieve the StorageGRID buckets + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the StorageGRID bucket folders + url: "/copysync/get-api-accounts-groups-list-sgws-bucket-folders.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-sgws-bucket-folders + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-sgws-bucket-folders" + data-summary: Retrieve the StorageGRID bucket folders + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the ONTAP S3 buckets + url: "/copysync/get-api-accounts-groups-list-ontap-s3-buckets.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-ontap-s3-buckets + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-ontap-s3-buckets" + data-summary: Retrieve the ONTAP S3 buckets + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the ONTAP S3 bucket folders + url: "/copysync/get-api-accounts-groups-list-ontap-s3-bucket-folders.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-ontap-s3-bucket-folders + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-ontap-s3-bucket-folders" + data-summary: Retrieve the ONTAP S3 bucket folders + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the IBM buckets + url: "/copysync/get-api-accounts-groups-list-ibm-buckets.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-ibm-buckets + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-ibm-buckets" + data-summary: Retrieve the IBM buckets + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the IBM bucket folders + url: "/copysync/get-api-accounts-groups-list-ibm-bucket-folders.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-ibm-bucket-folders + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-ibm-bucket-folders" + data-summary: Retrieve the IBM bucket folders + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the Alibaba buckets + url: "/copysync/get-api-accounts-groups-list-alibaba-buckets.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-alibaba-buckets + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-alibaba-buckets" + data-summary: Retrieve the Alibaba buckets + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the Alibaba bucket folders + url: "/copysync/get-api-accounts-groups-list-alibaba-bucket-folders.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-alibaba-bucket-folders + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-alibaba-bucket-folders" + data-summary: Retrieve the Alibaba bucket folders + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the Azure blob storage containers + url: "/copysync/get-api-accounts-groups-list-azure-blob-storage-containers.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-azure-blob-storage-containers + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-azure-blob-storage-containers" + data-summary: Retrieve the Azure blob storage containers + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the Azure blob storage container folders + url: "/copysync/get-api-accounts-groups-list-azure-blob-storage-container-folders.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-azure-blob-storage-container-folders + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-azure-blob-storage-container-folders" + data-summary: Retrieve the Azure blob storage container folders + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the Azure Data Lake Gen2 storage containers + url: "/copysync/get-api-accounts-groups-list-azure-datalake-storage-containers.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-azure-dataLake-storage-containers + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-azure-dataLake-storage-containers" + data-summary: Retrieve the Azure Data Lake Gen2 storage containers + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the Azure Data Lake Gen2 storage container folders + url: "/copysync/get-api-accounts-groups-list-azure-datalake-storage-container-folders.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-azure-dataLake-storage-container-folders + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-azure-dataLake-storage-container-folders" + data-summary: Retrieve the Azure Data Lake Gen2 storage container folders + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the Google Cloud buckets + url: "/copysync/get-api-accounts-groups-list-gcp-buckets.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-gcp-buckets + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-gcp-buckets" + data-summary: Retrieve the Google Cloud buckets + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the Google Cloud bucket folders + url: "/copysync/get-api-accounts-groups-list-gcp-bucket-folders.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-gcp-bucket-folders + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-gcp-bucket-folders" + data-summary: Retrieve the Google Cloud bucket folders + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the Google Cloud KMS keys + url: "/copysync/get-api-accounts-groups-list-gcp-kms-keys.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-gcp-kms-keys + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-gcp-kms-keys" + data-summary: Retrieve the Google Cloud KMS keys + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the Google Drives + url: "/copysync/get-api-accounts-groups-list-google-drives.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-google-drives + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-google-drives" + data-summary: Retrieve the Google Drives + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the Google Drive folders + url: "/copysync/get-api-accounts-groups-list-google-drive-folders.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-google-drive-folders + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-google-drive-folders" + data-summary: Retrieve the Google Drive folders + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the Box API root folder + url: "/copysync/get-api-accounts-groups-list-box-root-folder.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-box-root-folder + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-box-root-folder" + data-summary: Retrieve the Box API root folder + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the Box API server folders + url: "/copysync/get-api-accounts-groups-list-box-folders.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-box-folders + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-box-folders" + data-summary: Retrieve the Box API server folders + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Retrieve the S3 private links + url: "/copysync/get-api-accounts-groups-list-s3-private-links.html" + swagger-title: GET /api/accounts/{accountId}/groups/{id}/list-s3-private-links + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/groups/{id}/list-s3-private-links" + data-summary: Retrieve the S3 private links + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Delete a data broker group + url: "/copysync/delete-api-accounts-groups-.html" + swagger-title: DELETE /api/accounts/{accountId}/groups/{id} + data-api-method: DELETE + data-api-path: "/api/accounts/{accountId}/groups/{id}" + data-summary: Delete a data broker group + data-deprecated: false + data-category: Groups + data-tag-description: |- +
    Overview + The groups endpoints provide information about the data broker groups in an account and enable you to manage the groups. + The following actions can be performed with the data broker groups endpoints: +
      +
    • Retrieve data broker group information (information on the group configuration and each data broker in the group)
      • +
    • Download data broker group logs (download logs from each data broker in the group)
      • +
    • Change data broker group configuration - control the number of processes and concurrency in the data brokers
      • +
    • Delete a data broker group
      • +
    • Use the data broker group to perform various asynchronous operations such as:
      • +
    • List S3 buckets
      • +
    • List NFS exports
      • +
    • List SMB shares
      • +
    • List SFTP directories
      • +
    • List AWS KMS keys
      • +
    • List StorageGRID buckets
      • +
    • List IBM buckets
      • +
    • List ONTAP S3 buckets
      • +
    • List Azure storage account containers
      • +
    • List Google drives
      • +
    • List S3 private links
      • +
    +
    + data-introduced: '' + - title: Messages + entries: + - title: Overview + url: "/copysync/messages_overview.html" + - title: Retrieve the asynchronous messages + url: "/copysync/get-api-messages-client.html" + swagger-title: GET /api/messages/client + data-api-method: GET + data-api-path: "/api/messages/client" + data-summary: Retrieve the asynchronous messages + data-deprecated: false + data-category: Messages + data-tag-description: |- +
    Overview + The messages endpoint sends user information, received by performing asynchronous operations, such as listing an S3 bucket, listing shares, and listing exports, to a client. +

    The API call process involves the following steps:

    +
      +
    1. Execute the API endpoint initially without using the “last” query parameter. The API response will include an ID field value.
      2. +
    2. Subsequently, execute the API endpoint using the ID field value obtained after performing Step 1.
      3. +
    +
    + data-introduced: '' + - title: Relationships + entries: + - title: Overview + url: "/copysync/relationships_overview.html" + - title: Retrieve all relationships + url: "/copysync/get-api-relationships-v2.html" + swagger-title: GET /api/relationships-v2 + data-api-method: GET + data-api-path: "/api/relationships-v2" + data-summary: Retrieve all relationships + data-deprecated: false + data-category: Relationships + data-tag-description: |- +
    Overview + The relationships endpoints provide information about the sync relationships between source and target destinations in an account and enable you to perform various operations to manage the sync relationships. + The following actions can be performed with the relationships endpoints: +
      +
    • Retrieve sync relationship information (including statistics)
      • +
    • Create a sync relationship
      • +
    • Delete a sync relationship
      • +
    • Change sync relationship settings
      • +
    • Start a new sync on a relationship
      • +
    • Stop a sync operation
      • +
    • Update relationship endpoint credentials
      • +
    • Update relationship tags
      • +
    • Retrieve the identifier of the sync relationship (without all other properties)
      • +
    +
    + data-introduced: '' + - title: Create a new relationship + url: "/copysync/post-api-relationships-v2.html" + swagger-title: POST /api/relationships-v2 + data-api-method: POST + data-api-path: "/api/relationships-v2" + data-summary: Create a new relationship + data-deprecated: false + data-category: Relationships + data-tag-description: |- +
    Overview + The relationships endpoints provide information about the sync relationships between source and target destinations in an account and enable you to perform various operations to manage the sync relationships. + The following actions can be performed with the relationships endpoints: +
      +
    • Retrieve sync relationship information (including statistics)
      • +
    • Create a sync relationship
      • +
    • Delete a sync relationship
      • +
    • Change sync relationship settings
      • +
    • Start a new sync on a relationship
      • +
    • Stop a sync operation
      • +
    • Update relationship endpoint credentials
      • +
    • Update relationship tags
      • +
    • Retrieve the identifier of the sync relationship (without all other properties)
      • +
    +
    + data-introduced: '' + - title: Retrieve a relationship + url: "/copysync/get-api-relationships-v2-.html" + swagger-title: GET /api/relationships-v2/{id} + data-api-method: GET + data-api-path: "/api/relationships-v2/{id}" + data-summary: Retrieve a relationship + data-deprecated: false + data-category: Relationships + data-tag-description: |- +
    Overview + The relationships endpoints provide information about the sync relationships between source and target destinations in an account and enable you to perform various operations to manage the sync relationships. + The following actions can be performed with the relationships endpoints: +
      +
    • Retrieve sync relationship information (including statistics)
      • +
    • Create a sync relationship
      • +
    • Delete a sync relationship
      • +
    • Change sync relationship settings
      • +
    • Start a new sync on a relationship
      • +
    • Stop a sync operation
      • +
    • Update relationship endpoint credentials
      • +
    • Update relationship tags
      • +
    • Retrieve the identifier of the sync relationship (without all other properties)
      • +
    +
    + data-introduced: '' + - title: Update the settings for a relationship + url: "/copysync/put-api-relationships-v2-.html" + swagger-title: PUT /api/relationships-v2/{id} + data-api-method: PUT + data-api-path: "/api/relationships-v2/{id}" + data-summary: Update the settings for a relationship + data-deprecated: false + data-category: Relationships + data-tag-description: |- +
    Overview + The relationships endpoints provide information about the sync relationships between source and target destinations in an account and enable you to perform various operations to manage the sync relationships. + The following actions can be performed with the relationships endpoints: +
      +
    • Retrieve sync relationship information (including statistics)
      • +
    • Create a sync relationship
      • +
    • Delete a sync relationship
      • +
    • Change sync relationship settings
      • +
    • Start a new sync on a relationship
      • +
    • Stop a sync operation
      • +
    • Update relationship endpoint credentials
      • +
    • Update relationship tags
      • +
    • Retrieve the identifier of the sync relationship (without all other properties)
      • +
    +
    + data-introduced: '' + - title: Delete an existing relationship + url: "/copysync/delete-api-relationships-.html" + swagger-title: DELETE /api/relationships/{id} + data-api-method: DELETE + data-api-path: "/api/relationships/{id}" + data-summary: Delete an existing relationship + data-deprecated: true + data-category: Relationships + data-tag-description: |- +
    Overview + The relationships endpoints provide information about the sync relationships between source and target destinations in an account and enable you to perform various operations to manage the sync relationships. + The following actions can be performed with the relationships endpoints: +
      +
    • Retrieve sync relationship information (including statistics)
      • +
    • Create a sync relationship
      • +
    • Delete a sync relationship
      • +
    • Change sync relationship settings
      • +
    • Start a new sync on a relationship
      • +
    • Stop a sync operation
      • +
    • Update relationship endpoint credentials
      • +
    • Update relationship tags
      • +
    • Retrieve the identifier of the sync relationship (without all other properties)
      • +
    +
    + data-introduced: '' + - title: Delete relationships + url: "/copysync/delete-api-v2-accounts-relationships.html" + swagger-title: DELETE /api/v2/accounts/{accountId}/relationships + data-api-method: DELETE + data-api-path: "/api/v2/accounts/{accountId}/relationships" + data-summary: Delete relationships + data-deprecated: false + data-category: Relationships + data-tag-description: |- +
    Overview + The relationships endpoints provide information about the sync relationships between source and target destinations in an account and enable you to perform various operations to manage the sync relationships. + The following actions can be performed with the relationships endpoints: +
      +
    • Retrieve sync relationship information (including statistics)
      • +
    • Create a sync relationship
      • +
    • Delete a sync relationship
      • +
    • Change sync relationship settings
      • +
    • Start a new sync on a relationship
      • +
    • Stop a sync operation
      • +
    • Update relationship endpoint credentials
      • +
    • Update relationship tags
      • +
    • Retrieve the identifier of the sync relationship (without all other properties)
      • +
    +
    + data-introduced: '' + - title: Initiate a relationship data sync + url: "/copysync/put-api-relationships-sync.html" + swagger-title: PUT /api/relationships/{id}/sync + data-api-method: PUT + data-api-path: "/api/relationships/{id}/sync" + data-summary: Initiate a relationship data sync + data-deprecated: false + data-category: Relationships + data-tag-description: |- +
    Overview + The relationships endpoints provide information about the sync relationships between source and target destinations in an account and enable you to perform various operations to manage the sync relationships. + The following actions can be performed with the relationships endpoints: +
      +
    • Retrieve sync relationship information (including statistics)
      • +
    • Create a sync relationship
      • +
    • Delete a sync relationship
      • +
    • Change sync relationship settings
      • +
    • Start a new sync on a relationship
      • +
    • Stop a sync operation
      • +
    • Update relationship endpoint credentials
      • +
    • Update relationship tags
      • +
    • Retrieve the identifier of the sync relationship (without all other properties)
      • +
    +
    + data-introduced: '' + - title: Stop the relationship data sync + url: "/copysync/put-api-relationships-abort.html" + swagger-title: PUT /api/relationships/{id}/abort + data-api-method: PUT + data-api-path: "/api/relationships/{id}/abort" + data-summary: Stop the relationship data sync + data-deprecated: false + data-category: Relationships + data-tag-description: |- +
    Overview + The relationships endpoints provide information about the sync relationships between source and target destinations in an account and enable you to perform various operations to manage the sync relationships. + The following actions can be performed with the relationships endpoints: +
      +
    • Retrieve sync relationship information (including statistics)
      • +
    • Create a sync relationship
      • +
    • Delete a sync relationship
      • +
    • Change sync relationship settings
      • +
    • Start a new sync on a relationship
      • +
    • Stop a sync operation
      • +
    • Update relationship endpoint credentials
      • +
    • Update relationship tags
      • +
    • Retrieve the identifier of the sync relationship (without all other properties)
      • +
    +
    + data-introduced: '' + - title: Retrieve the relationship endpoints + url: "/copysync/get-api-accounts-relationships-end-points.html" + swagger-title: GET /api/accounts/{accountId}/relationships/end-points + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/relationships/end-points" + data-summary: Retrieve the relationship endpoints + data-deprecated: false + data-category: Relationships + data-tag-description: |- +
    Overview + The relationships endpoints provide information about the sync relationships between source and target destinations in an account and enable you to perform various operations to manage the sync relationships. + The following actions can be performed with the relationships endpoints: +
      +
    • Retrieve sync relationship information (including statistics)
      • +
    • Create a sync relationship
      • +
    • Delete a sync relationship
      • +
    • Change sync relationship settings
      • +
    • Start a new sync on a relationship
      • +
    • Stop a sync operation
      • +
    • Update relationship endpoint credentials
      • +
    • Update relationship tags
      • +
    • Retrieve the identifier of the sync relationship (without all other properties)
      • +
    +
    + data-introduced: '' + - title: Modify the source or target credentials + url: "/copysync/put-api-accounts-relationships-credentials.html" + swagger-title: PUT /api/accounts/{accountId}/relationships/{id}/credentials + data-api-method: PUT + data-api-path: "/api/accounts/{accountId}/relationships/{id}/credentials" + data-summary: Modify the source or target credentials + data-deprecated: false + data-category: Relationships + data-tag-description: |- +
    Overview + The relationships endpoints provide information about the sync relationships between source and target destinations in an account and enable you to perform various operations to manage the sync relationships. + The following actions can be performed with the relationships endpoints: +
      +
    • Retrieve sync relationship information (including statistics)
      • +
    • Create a sync relationship
      • +
    • Delete a sync relationship
      • +
    • Change sync relationship settings
      • +
    • Start a new sync on a relationship
      • +
    • Stop a sync operation
      • +
    • Update relationship endpoint credentials
      • +
    • Update relationship tags
      • +
    • Retrieve the identifier of the sync relationship (without all other properties)
      • +
    +
    + data-introduced: '' + - title: Edit the relationship tags + url: "/copysync/put-api-accounts-relationships-tags.html" + swagger-title: PUT /api/accounts/{accountId}/relationships/{id}/tags + data-api-method: PUT + data-api-path: "/api/accounts/{accountId}/relationships/{id}/tags" + data-summary: Edit the relationship tags + data-deprecated: false + data-category: Relationships + data-tag-description: |- +
    Overview + The relationships endpoints provide information about the sync relationships between source and target destinations in an account and enable you to perform various operations to manage the sync relationships. + The following actions can be performed with the relationships endpoints: +
      +
    • Retrieve sync relationship information (including statistics)
      • +
    • Create a sync relationship
      • +
    • Delete a sync relationship
      • +
    • Change sync relationship settings
      • +
    • Start a new sync on a relationship
      • +
    • Stop a sync operation
      • +
    • Update relationship endpoint credentials
      • +
    • Update relationship tags
      • +
    • Retrieve the identifier of the sync relationship (without all other properties)
      • +
    +
    + data-introduced: '' + - title: Reports + entries: + - title: Overview + url: "/copysync/reports_overview.html" + - title: Create a new report + url: "/copysync/post-api-accounts-reports.html" + swagger-title: POST /api/accounts/{accountId}/reports + data-api-method: POST + data-api-path: "/api/accounts/{accountId}/reports" + data-summary: Create a new report + data-deprecated: false + data-category: Reports + data-tag-description: |- +
    Overview + The report endpoints enable you to view reports of NetApp Console account such as the number of directories and files in an account, the distribution of file size, the depth and breadth of the directories, and more. You can also create or delete a report by using the report endpoints. + The following actions can be performed with the report endpoints: +
      +
    • Retrieve reports (including statistics of an account)
      • +
    • Create a report
      • +
    • Delete a report
      • +
    • Abort a report
      • +
    +
    + data-introduced: '' + - title: Retrieve a list of all reports + url: "/copysync/get-api-accounts-reports.html" + swagger-title: GET /api/accounts/{accountId}/reports + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/reports" + data-summary: Retrieve a list of all reports + data-deprecated: false + data-category: Reports + data-tag-description: |- +
    Overview + The report endpoints enable you to view reports of NetApp Console account such as the number of directories and files in an account, the distribution of file size, the depth and breadth of the directories, and more. You can also create or delete a report by using the report endpoints. + The following actions can be performed with the report endpoints: +
      +
    • Retrieve reports (including statistics of an account)
      • +
    • Create a report
      • +
    • Delete a report
      • +
    • Abort a report
      • +
    +
    + data-introduced: '' + - title: Delete the reports by a specified report ID + url: "/copysync/delete-api-accounts-reports.html" + swagger-title: DELETE /api/accounts/{accountId}/reports + data-api-method: DELETE + data-api-path: "/api/accounts/{accountId}/reports" + data-summary: Delete the reports by a specified report ID + data-deprecated: false + data-category: Reports + data-tag-description: |- +
    Overview + The report endpoints enable you to view reports of NetApp Console account such as the number of directories and files in an account, the distribution of file size, the depth and breadth of the directories, and more. You can also create or delete a report by using the report endpoints. + The following actions can be performed with the report endpoints: +
      +
    • Retrieve reports (including statistics of an account)
      • +
    • Create a report
      • +
    • Delete a report
      • +
    • Abort a report
      • +
    +
    + data-introduced: '' + - title: Retrieve a list of the reports endpoints + url: "/copysync/get-api-accounts-reports-end-points.html" + swagger-title: GET /api/accounts/{accountId}/reports/end-points + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/reports/end-points" + data-summary: Retrieve a list of the reports endpoints + data-deprecated: false + data-category: Reports + data-tag-description: |- +
    Overview + The report endpoints enable you to view reports of NetApp Console account such as the number of directories and files in an account, the distribution of file size, the depth and breadth of the directories, and more. You can also create or delete a report by using the report endpoints. + The following actions can be performed with the report endpoints: +
      +
    • Retrieve reports (including statistics of an account)
      • +
    • Create a report
      • +
    • Delete a report
      • +
    • Abort a report
      • +
    +
    + data-introduced: '' + - title: Retrieve a report by a specified ID + url: "/copysync/get-api-accounts-reports-.html" + swagger-title: GET /api/accounts/{accountId}/reports/{id} + data-api-method: GET + data-api-path: "/api/accounts/{accountId}/reports/{id}" + data-summary: Retrieve a report by a specified ID + data-deprecated: false + data-category: Reports + data-tag-description: |- +
    Overview + The report endpoints enable you to view reports of NetApp Console account such as the number of directories and files in an account, the distribution of file size, the depth and breadth of the directories, and more. You can also create or delete a report by using the report endpoints. + The following actions can be performed with the report endpoints: +
      +
    • Retrieve reports (including statistics of an account)
      • +
    • Create a report
      • +
    • Delete a report
      • +
    • Abort a report
      • +
    +
    + data-introduced: '' + - title: Storages + entries: + - title: Overview + url: "/copysync/storages_overview.html" + - title: Retrieve the storage type + url: "/copysync/get-api-storages-.html" + swagger-title: GET /api/storages/{protocol} + data-api-method: GET + data-api-path: "/api/storages/{protocol}" + data-summary: Retrieve the storage type + data-deprecated: false + data-category: Storages + data-tag-description: |- +
    Overview + The storages endpoints provide information about the different source and target locations. + This API category displays only the endpoints that are part of a sync relationship in an account. +

    You can retrieve the following information by using the storages API endpoints:

    +
      +
    • NFS hosts IP addresses
      • +
    • SMB hosts IP addresses
      • +
    • Azure storage accounts
      • +
    • SFTP hosts IP addresses
      • +
    • IBM hosts IP addresses
      • +
    • StorageGRID hosts IP addresses
      • +
    • Azure NetApp Files IP addresses
      • +
    • Cloud Volumes ONTAP, On-premises, FSx Data LIF IP addresses
      • +
    • ONTAP S3 endpoint IP addresses
      • +
    • Amazon Elastic File System IP addresses
      • +
    • Box app names
      • +
    • Google drive subjects
      • +
    +
    + data-introduced: '' + - title: Timelines + entries: + - title: Overview + url: "/copysync/timelines_overview.html" + - title: Retrieve timelines + url: "/copysync/get-api-timelines.html" + swagger-title: GET /api/timelines + data-api-method: GET + data-api-path: "/api/timelines" + data-summary: Retrieve timelines + data-deprecated: true + data-category: Timelines + data-tag-description: |- +
    Overview + The timelines endpoints provide information about historic operations in an account (for example, create a relationship, sync relationships, and abort a relationship). + The timelines API endpoints are deprecated; use the Audit service API to view your historic account-related operations. +
    + data-introduced: '' + - title: Credentials + entries: + - title: Overview + url: "/credential/overview.html" + - title: AWS + entries: + - title: Overview + url: "/credential/aws_overview.html" + - title: Create credentials + url: "/credential/post-accounts-aws-assume-role.html" + swagger-title: POST /accounts/{accountPublicId}/aws/assume-role + data-api-method: POST + data-api-path: "/accounts/{accountPublicId}/aws/assume-role" + data-summary: Create credentials + data-deprecated: false + data-category: AWS + data-tag-description: | +
    + Overview +

    The AWS endpoints manage Amazon Resource Name (ARN) credentials.

    +

    You can perform the following actions with the AWS endpoints:

    +
      +
    • Create ARN credentials
      • +
    • Update ARN credentials
      • +
    • Retrieve ARN credentials
      • +
    +
    + data-introduced: '' + - title: Update credentials + url: "/credential/patch-accounts-aws-assume-role-.html" + swagger-title: PATCH /accounts/{accountPublicId}/aws/assume-role/{credentialsId} + data-api-method: PATCH + data-api-path: "/accounts/{accountPublicId}/aws/assume-role/{credentialsId}" + data-summary: Update credentials + data-deprecated: false + data-category: AWS + data-tag-description: | +
    + Overview +

    The AWS endpoints manage Amazon Resource Name (ARN) credentials.

    +

    You can perform the following actions with the AWS endpoints:

    +
      +
    • Create ARN credentials
      • +
    • Update ARN credentials
      • +
    • Retrieve ARN credentials
      • +
    +
    + data-introduced: '' + - title: Retrieve credentials using the ID + url: "/credential/get-accounts-aws-assume-role-.html" + swagger-title: GET /accounts/{accountPublicId}/aws/assume-role/{credentialsId} + data-api-method: GET + data-api-path: "/accounts/{accountPublicId}/aws/assume-role/{credentialsId}" + data-summary: Retrieve credentials using the ID + data-deprecated: false + data-category: AWS + data-tag-description: | +
    + Overview +

    The AWS endpoints manage Amazon Resource Name (ARN) credentials.

    +

    You can perform the following actions with the AWS endpoints:

    +
      +
    • Create ARN credentials
      • +
    • Update ARN credentials
      • +
    • Retrieve ARN credentials
      • +
    +
    + data-introduced: '' + - title: Azure + entries: + - title: Overview + url: "/credential/azure_overview.html" + - title: Add service principal credentials + url: "/credential/post-accounts-azure-service-principal.html" + swagger-title: POST /accounts/{accountPublicId}/azure/service-principal + data-api-method: POST + data-api-path: "/accounts/{accountPublicId}/azure/service-principal" + data-summary: Add service principal credentials + data-deprecated: false + data-category: Azure + data-tag-description: | +
    + Overview +

    The Azure endpoints manage and encrypt Microsoft Azure service principal credentials.

    +

    You can perform the following actions with the Azure endpoints:

    +
      +
    • Create service principal credentials
      • +
    • Update service principal credentials
      • +
    • Retrieve service principal credentials
      • +
    • Generate a token from a credentials ID
      • +
    • Generate a token from Azure credentials
      • +
    +
    + data-introduced: '' + - title: Update service principal credentials + url: "/credential/patch-accounts-azure-service-principal-.html" + swagger-title: PATCH /accounts/{accountPublicId}/azure/service-principal/{credentialsId} + data-api-method: PATCH + data-api-path: "/accounts/{accountPublicId}/azure/service-principal/{credentialsId}" + data-summary: Update service principal credentials + data-deprecated: false + data-category: Azure + data-tag-description: | +
    + Overview +

    The Azure endpoints manage and encrypt Microsoft Azure service principal credentials.

    +

    You can perform the following actions with the Azure endpoints:

    +
      +
    • Create service principal credentials
      • +
    • Update service principal credentials
      • +
    • Retrieve service principal credentials
      • +
    • Generate a token from a credentials ID
      • +
    • Generate a token from Azure credentials
      • +
    +
    + data-introduced: '' + - title: Retrieve credentials by ID + url: "/credential/get-accounts-azure-service-principal-.html" + swagger-title: GET /accounts/{accountPublicId}/azure/service-principal/{credentialsId} + data-api-method: GET + data-api-path: "/accounts/{accountPublicId}/azure/service-principal/{credentialsId}" + data-summary: Retrieve credentials by ID + data-deprecated: false + data-category: Azure + data-tag-description: | +
    + Overview +

    The Azure endpoints manage and encrypt Microsoft Azure service principal credentials.

    +

    You can perform the following actions with the Azure endpoints:

    +
      +
    • Create service principal credentials
      • +
    • Update service principal credentials
      • +
    • Retrieve service principal credentials
      • +
    • Generate a token from a credentials ID
      • +
    • Generate a token from Azure credentials
      • +
    +
    + data-introduced: '' + - title: Generate token from ID + url: "/credential/get-accounts-azure-service-principal-generate-token.html" + swagger-title: GET /accounts/{accountPublicId}/azure/service-principal/{credentialsId}/generate-token + data-api-method: GET + data-api-path: "/accounts/{accountPublicId}/azure/service-principal/{credentialsId}/generate-token" + data-summary: Generate token from ID + data-deprecated: false + data-category: Azure + data-tag-description: | +
    + Overview +

    The Azure endpoints manage and encrypt Microsoft Azure service principal credentials.

    +

    You can perform the following actions with the Azure endpoints:

    +
      +
    • Create service principal credentials
      • +
    • Update service principal credentials
      • +
    • Retrieve service principal credentials
      • +
    • Generate a token from a credentials ID
      • +
    • Generate a token from Azure credentials
      • +
    +
    + data-introduced: '' + - title: Generate Azure token + url: "/credential/post-azure-generate-token.html" + swagger-title: POST /azure/generate-token + data-api-method: POST + data-api-path: "/azure/generate-token" + data-summary: Generate Azure token + data-deprecated: false + data-category: Azure + data-tag-description: | +
    + Overview +

    The Azure endpoints manage and encrypt Microsoft Azure service principal credentials.

    +

    You can perform the following actions with the Azure endpoints:

    +
      +
    • Create service principal credentials
      • +
    • Update service principal credentials
      • +
    • Retrieve service principal credentials
      • +
    • Generate a token from a credentials ID
      • +
    • Generate a token from Azure credentials
      • +
    +
    + data-introduced: '' + - title: Generic + entries: + - title: Overview + url: "/credential/generic_overview.html" + - title: Add generic credentials + url: "/credential/post-accounts-credentials.html" + swagger-title: POST /accounts/{accountPublicId}/credentials + data-api-method: POST + data-api-path: "/accounts/{accountPublicId}/credentials" + data-summary: Add generic credentials + data-deprecated: false + data-category: Generic + data-tag-description: | +
    Overview +

    The generic endpoints manage and encrypt any type of credentials.

    +

    You can perform the following actions with the generic endpoints:

    +
      +
    • Create generic credentials
      • +
    • Retrieve generic credentials
      • +
    • Update generic credentials
      • +
    • Delete generic credentials
      • +
    • Retrieve generic credentials by credentials ID
      • +
    +
    + data-introduced: '' + - title: Retrieve credentials by type + url: "/credential/get-accounts-credentials.html" + swagger-title: GET /accounts/{accountPublicId}/credentials + data-api-method: GET + data-api-path: "/accounts/{accountPublicId}/credentials" + data-summary: Retrieve credentials by type + data-deprecated: false + data-category: Generic + data-tag-description: | +
    Overview +

    The generic endpoints manage and encrypt any type of credentials.

    +

    You can perform the following actions with the generic endpoints:

    +
      +
    • Create generic credentials
      • +
    • Retrieve generic credentials
      • +
    • Update generic credentials
      • +
    • Delete generic credentials
      • +
    • Retrieve generic credentials by credentials ID
      • +
    +
    + data-introduced: '' + - title: Update generic credentials + url: "/credential/patch-accounts-credentials-.html" + swagger-title: PATCH /accounts/{accountPublicId}/credentials/{credentialsId} + data-api-method: PATCH + data-api-path: "/accounts/{accountPublicId}/credentials/{credentialsId}" + data-summary: Update generic credentials + data-deprecated: false + data-category: Generic + data-tag-description: | +
    Overview +

    The generic endpoints manage and encrypt any type of credentials.

    +

    You can perform the following actions with the generic endpoints:

    +
      +
    • Create generic credentials
      • +
    • Retrieve generic credentials
      • +
    • Update generic credentials
      • +
    • Delete generic credentials
      • +
    • Retrieve generic credentials by credentials ID
      • +
    +
    + data-introduced: '' + - title: Delete credentials + url: "/credential/delete-accounts-credentials-.html" + swagger-title: DELETE /accounts/{accountPublicId}/credentials/{credentialsId} + data-api-method: DELETE + data-api-path: "/accounts/{accountPublicId}/credentials/{credentialsId}" + data-summary: Delete credentials + data-deprecated: false + data-category: Generic + data-tag-description: | +
    Overview +

    The generic endpoints manage and encrypt any type of credentials.

    +

    You can perform the following actions with the generic endpoints:

    +
      +
    • Create generic credentials
      • +
    • Retrieve generic credentials
      • +
    • Update generic credentials
      • +
    • Delete generic credentials
      • +
    • Retrieve generic credentials by credentials ID
      • +
    +
    + data-introduced: '' + - title: Retrieve credentials by ID + url: "/credential/get-accounts-credentials-.html" + swagger-title: GET /accounts/{accountPublicId}/credentials/{credentialsId} + data-api-method: GET + data-api-path: "/accounts/{accountPublicId}/credentials/{credentialsId}" + data-summary: Retrieve credentials by ID + data-deprecated: false + data-category: Generic + data-tag-description: | +
    Overview +

    The generic endpoints manage and encrypt any type of credentials.

    +

    You can perform the following actions with the generic endpoints:

    +
      +
    • Create generic credentials
      • +
    • Retrieve generic credentials
      • +
    • Update generic credentials
      • +
    • Delete generic credentials
      • +
    • Retrieve generic credentials by credentials ID
      • +
    +
    + data-introduced: '' + - title: Licenses and subscriptions + entries: + - title: Overview + url: "/dw/overview.html" + - title: Data services + entries: + - title: Overview + url: "/dw/data_services_overview.html" + - title: Retrieve data service eligibility details + url: "/dw/get-license-data-service-eligibility-account-provider-.html" + swagger-title: GET /license/data-service-eligibility/account/{accountId}/provider/{cloudProvider} + data-api-method: GET + data-api-path: "/license/data-service-eligibility/account/{accountId}/provider/{cloudProvider}" + data-summary: Retrieve data service eligibility details + data-deprecated: false + data-category: Data Services + data-tag-description: | +
    + Overview +

    The data services endpoints retrieve data service information that is managed in the NetApp Console.

    +

    You can perform the following actions with the data services endpoints:

    +
      +
    • Read eligibility details of an account for a data service
      • +
    +
    + data-introduced: '' + - title: External services + entries: + - title: Overview + url: "/dw/external_services_overview.html" + - title: Retrieve on-prem ONTAP data + url: "/dw/get-license-onprem-account-clusters.html" + swagger-title: GET /license/onPrem/account/{accountId}/clusters + data-api-method: GET + data-api-path: "/license/onPrem/account/{accountId}/clusters" + data-summary: Retrieve on-prem ONTAP data + data-deprecated: false + data-category: External Services + data-tag-description: |- +
    + Overview +

    The external services endpoints retrieve data from external services that display in the NetApp Console.

    +

    You can perform the following actions with the external services endpoints:

    +
      +
    • Read on-premises (on-prem) ONTAP cluster data.
      • +
    +
    + data-introduced: '' + - title: License + entries: + - title: Overview + url: "/dw/license_overview.html" + - title: Associate a license + url: "/dw/post-license-serial-number-.html" + swagger-title: POST /license/serial-number/{serialNumber} + data-api-method: POST + data-api-path: "/license/serial-number/{serialNumber}" + data-summary: Associate a license + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints manage the licenses for end users.
    + This includes monitoring the expiration and capacity usage of end-user licenses.

    +

    A license is a collection of the following information:

    +
      +
    • License serial number (such as 481000495)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    • License type (such as BACKUP)
      • +
    • Permitted capacity
      • +
    • Expiration date
      • +
    +
    + data-introduced: '' + - title: Update a license by serial number + url: "/dw/patch-license-serial-number-.html" + swagger-title: PATCH /license/serial-number/{serialNumber} + data-api-method: PATCH + data-api-path: "/license/serial-number/{serialNumber}" + data-summary: Update a license by serial number + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints manage the licenses for end users.
    + This includes monitoring the expiration and capacity usage of end-user licenses.

    +

    A license is a collection of the following information:

    +
      +
    • License serial number (such as 481000495)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    • License type (such as BACKUP)
      • +
    • Permitted capacity
      • +
    • Expiration date
      • +
    +
    + data-introduced: '' + - title: Delete a license + url: "/dw/delete-license-serial-number-.html" + swagger-title: DELETE /license/serial-number/{serialNumber} + data-api-method: DELETE + data-api-path: "/license/serial-number/{serialNumber}" + data-summary: Delete a license + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints manage the licenses for end users.
    + This includes monitoring the expiration and capacity usage of end-user licenses.

    +

    A license is a collection of the following information:

    +
      +
    • License serial number (such as 481000495)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    • License type (such as BACKUP)
      • +
    • Permitted capacity
      • +
    • Expiration date
      • +
    +
    + data-introduced: '' + - title: Associate extra-capacity per-node licenses with a Cloud Volumes ONTAP + system + url: "/dw/post-license-extra-capacity-licenses-cvoid-.html" + swagger-title: POST /license/extra-capacity-licenses/cvoId/{cvoId} + data-api-method: POST + data-api-path: "/license/extra-capacity-licenses/cvoId/{cvoId}" + data-summary: Associate extra-capacity per-node licenses with a Cloud Volumes + ONTAP system + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints manage the licenses for end users.
    + This includes monitoring the expiration and capacity usage of end-user licenses.

    +

    A license is a collection of the following information:

    +
      +
    • License serial number (such as 481000495)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    • License type (such as BACKUP)
      • +
    • Permitted capacity
      • +
    • Expiration date
      • +
    +
    + data-introduced: '' + - title: Retrieve a license by type + url: "/dw/get-license-licenses.html" + swagger-title: GET /license/licenses + data-api-method: GET + data-api-path: "/license/licenses" + data-summary: Retrieve a license by type + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints manage the licenses for end users.
    + This includes monitoring the expiration and capacity usage of end-user licenses.

    +

    A license is a collection of the following information:

    +
      +
    • License serial number (such as 481000495)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    • License type (such as BACKUP)
      • +
    • Permitted capacity
      • +
    • Expiration date
      • +
    +
    + data-introduced: '' + - title: Update a license by resource ID + url: "/dw/patch-license-account-licenseresource-.html" + swagger-title: PATCH /license/account/{accountId}/licenseResource/{resourceIdentifier} + data-api-method: PATCH + data-api-path: "/license/account/{accountId}/licenseResource/{resourceIdentifier}" + data-summary: Update a license by resource ID + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints manage the licenses for end users.
    + This includes monitoring the expiration and capacity usage of end-user licenses.

    +

    A license is a collection of the following information:

    +
      +
    • License serial number (such as 481000495)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    • License type (such as BACKUP)
      • +
    • Permitted capacity
      • +
    • Expiration date
      • +
    +
    + data-introduced: '' + - title: Delete a license by resource ID + url: "/dw/delete-license-account-licenseresource-.html" + swagger-title: DELETE /license/account/{accountId}/licenseResource/{resourceIdentifier} + data-api-method: DELETE + data-api-path: "/license/account/{accountId}/licenseResource/{resourceIdentifier}" + data-summary: Delete a license by resource ID + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints manage the licenses for end users.
    + This includes monitoring the expiration and capacity usage of end-user licenses.

    +

    A license is a collection of the following information:

    +
      +
    • License serial number (such as 481000495)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    • License type (such as BACKUP)
      • +
    • Permitted capacity
      • +
    • Expiration date
      • +
    +
    + data-introduced: '' + - title: Exchange a Cloud Volumes ONTAP license + url: "/dw/post-license-exchange.html" + swagger-title: POST /license/exchange + data-api-method: POST + data-api-path: "/license/exchange" + data-summary: Exchange a Cloud Volumes ONTAP license + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints manage the licenses for end users.
    + This includes monitoring the expiration and capacity usage of end-user licenses.

    +

    A license is a collection of the following information:

    +
      +
    • License serial number (such as 481000495)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    • License type (such as BACKUP)
      • +
    • Permitted capacity
      • +
    • Expiration date
      • +
    +
    + data-introduced: '' + - title: Update all licenses under an organization ID + url: "/dw/patch-license-account-licenses.html" + swagger-title: PATCH /license/account/{accountId}/licenses + data-api-method: PATCH + data-api-path: "/license/account/{accountId}/licenses" + data-summary: Update all licenses under an organization ID + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints manage the licenses for end users.
    + This includes monitoring the expiration and capacity usage of end-user licenses.

    +

    A license is a collection of the following information:

    +
      +
    • License serial number (such as 481000495)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    • License type (such as BACKUP)
      • +
    • Permitted capacity
      • +
    • Expiration date
      • +
    +
    + data-introduced: '' + - title: Subscription + entries: + - title: Overview + url: "/dw/subscription_overview.html" + - title: Register a subscription + url: "/dw/post-license-account-subscriptions-.html" + swagger-title: POST /license/account/{accountId}/subscriptions/{subscriptionId} + data-api-method: POST + data-api-path: "/license/account/{accountId}/subscriptions/{subscriptionId}" + data-summary: Register a subscription + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Retrieve all subscriptions for an account + url: "/dw/get-license-account-subscriptions.html" + swagger-title: GET /license/account/{accountId}/subscriptions + data-api-method: GET + data-api-path: "/license/account/{accountId}/subscriptions" + data-summary: Retrieve all subscriptions for an account + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Update a subscription expiration date using the subscription ID + url: "/dw/patch-license-subscriptions-.html" + swagger-title: PATCH /license/subscriptions/{subscriptionId} + data-api-method: PATCH + data-api-path: "/license/subscriptions/{subscriptionId}" + data-summary: Update a subscription expiration date using the subscription + ID + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Delete a subscription using the subscription ID + url: "/dw/delete-license-account-subscription-.html" + swagger-title: DELETE /license/account/{accountId}/subscription/{subscriptionId} + data-api-method: DELETE + data-api-path: "/license/account/{accountId}/subscription/{subscriptionId}" + data-summary: Delete a subscription using the subscription ID + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Retrieve the subscription entitlements + url: "/dw/get-license-subscriptions-entitlements.html" + swagger-title: GET /license/subscriptions/entitlements + data-api-method: GET + data-api-path: "/license/subscriptions/entitlements" + data-summary: Retrieve the subscription entitlements + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Retrieve subscription information for an account + url: "/dw/get-license-subscriptions-account-.html" + swagger-title: GET /license/subscriptions/account/{accountId} + data-api-method: GET + data-api-path: "/license/subscriptions/account/{accountId}" + data-summary: Retrieve subscription information for an account + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Delete a subscription using the account ID + url: "/dw/delete-license-subscriptions-account-.html" + swagger-title: DELETE /license/subscriptions/account/{accountId} + data-api-method: DELETE + data-api-path: "/license/subscriptions/account/{accountId}" + data-summary: Delete a subscription using the account ID + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Associate a subscription + url: "/dw/post-license-subscriptions-account-.html" + swagger-title: POST /license/subscriptions/account/{accountId} + data-api-method: POST + data-api-path: "/license/subscriptions/account/{accountId}" + data-summary: Associate a subscription + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Retrieve subscription information using the subscription ID (deprecated) + url: "/dw/get-license-subscriptions-subscription-.html" + swagger-title: GET /license/subscriptions/subscription/{subscriptionId} + data-api-method: GET + data-api-path: "/license/subscriptions/subscription/{subscriptionId}" + data-summary: Retrieve subscription information using the subscription ID + (deprecated) + data-deprecated: true + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Update a subscription expiration date (deprecated) + url: "/dw/patch-license-subscriptions-subscription-.html" + swagger-title: PATCH /license/subscriptions/subscription/{subscriptionId} + data-api-method: PATCH + data-api-path: "/license/subscriptions/subscription/{subscriptionId}" + data-summary: Update a subscription expiration date (deprecated) + data-deprecated: true + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Delete a subscription using the subscription ID (deprecated) + url: "/dw/delete-license-subscriptions-account-subscription-.html" + swagger-title: DELETE /license/subscriptions/account/{accountId}/subscription/{subscriptionId} + data-api-method: DELETE + data-api-path: "/license/subscriptions/account/{accountId}/subscription/{subscriptionId}" + data-summary: Delete a subscription using the subscription ID (deprecated) + data-deprecated: true + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Associate a subscription (deprecated) + url: "/dw/post-license-subscriptions-subscription-account-.html" + swagger-title: POST /license/subscriptions/subscription/{subscriptionId}/account/{accountId} + data-api-method: POST + data-api-path: "/license/subscriptions/subscription/{subscriptionId}/account/{accountId}" + data-summary: Associate a subscription (deprecated) + data-deprecated: true + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Retrieve subscription information using the subscription ID + url: "/dw/get-license-subscriptions-subscription.html" + swagger-title: GET /license/subscriptions/subscription + data-api-method: GET + data-api-path: "/license/subscriptions/subscription" + data-summary: Retrieve subscription information using the subscription ID + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Update a subscription expiration date + url: "/dw/patch-license-subscriptions-subscription.html" + swagger-title: PATCH /license/subscriptions/subscription + data-api-method: PATCH + data-api-path: "/license/subscriptions/subscription" + data-summary: Update a subscription expiration date + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Retrieve the preferred subscription ID for an account + url: "/dw/get-license-account-subscriptions-preferred.html" + swagger-title: GET /license/account/{accountId}/subscriptions/preferred + data-api-method: GET + data-api-path: "/license/account/{accountId}/subscriptions/preferred" + data-summary: Retrieve the preferred subscription ID for an account + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Update the preferred subscription ID for an account + url: "/dw/put-license-account-subscriptions-preferred.html" + swagger-title: PUT /license/account/{accountId}/subscriptions/preferred + data-api-method: PUT + data-api-path: "/license/account/{accountId}/subscriptions/preferred" + data-summary: Update the preferred subscription ID for an account + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Retrieve subscription configuration information + url: "/dw/get-license-subscriptions-configuration.html" + swagger-title: GET /license/subscriptions/configuration + data-api-method: GET + data-api-path: "/license/subscriptions/configuration" + data-summary: Retrieve subscription configuration information + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Set the subscription configuration + url: "/dw/patch-license-subscriptions-configuration.html" + swagger-title: PATCH /license/subscriptions/configuration + data-api-method: PATCH + data-api-path: "/license/subscriptions/configuration" + data-summary: Set the subscription configuration + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Retrieve the associated subscription ID for cloud accounts + url: "/dw/get-license-subscriptions-cloud-account-association.html" + swagger-title: GET /license/subscriptions/cloud-account/association + data-api-method: GET + data-api-path: "/license/subscriptions/cloud-account/association" + data-summary: Retrieve the associated subscription ID for cloud accounts + data-deprecated: false + data-category: Subscription + data-tag-description: | +
    + Overview +

    The subscription endpoints manage the subscriptions to NetApp Console services for end users.
    + The endpoints register a specified subscription with the Console and associate it with the identity and access management service.

    +

    A subscription for the Console services is a collection of the following:

    +
      +
    • Subscription ID (such as 666777, A-S000003969)
      • +
    • Subscription type (such as Keystone)
      • +
    • Expiration date (such as 20251109)
      • +
    • Last modified (such as 2021-11-09 00:00:00)
      • +
    • Resource identifier (such as license-481000495-6897991f-f83f-41c1-b151-eb62073e57be), used internally
      • +
    +

    The subscription endpoints support the Create-Read-Update-Delete (CRUD) operation on the subscription and subscription_resource tables based on the subscription ID.

    +

    Each license or subscription that is managed by the Console has a resource identifier in the identity and access management service that associates it with an account.

    +

    You can perform the following actions with the subscription endpoints:

    +
      +
    • Read, create, update, or delete a subscription.
      • +
    +
    + data-introduced: '' + - title: Federation + entries: + - title: Overview + url: "/federation/overview.html" + - title: Domain + entries: + - title: Overview + url: "/federation/domain_overview.html" + - title: List domains + url: "/federation/get-organizations-domains.html" + swagger-title: GET /organizations/{organization_id}/domains + data-api-method: GET + data-api-path: "/organizations/{organization_id}/domains" + data-summary: List domains + data-deprecated: false + data-category: Domain + data-tag-description: |- + The domain endpoints enable you to verify ownership of a domain name. All domains that don't match your user's email address must be verified. + + You can perform the following actions using the domain endpoints: +
      +
    • List domains
      • +
    • Create a domain
      • +
    • Delete a domain
      • +
    • Retrieve a domain
      • +
    • Update a domain
      • +
    + data-introduced: '' + - title: Create a domain + url: "/federation/post-organizations-domains.html" + swagger-title: POST /organizations/{organization_id}/domains + data-api-method: POST + data-api-path: "/organizations/{organization_id}/domains" + data-summary: Create a domain + data-deprecated: false + data-category: Domain + data-tag-description: |- + The domain endpoints enable you to verify ownership of a domain name. All domains that don't match your user's email address must be verified. + + You can perform the following actions using the domain endpoints: +
      +
    • List domains
      • +
    • Create a domain
      • +
    • Delete a domain
      • +
    • Retrieve a domain
      • +
    • Update a domain
      • +
    + data-introduced: '' + - title: Delete a domain + url: "/federation/delete-organizations-domains-.html" + swagger-title: DELETE /organizations/{organization_id}/domains/{domain_id} + data-api-method: DELETE + data-api-path: "/organizations/{organization_id}/domains/{domain_id}" + data-summary: Delete a domain + data-deprecated: false + data-category: Domain + data-tag-description: |- + The domain endpoints enable you to verify ownership of a domain name. All domains that don't match your user's email address must be verified. + + You can perform the following actions using the domain endpoints: +
      +
    • List domains
      • +
    • Create a domain
      • +
    • Delete a domain
      • +
    • Retrieve a domain
      • +
    • Update a domain
      • +
    + data-introduced: '' + - title: Retrieve a domain + url: "/federation/get-organizations-domains-.html" + swagger-title: GET /organizations/{organization_id}/domains/{domain_id} + data-api-method: GET + data-api-path: "/organizations/{organization_id}/domains/{domain_id}" + data-summary: Retrieve a domain + data-deprecated: false + data-category: Domain + data-tag-description: |- + The domain endpoints enable you to verify ownership of a domain name. All domains that don't match your user's email address must be verified. + + You can perform the following actions using the domain endpoints: +
      +
    • List domains
      • +
    • Create a domain
      • +
    • Delete a domain
      • +
    • Retrieve a domain
      • +
    • Update a domain
      • +
    + data-introduced: '' + - title: Update a domain + url: "/federation/patch-organizations-domains-.html" + swagger-title: PATCH /organizations/{organization_id}/domains/{domain_id} + data-api-method: PATCH + data-api-path: "/organizations/{organization_id}/domains/{domain_id}" + data-summary: Update a domain + data-deprecated: false + data-category: Domain + data-tag-description: |- + The domain endpoints enable you to verify ownership of a domain name. All domains that don't match your user's email address must be verified. + + You can perform the following actions using the domain endpoints: +
      +
    • List domains
      • +
    • Create a domain
      • +
    • Delete a domain
      • +
    • Retrieve a domain
      • +
    • Update a domain
      • +
    + data-introduced: '' + - title: Federation + entries: + - title: Overview + url: "/federation/federation_overview.html" + - title: List federations + url: "/federation/get-organizations-federations.html" + swagger-title: GET /organizations/{organization_id}/federations + data-api-method: GET + data-api-path: "/organizations/{organization_id}/federations" + data-summary: List federations + data-deprecated: false + data-category: Federation + data-tag-description: |- + The federation endpoints enable you to create and manage federation connections with identity providers. Federation provided through the NetApp Console replaces the functionality provided through Cloud Central Federation Setup. + + You can perform the following actions using the federation endpoints: +
      +
    • List federations
      • +
    • Create a federation
      • +
    • Delete a federation
      • +
    • Retrieve a federation
      • +
    • Update a federation
      • +
    + data-introduced: '' + - title: Create a federation + url: "/federation/post-organizations-federations.html" + swagger-title: POST /organizations/{organization_id}/federations + data-api-method: POST + data-api-path: "/organizations/{organization_id}/federations" + data-summary: Create a federation + data-deprecated: false + data-category: Federation + data-tag-description: |- + The federation endpoints enable you to create and manage federation connections with identity providers. Federation provided through the NetApp Console replaces the functionality provided through Cloud Central Federation Setup. + + You can perform the following actions using the federation endpoints: +
      +
    • List federations
      • +
    • Create a federation
      • +
    • Delete a federation
      • +
    • Retrieve a federation
      • +
    • Update a federation
      • +
    + data-introduced: '' + - title: Delete a federation + url: "/federation/delete-organizations-federations-.html" + swagger-title: DELETE /organizations/{organization_id}/federations/{federation_id} + data-api-method: DELETE + data-api-path: "/organizations/{organization_id}/federations/{federation_id}" + data-summary: Delete a federation + data-deprecated: false + data-category: Federation + data-tag-description: |- + The federation endpoints enable you to create and manage federation connections with identity providers. Federation provided through the NetApp Console replaces the functionality provided through Cloud Central Federation Setup. + + You can perform the following actions using the federation endpoints: +
      +
    • List federations
      • +
    • Create a federation
      • +
    • Delete a federation
      • +
    • Retrieve a federation
      • +
    • Update a federation
      • +
    + data-introduced: '' + - title: Retrieve a federation + url: "/federation/get-organizations-federations-.html" + swagger-title: GET /organizations/{organization_id}/federations/{federation_id} + data-api-method: GET + data-api-path: "/organizations/{organization_id}/federations/{federation_id}" + data-summary: Retrieve a federation + data-deprecated: false + data-category: Federation + data-tag-description: |- + The federation endpoints enable you to create and manage federation connections with identity providers. Federation provided through the NetApp Console replaces the functionality provided through Cloud Central Federation Setup. + + You can perform the following actions using the federation endpoints: +
      +
    • List federations
      • +
    • Create a federation
      • +
    • Delete a federation
      • +
    • Retrieve a federation
      • +
    • Update a federation
      • +
    + data-introduced: '' + - title: Update a federation + url: "/federation/patch-organizations-federations-.html" + swagger-title: PATCH /organizations/{organization_id}/federations/{federation_id} + data-api-method: PATCH + data-api-path: "/organizations/{organization_id}/federations/{federation_id}" + data-summary: Update a federation + data-deprecated: false + data-category: Federation + data-tag-description: |- + The federation endpoints enable you to create and manage federation connections with identity providers. Federation provided through the NetApp Console replaces the functionality provided through Cloud Central Federation Setup. + + You can perform the following actions using the federation endpoints: +
      +
    • List federations
      • +
    • Create a federation
      • +
    • Delete a federation
      • +
    • Retrieve a federation
      • +
    • Update a federation
      • +
    + data-introduced: '' + - title: Unmigrated connection + entries: + - title: Overview + url: "/federation/unmigrated_connection_overview.html" + - title: List unmigrated connections + url: "/federation/get-unmigratedconnections.html" + swagger-title: GET /unmigratedconnections + data-api-method: GET + data-api-path: "/unmigratedconnections" + data-summary: List unmigrated connections + data-deprecated: false + data-category: Unmigrated Connection + data-tag-description: "The unmigrated connection endpoints enable you to import + connections from Cloud Central into the NetApp Console. After you import + a connection, it cannot be managed through Cloud Central Federation Setup. + \n\nYou can perform the following actions using the unmigrated connection + endpoints:\n
      \n
    • List unmigrated connections
      • \n
    • Import a connection
      • \n
    " + data-introduced: '' + - title: Import a connection + url: "/federation/patch-unmigratedconnections-.html" + swagger-title: PATCH /unmigratedconnections/{connection_id} + data-api-method: PATCH + data-api-path: "/unmigratedconnections/{connection_id}" + data-summary: Import a connection + data-deprecated: false + data-category: Unmigrated Connection + data-tag-description: "The unmigrated connection endpoints enable you to import + connections from Cloud Central into the NetApp Console. After you import + a connection, it cannot be managed through Cloud Central Federation Setup. + \n\nYou can perform the following actions using the unmigrated connection + endpoints:\n
      \n
    • List unmigrated connections
      • \n
    • Import a connection
      • \n
    " + data-introduced: '' + - title: IPA + entries: + - title: Overview + url: "/ipa/overview.html" + - title: License + entries: + - title: Overview + url: "/ipa/license_overview.html" + - title: Register a license + url: "/ipa/post-ipa-account-serial-number-register.html" + swagger-title: POST /ipa/account/{accountId}/serial-number/{serialNumber}/register + data-api-method: POST + data-api-path: "/ipa/account/{accountId}/serial-number/{serialNumber}/register" + data-summary: Register a license + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints in the IPA service provide license management to the IPA. License management includes license registration, deregistration, and status checks to the NetApp-wide IPA.

    +

    The registration and deregistration API endpoints register and deregister the NetApp Console license to the IPA service.
    + Based on the various versions of the IPA service, there are several versions of the NetApp Console license registration and deregistration endpoints.

    +

    Similarly, the license status check endpoint has different versions that relate to different IPA service versions.

    +

    The following describes the mapping between the NetApp Console IPA licensing endpoints and the IPA product registration endpoints:

    +
      +
    • Registration and deregistration maps to /IPA/v2/prodregister
      • +
    • Status check maps to /IPA/v2/prodstatus
      • +
    • IPA version-5 (IPA v5) status maps to /entitlement/IPA/v4/prodstatus
      • +
    • IPA v5 authentication maps to /entitlement/IPA/v4/authenticate
      • +
    • IPA v6 status maps to /entitlement/IPA/v6/prodstatus
      • +
    +

    For the credentials required for license management, the license endpoints map to cred_service_endpoint/accounts/:accountId/credentials.

    +

    You can perform the following operations by using IPA license endpoints across various versions of the IPA service:

    +
      +
    • Registration
      • +
    • Deregistration
      • +
    • Registration status check
      • +
    +
    + data-introduced: '' + - title: Deregister a license + url: "/ipa/post-ipa-serial-number-deregister.html" + swagger-title: POST /ipa/serial-number/{serialNumber}/deregister + data-api-method: POST + data-api-path: "/ipa/serial-number/{serialNumber}/deregister" + data-summary: Deregister a license + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints in the IPA service provide license management to the IPA. License management includes license registration, deregistration, and status checks to the NetApp-wide IPA.

    +

    The registration and deregistration API endpoints register and deregister the NetApp Console license to the IPA service.
    + Based on the various versions of the IPA service, there are several versions of the NetApp Console license registration and deregistration endpoints.

    +

    Similarly, the license status check endpoint has different versions that relate to different IPA service versions.

    +

    The following describes the mapping between the NetApp Console IPA licensing endpoints and the IPA product registration endpoints:

    +
      +
    • Registration and deregistration maps to /IPA/v2/prodregister
      • +
    • Status check maps to /IPA/v2/prodstatus
      • +
    • IPA version-5 (IPA v5) status maps to /entitlement/IPA/v4/prodstatus
      • +
    • IPA v5 authentication maps to /entitlement/IPA/v4/authenticate
      • +
    • IPA v6 status maps to /entitlement/IPA/v6/prodstatus
      • +
    +

    For the credentials required for license management, the license endpoints map to cred_service_endpoint/accounts/:accountId/credentials.

    +

    You can perform the following operations by using IPA license endpoints across various versions of the IPA service:

    +
      +
    • Registration
      • +
    • Deregistration
      • +
    • Registration status check
      • +
    +
    + data-introduced: '' + - title: Retrieve license status + url: "/ipa/post-ipa-serial-number-registration-status.html" + swagger-title: POST /ipa/serial-number/{serialNumber}/registration-status + data-api-method: POST + data-api-path: "/ipa/serial-number/{serialNumber}/registration-status" + data-summary: Retrieve license status + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints in the IPA service provide license management to the IPA. License management includes license registration, deregistration, and status checks to the NetApp-wide IPA.

    +

    The registration and deregistration API endpoints register and deregister the NetApp Console license to the IPA service.
    + Based on the various versions of the IPA service, there are several versions of the NetApp Console license registration and deregistration endpoints.

    +

    Similarly, the license status check endpoint has different versions that relate to different IPA service versions.

    +

    The following describes the mapping between the NetApp Console IPA licensing endpoints and the IPA product registration endpoints:

    +
      +
    • Registration and deregistration maps to /IPA/v2/prodregister
      • +
    • Status check maps to /IPA/v2/prodstatus
      • +
    • IPA version-5 (IPA v5) status maps to /entitlement/IPA/v4/prodstatus
      • +
    • IPA v5 authentication maps to /entitlement/IPA/v4/authenticate
      • +
    • IPA v6 status maps to /entitlement/IPA/v6/prodstatus
      • +
    +

    For the credentials required for license management, the license endpoints map to cred_service_endpoint/accounts/:accountId/credentials.

    +

    You can perform the following operations by using IPA license endpoints across various versions of the IPA service:

    +
      +
    • Registration
      • +
    • Deregistration
      • +
    • Registration status check
      • +
    +
    + data-introduced: '' + - title: Retrieve IPA license status (v5) + url: "/ipa/post-ipa-account-serial-number-status-v5.html" + swagger-title: POST /ipa/account/{accountId}/serial-number/{serialNumber}/status/v5 + data-api-method: POST + data-api-path: "/ipa/account/{accountId}/serial-number/{serialNumber}/status/v5" + data-summary: Retrieve IPA license status (v5) + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints in the IPA service provide license management to the IPA. License management includes license registration, deregistration, and status checks to the NetApp-wide IPA.

    +

    The registration and deregistration API endpoints register and deregister the NetApp Console license to the IPA service.
    + Based on the various versions of the IPA service, there are several versions of the NetApp Console license registration and deregistration endpoints.

    +

    Similarly, the license status check endpoint has different versions that relate to different IPA service versions.

    +

    The following describes the mapping between the NetApp Console IPA licensing endpoints and the IPA product registration endpoints:

    +
      +
    • Registration and deregistration maps to /IPA/v2/prodregister
      • +
    • Status check maps to /IPA/v2/prodstatus
      • +
    • IPA version-5 (IPA v5) status maps to /entitlement/IPA/v4/prodstatus
      • +
    • IPA v5 authentication maps to /entitlement/IPA/v4/authenticate
      • +
    • IPA v6 status maps to /entitlement/IPA/v6/prodstatus
      • +
    +

    For the credentials required for license management, the license endpoints map to cred_service_endpoint/accounts/:accountId/credentials.

    +

    You can perform the following operations by using IPA license endpoints across various versions of the IPA service:

    +
      +
    • Registration
      • +
    • Deregistration
      • +
    • Registration status check
      • +
    +
    + data-introduced: '' + - title: Authenticate an IPA license (v5) + url: "/ipa/post-ipa-authenticate-v5.html" + swagger-title: POST /ipa/authenticate/v5 + data-api-method: POST + data-api-path: "/ipa/authenticate/v5" + data-summary: Authenticate an IPA license (v5) + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints in the IPA service provide license management to the IPA. License management includes license registration, deregistration, and status checks to the NetApp-wide IPA.

    +

    The registration and deregistration API endpoints register and deregister the NetApp Console license to the IPA service.
    + Based on the various versions of the IPA service, there are several versions of the NetApp Console license registration and deregistration endpoints.

    +

    Similarly, the license status check endpoint has different versions that relate to different IPA service versions.

    +

    The following describes the mapping between the NetApp Console IPA licensing endpoints and the IPA product registration endpoints:

    +
      +
    • Registration and deregistration maps to /IPA/v2/prodregister
      • +
    • Status check maps to /IPA/v2/prodstatus
      • +
    • IPA version-5 (IPA v5) status maps to /entitlement/IPA/v4/prodstatus
      • +
    • IPA v5 authentication maps to /entitlement/IPA/v4/authenticate
      • +
    • IPA v6 status maps to /entitlement/IPA/v6/prodstatus
      • +
    +

    For the credentials required for license management, the license endpoints map to cred_service_endpoint/accounts/:accountId/credentials.

    +

    You can perform the following operations by using IPA license endpoints across various versions of the IPA service:

    +
      +
    • Registration
      • +
    • Deregistration
      • +
    • Registration status check
      • +
    +
    + data-introduced: '' + - title: Retrieve IPA license status (v6) + url: "/ipa/post-ipa-account-serial-number-status-v6.html" + swagger-title: POST /ipa/account/{accountId}/serial-number/{serialNumber}/status/v6 + data-api-method: POST + data-api-path: "/ipa/account/{accountId}/serial-number/{serialNumber}/status/v6" + data-summary: Retrieve IPA license status (v6) + data-deprecated: false + data-category: License + data-tag-description: | +
    + Overview +

    The license endpoints in the IPA service provide license management to the IPA. License management includes license registration, deregistration, and status checks to the NetApp-wide IPA.

    +

    The registration and deregistration API endpoints register and deregister the NetApp Console license to the IPA service.
    + Based on the various versions of the IPA service, there are several versions of the NetApp Console license registration and deregistration endpoints.

    +

    Similarly, the license status check endpoint has different versions that relate to different IPA service versions.

    +

    The following describes the mapping between the NetApp Console IPA licensing endpoints and the IPA product registration endpoints:

    +
      +
    • Registration and deregistration maps to /IPA/v2/prodregister
      • +
    • Status check maps to /IPA/v2/prodstatus
      • +
    • IPA version-5 (IPA v5) status maps to /entitlement/IPA/v4/prodstatus
      • +
    • IPA v5 authentication maps to /entitlement/IPA/v4/authenticate
      • +
    • IPA v6 status maps to /entitlement/IPA/v6/prodstatus
      • +
    +

    For the credentials required for license management, the license endpoints map to cred_service_endpoint/accounts/:accountId/credentials.

    +

    You can perform the following operations by using IPA license endpoints across various versions of the IPA service:

    +
      +
    • Registration
      • +
    • Deregistration
      • +
    • Registration status check
      • +
    +
    + data-introduced: '' + - title: NSS + entries: + - title: Overview + url: "/ipa/nss_overview.html" + - title: Retrieve NetApp Support Site key credentials + url: "/ipa/get-ipa-account-nss-key-.html" + swagger-title: GET /ipa/account/{accountId}/nss-key/{nssKeyId} + data-api-method: GET + data-api-path: "/ipa/account/{accountId}/nss-key/{nssKeyId}" + data-summary: Retrieve NetApp Support Site key credentials + data-deprecated: false + data-category: NSS + data-tag-description: | +
    + Overview +

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    +

    A NetApp Support Site key is a collection of the following:

    +
      +
    • Public identifier
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Account ID (such as account-NJ1nCpW5)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • +
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • +
    +

    You can perform the following actions with the NetApp Support Site endpoints:

    +
      +
    • NetApp Support Site key management (retrieve, update, delete)
      • +
    • Associate or disassociate a NetApp Support Site key
      • +
    • Update a NetApp Support Site key of a resource
      • +
    • Migrate a NetApp Support Site key and associate it with a resource
      • +
    • Retrieve an access token (required for registration)
      • +
    • Retrieve a NetApp Support Site username and email address
      • +
    +
    + data-introduced: '' + - title: Update NetApp Support Site key credentials + url: "/ipa/put-ipa-account-nss-key-.html" + swagger-title: PUT /ipa/account/{accountId}/nss-key/{nssKeyId} + data-api-method: PUT + data-api-path: "/ipa/account/{accountId}/nss-key/{nssKeyId}" + data-summary: Update NetApp Support Site key credentials + data-deprecated: false + data-category: NSS + data-tag-description: | +
    + Overview +

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    +

    A NetApp Support Site key is a collection of the following:

    +
      +
    • Public identifier
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Account ID (such as account-NJ1nCpW5)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • +
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • +
    +

    You can perform the following actions with the NetApp Support Site endpoints:

    +
      +
    • NetApp Support Site key management (retrieve, update, delete)
      • +
    • Associate or disassociate a NetApp Support Site key
      • +
    • Update a NetApp Support Site key of a resource
      • +
    • Migrate a NetApp Support Site key and associate it with a resource
      • +
    • Retrieve an access token (required for registration)
      • +
    • Retrieve a NetApp Support Site username and email address
      • +
    +
    + data-introduced: '' + - title: Delete NetApp Support Site key credentials + url: "/ipa/delete-ipa-account-nss-key-.html" + swagger-title: DELETE /ipa/account/{accountId}/nss-key/{nssKeyId} + data-api-method: DELETE + data-api-path: "/ipa/account/{accountId}/nss-key/{nssKeyId}" + data-summary: Delete NetApp Support Site key credentials + data-deprecated: false + data-category: NSS + data-tag-description: | +
    + Overview +

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    +

    A NetApp Support Site key is a collection of the following:

    +
      +
    • Public identifier
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Account ID (such as account-NJ1nCpW5)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • +
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • +
    +

    You can perform the following actions with the NetApp Support Site endpoints:

    +
      +
    • NetApp Support Site key management (retrieve, update, delete)
      • +
    • Associate or disassociate a NetApp Support Site key
      • +
    • Update a NetApp Support Site key of a resource
      • +
    • Migrate a NetApp Support Site key and associate it with a resource
      • +
    • Retrieve an access token (required for registration)
      • +
    • Retrieve a NetApp Support Site username and email address
      • +
    +
    + data-introduced: '' + - title: Retrieve a list of NetApp Support Site key credentials + url: "/ipa/get-ipa-account-nss-keys.html" + swagger-title: GET /ipa/account/{accountId}/nss-keys + data-api-method: GET + data-api-path: "/ipa/account/{accountId}/nss-keys" + data-summary: Retrieve a list of NetApp Support Site key credentials + data-deprecated: false + data-category: NSS + data-tag-description: | +
    + Overview +

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    +

    A NetApp Support Site key is a collection of the following:

    +
      +
    • Public identifier
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Account ID (such as account-NJ1nCpW5)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • +
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • +
    +

    You can perform the following actions with the NetApp Support Site endpoints:

    +
      +
    • NetApp Support Site key management (retrieve, update, delete)
      • +
    • Associate or disassociate a NetApp Support Site key
      • +
    • Update a NetApp Support Site key of a resource
      • +
    • Migrate a NetApp Support Site key and associate it with a resource
      • +
    • Retrieve an access token (required for registration)
      • +
    • Retrieve a NetApp Support Site username and email address
      • +
    +
    + data-introduced: '' + - title: Create NetApp Support Site key credentials + url: "/ipa/post-ipa-account-nss-key.html" + swagger-title: POST /ipa/account/{accountId}/nss-key + data-api-method: POST + data-api-path: "/ipa/account/{accountId}/nss-key" + data-summary: Create NetApp Support Site key credentials + data-deprecated: false + data-category: NSS + data-tag-description: | +
    + Overview +

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    +

    A NetApp Support Site key is a collection of the following:

    +
      +
    • Public identifier
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Account ID (such as account-NJ1nCpW5)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • +
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • +
    +

    You can perform the following actions with the NetApp Support Site endpoints:

    +
      +
    • NetApp Support Site key management (retrieve, update, delete)
      • +
    • Associate or disassociate a NetApp Support Site key
      • +
    • Update a NetApp Support Site key of a resource
      • +
    • Migrate a NetApp Support Site key and associate it with a resource
      • +
    • Retrieve an access token (required for registration)
      • +
    • Retrieve a NetApp Support Site username and email address
      • +
    +
    + data-introduced: '' + - title: Create an IDaaS NetApp Support Site key credential + url: "/ipa/post-ipa-account-idaas-key.html" + swagger-title: POST /ipa/account/{accountId}/idaas-key + data-api-method: POST + data-api-path: "/ipa/account/{accountId}/idaas-key" + data-summary: Create an IDaaS NetApp Support Site key credential + data-deprecated: false + data-category: NSS + data-tag-description: | +
    + Overview +

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    +

    A NetApp Support Site key is a collection of the following:

    +
      +
    • Public identifier
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Account ID (such as account-NJ1nCpW5)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • +
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • +
    +

    You can perform the following actions with the NetApp Support Site endpoints:

    +
      +
    • NetApp Support Site key management (retrieve, update, delete)
      • +
    • Associate or disassociate a NetApp Support Site key
      • +
    • Update a NetApp Support Site key of a resource
      • +
    • Migrate a NetApp Support Site key and associate it with a resource
      • +
    • Retrieve an access token (required for registration)
      • +
    • Retrieve a NetApp Support Site username and email address
      • +
    +
    + data-introduced: '' + - title: Associate a resource + url: "/ipa/post-ipa-account-nss-key-associate.html" + swagger-title: POST /ipa/account/{accountId}/nss-key/{nssKeyId}/associate + data-api-method: POST + data-api-path: "/ipa/account/{accountId}/nss-key/{nssKeyId}/associate" + data-summary: Associate a resource + data-deprecated: false + data-category: NSS + data-tag-description: | +
    + Overview +

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    +

    A NetApp Support Site key is a collection of the following:

    +
      +
    • Public identifier
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Account ID (such as account-NJ1nCpW5)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • +
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • +
    +

    You can perform the following actions with the NetApp Support Site endpoints:

    +
      +
    • NetApp Support Site key management (retrieve, update, delete)
      • +
    • Associate or disassociate a NetApp Support Site key
      • +
    • Update a NetApp Support Site key of a resource
      • +
    • Migrate a NetApp Support Site key and associate it with a resource
      • +
    • Retrieve an access token (required for registration)
      • +
    • Retrieve a NetApp Support Site username and email address
      • +
    +
    + data-introduced: '' + - title: Disassociate a resource + url: "/ipa/post-ipa-account-nss-key-disassociate.html" + swagger-title: POST /ipa/account/{accountId}/nss-key/{nssKeyId}/disassociate + data-api-method: POST + data-api-path: "/ipa/account/{accountId}/nss-key/{nssKeyId}/disassociate" + data-summary: Disassociate a resource + data-deprecated: false + data-category: NSS + data-tag-description: | +
    + Overview +

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    +

    A NetApp Support Site key is a collection of the following:

    +
      +
    • Public identifier
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Account ID (such as account-NJ1nCpW5)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • +
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • +
    +

    You can perform the following actions with the NetApp Support Site endpoints:

    +
      +
    • NetApp Support Site key management (retrieve, update, delete)
      • +
    • Associate or disassociate a NetApp Support Site key
      • +
    • Update a NetApp Support Site key of a resource
      • +
    • Migrate a NetApp Support Site key and associate it with a resource
      • +
    • Retrieve an access token (required for registration)
      • +
    • Retrieve a NetApp Support Site username and email address
      • +
    +
    + data-introduced: '' + - title: Update a resource NetApp Support Site key + url: "/ipa/post-ipa-account-src-nss-key-dst-nss_key-resource-.html" + swagger-title: POST /ipa/account/{accountId}/src-nss-key/{srcNssKeyId}/dst-nss_key/{dstNssKeyId}/resource/{resourceId} + data-api-method: POST + data-api-path: "/ipa/account/{accountId}/src-nss-key/{srcNssKeyId}/dst-nss_key/{dstNssKeyId}/resource/{resourceId}" + data-summary: Update a resource NetApp Support Site key + data-deprecated: false + data-category: NSS + data-tag-description: | +
    + Overview +

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    +

    A NetApp Support Site key is a collection of the following:

    +
      +
    • Public identifier
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Account ID (such as account-NJ1nCpW5)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • +
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • +
    +

    You can perform the following actions with the NetApp Support Site endpoints:

    +
      +
    • NetApp Support Site key management (retrieve, update, delete)
      • +
    • Associate or disassociate a NetApp Support Site key
      • +
    • Update a NetApp Support Site key of a resource
      • +
    • Migrate a NetApp Support Site key and associate it with a resource
      • +
    • Retrieve an access token (required for registration)
      • +
    • Retrieve a NetApp Support Site username and email address
      • +
    +
    + data-introduced: '' + - title: Retrieve NetApp Support Site credentials + url: "/ipa/get-ipa-account-nss-key-resource-.html" + swagger-title: GET /ipa/account/{accountId}/nss-key/resource/{resourceId} + data-api-method: GET + data-api-path: "/ipa/account/{accountId}/nss-key/resource/{resourceId}" + data-summary: Retrieve NetApp Support Site credentials + data-deprecated: false + data-category: NSS + data-tag-description: | +
    + Overview +

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    +

    A NetApp Support Site key is a collection of the following:

    +
      +
    • Public identifier
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Account ID (such as account-NJ1nCpW5)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • +
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • +
    +

    You can perform the following actions with the NetApp Support Site endpoints:

    +
      +
    • NetApp Support Site key management (retrieve, update, delete)
      • +
    • Associate or disassociate a NetApp Support Site key
      • +
    • Update a NetApp Support Site key of a resource
      • +
    • Migrate a NetApp Support Site key and associate it with a resource
      • +
    • Retrieve an access token (required for registration)
      • +
    • Retrieve a NetApp Support Site username and email address
      • +
    +
    + data-introduced: '' + - title: Retrieve an access token + url: "/ipa/get-ipa-nss-key-access-token.html" + swagger-title: GET /ipa/nss-key/{nssKeyId}/access-token + data-api-method: GET + data-api-path: "/ipa/nss-key/{nssKeyId}/access-token" + data-summary: Retrieve an access token + data-deprecated: false + data-category: NSS + data-tag-description: | +
    + Overview +

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    +

    A NetApp Support Site key is a collection of the following:

    +
      +
    • Public identifier
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Account ID (such as account-NJ1nCpW5)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • +
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • +
    +

    You can perform the following actions with the NetApp Support Site endpoints:

    +
      +
    • NetApp Support Site key management (retrieve, update, delete)
      • +
    • Associate or disassociate a NetApp Support Site key
      • +
    • Update a NetApp Support Site key of a resource
      • +
    • Migrate a NetApp Support Site key and associate it with a resource
      • +
    • Retrieve an access token (required for registration)
      • +
    • Retrieve a NetApp Support Site username and email address
      • +
    +
    + data-introduced: '' + - title: Retrieve NetApp Support Site data for accounts + url: "/ipa/get-ipa-accounts-nss-data.html" + swagger-title: GET /ipa/accounts/nss-data + data-api-method: GET + data-api-path: "/ipa/accounts/nss-data" + data-summary: Retrieve NetApp Support Site data for accounts + data-deprecated: false + data-category: NSS + data-tag-description: | +
    + Overview +

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    +

    A NetApp Support Site key is a collection of the following:

    +
      +
    • Public identifier
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Account ID (such as account-NJ1nCpW5)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • +
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • +
    +

    You can perform the following actions with the NetApp Support Site endpoints:

    +
      +
    • NetApp Support Site key management (retrieve, update, delete)
      • +
    • Associate or disassociate a NetApp Support Site key
      • +
    • Update a NetApp Support Site key of a resource
      • +
    • Migrate a NetApp Support Site key and associate it with a resource
      • +
    • Retrieve an access token (required for registration)
      • +
    • Retrieve a NetApp Support Site username and email address
      • +
    +
    + data-introduced: '' + - title: Retrieve NetApp Support Site data for an account and key ID + url: "/ipa/get-ipa-account-nss-key-nss-data.html" + swagger-title: GET /ipa/account/{accountId}/nss-key/{nssKeyId}/nss-data + data-api-method: GET + data-api-path: "/ipa/account/{accountId}/nss-key/{nssKeyId}/nss-data" + data-summary: Retrieve NetApp Support Site data for an account and key ID + data-deprecated: false + data-category: NSS + data-tag-description: | +
    + Overview +

    NetApp Support Site (NSS) endpoints in the NetApp Console IPA service provide various functions related to NetApp Support Site key management, migration, and access-token retrieval.

    +

    A NetApp Support Site key is a collection of the following:

    +
      +
    • Public identifier
      • +
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • +
    • Account ID (such as account-NJ1nCpW5)
      • +
    • Resource class (such as ON_PREM, VSA, S3)
      • +
    • NetApp Support Site key ID (such as a75d2cbb-4be9-4115-b8d0-31fa10c7791c)
      • +
    • NetApp Support Site username - the name used to make a NetApp Support Site registration
      • +
    +

    You can perform the following actions with the NetApp Support Site endpoints:

    +
      +
    • NetApp Support Site key management (retrieve, update, delete)
      • +
    • Associate or disassociate a NetApp Support Site key
      • +
    • Update a NetApp Support Site key of a resource
      • +
    • Migrate a NetApp Support Site key and associate it with a resource
      • +
    • Retrieve an access token (required for registration)
      • +
    • Retrieve a NetApp Support Site username and email address
      • +
    +
    + data-introduced: '' + - title: Services + entries: + - title: Overview + url: "/ipa/services_overview.html" + - title: Retrieve an IPA serial number token + url: "/ipa/post-ipa-services-account-sn-lookup-token.html" + swagger-title: POST /ipa/services/account/{accountId}/sn-lookup-token + data-api-method: POST + data-api-path: "/ipa/services/account/{accountId}/sn-lookup-token" + data-summary: Retrieve an IPA serial number token + data-deprecated: false + data-category: Services + data-tag-description: | +
    + Overview +

    The services endpoint performs the NetApp IPA serial number (sn) lookup and serial number token lookup operations.
    + You need a serial number lookup token to retrieve a serial number. You can retrieve both a serial number and a lookup token by using this endpoint.

    +

    To retrieve a serial number token (sn-token), the NetApp Console IPA services endpoint consults the sn-lookup-service endpoint.
    + To retrieve a serial number (sn-lookup), the NetApp Console IPA services endpoint consults the sn-service endpoint.

    +

    You can perform the following operations with the IPA services endpoint:

    +
      +
    • Retrieve a serial number lookup token
      • +
    • Retrieve a serial number
      • +
    +
    + data-introduced: '' + - title: Retrieve an IPA serial number + url: "/ipa/post-ipa-services-sn-lookup.html" + swagger-title: POST /ipa/services/sn-lookup + data-api-method: POST + data-api-path: "/ipa/services/sn-lookup" + data-summary: Retrieve an IPA serial number + data-deprecated: false + data-category: Services + data-tag-description: | +
    + Overview +

    The services endpoint performs the NetApp IPA serial number (sn) lookup and serial number token lookup operations.
    + You need a serial number lookup token to retrieve a serial number. You can retrieve both a serial number and a lookup token by using this endpoint.

    +

    To retrieve a serial number token (sn-token), the NetApp Console IPA services endpoint consults the sn-lookup-service endpoint.
    + To retrieve a serial number (sn-lookup), the NetApp Console IPA services endpoint consults the sn-service endpoint.

    +

    You can perform the following operations with the IPA services endpoint:

    +
      +
    • Retrieve a serial number lookup token
      • +
    • Retrieve a serial number
      • +
    +
    + data-introduced: '' + - title: Support + entries: + - title: Overview + url: "/ipa/support_overview.html" + - title: Check system entitlements + url: "/ipa/post-ipa-support-case-system-entitlements.html" + swagger-title: POST /ipa/support/case/system-entitlements + data-api-method: POST + data-api-path: "/ipa/support/case/system-entitlements" + data-summary: Check system entitlements + data-deprecated: false + data-category: Support + data-tag-description: | +
    + Overview +

    The support endpoint performs the case system entitlements and case creation operations.

    +

    You can perform the following operations with the IPA support endpoint:

    +
      +
    • Check system entitlements for serial number - this checks if the user is entitled to create a case for the requested serial number.
      • +
    • Create a support case
      • +
    +
    + data-introduced: '' + - title: Create a support case + url: "/ipa/post-ipa-support-case-create.html" + swagger-title: POST /ipa/support/case/create + data-api-method: POST + data-api-path: "/ipa/support/case/create" + data-summary: Create a support case + data-deprecated: false + data-category: Support + data-tag-description: | +
    + Overview +

    The support endpoint performs the case system entitlements and case creation operations.

    +

    You can perform the following operations with the IPA support endpoint:

    +
      +
    • Check system entitlements for serial number - this checks if the user is entitled to create a case for the requested serial number.
      • +
    • Create a support case
      • +
    +
    + data-introduced: '' + - title: Upload an attachment for a support case + url: "/ipa/post-ipa-support-case-upload.html" + swagger-title: POST /ipa/support/case/{caseNumber}/upload + data-api-method: POST + data-api-path: "/ipa/support/case/{caseNumber}/upload" + data-summary: Upload an attachment for a support case + data-deprecated: false + data-category: Support + data-tag-description: | +
    + Overview +

    The support endpoint performs the case system entitlements and case creation operations.

    +

    You can perform the following operations with the IPA support endpoint:

    +
      +
    • Check system entitlements for serial number - this checks if the user is entitled to create a case for the requested serial number.
      • +
    • Create a support case
      • +
    +
    + data-introduced: '' + - title: Retrieve a temporary URL for file attachment + url: "/ipa/get-ipa-support-case-file-upload-url.html" + swagger-title: GET /ipa/support/case/{caseNumber}/file/{fileName}/upload-url + data-api-method: GET + data-api-path: "/ipa/support/case/{caseNumber}/file/{fileName}/upload-url" + data-summary: Retrieve a temporary URL for file attachment + data-deprecated: false + data-category: Support + data-tag-description: | +
    + Overview +

    The support endpoint performs the case system entitlements and case creation operations.

    +

    You can perform the following operations with the IPA support endpoint:

    +
      +
    • Check system entitlements for serial number - this checks if the user is entitled to create a case for the requested serial number.
      • +
    • Create a support case
      • +
    +
    + data-introduced: '' + - title: Retrieve support cases + url: "/ipa/get-ipa-support-case-search.html" + swagger-title: GET /ipa/support/case-search + data-api-method: GET + data-api-path: "/ipa/support/case-search" + data-summary: Retrieve support cases + data-deprecated: false + data-category: Support + data-tag-description: | +
    + Overview +

    The support endpoint performs the case system entitlements and case creation operations.

    +

    You can perform the following operations with the IPA support endpoint:

    +
      +
    • Check system entitlements for serial number - this checks if the user is entitled to create a case for the requested serial number.
      • +
    • Create a support case
      • +
    +
    + data-introduced: '' + - title: Retrieve support case details + url: "/ipa/get-ipa-support-case-details.html" + swagger-title: GET /ipa/support/case/{caseNumber}/details + data-api-method: GET + data-api-path: "/ipa/support/case/{caseNumber}/details" + data-summary: Retrieve support case details + data-deprecated: false + data-category: Support + data-tag-description: | +
    + Overview +

    The support endpoint performs the case system entitlements and case creation operations.

    +

    You can perform the following operations with the IPA support endpoint:

    +
      +
    • Check system entitlements for serial number - this checks if the user is entitled to create a case for the requested serial number.
      • +
    • Create a support case
      • +
    +
    + data-introduced: '' + - title: Update support case notes or status + url: "/ipa/put-ipa-support-case-.html" + swagger-title: PUT /ipa/support/case/{caseNumber} + data-api-method: PUT + data-api-path: "/ipa/support/case/{caseNumber}" + data-summary: Update support case notes or status + data-deprecated: false + data-category: Support + data-tag-description: | +
    + Overview +

    The support endpoint performs the case system entitlements and case creation operations.

    +

    You can perform the following operations with the IPA support endpoint:

    +
      +
    • Check system entitlements for serial number - this checks if the user is entitled to create a case for the requested serial number.
      • +
    • Create a support case
      • +
    +
    + data-introduced: '' + - title: Retrieve a list of case notes + url: "/ipa/get-ipa-support-case-notes-.html" + swagger-title: GET /ipa/support/case-notes/{caseNumber} + data-api-method: GET + data-api-path: "/ipa/support/case-notes/{caseNumber}" + data-summary: Retrieve a list of case notes + data-deprecated: false + data-category: Support + data-tag-description: | +
    + Overview +

    The support endpoint performs the case system entitlements and case creation operations.

    +

    You can perform the following operations with the IPA support endpoint:

    +
      +
    • Check system entitlements for serial number - this checks if the user is entitled to create a case for the requested serial number.
      • +
    • Create a support case
      • +
    +
    + data-introduced: '' + - title: Identity and access management + entries: + - title: Overview + url: "/tenancyv4/overview.html" + - title: Hierarchy + entries: + - title: Overview + url: "/tenancyv4/hierarchy_overview.html" + - title: List all folders + url: "/tenancyv4/get-folders.html" + swagger-title: GET /folders + data-api-method: GET + data-api-path: "/folders" + data-summary: List all folders + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Create a new folder + url: "/tenancyv4/post-folders.html" + swagger-title: POST /folders + data-api-method: POST + data-api-path: "/folders" + data-summary: Create a new folder + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Delete a folder + url: "/tenancyv4/delete-folders-.html" + swagger-title: DELETE /folders/{folder_id} + data-api-method: DELETE + data-api-path: "/folders/{folder_id}" + data-summary: Delete a folder + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Retrieve a folder + url: "/tenancyv4/get-folders-.html" + swagger-title: GET /folders/{folder_id} + data-api-method: GET + data-api-path: "/folders/{folder_id}" + data-summary: Retrieve a folder + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Update a folder partially + url: "/tenancyv4/patch-folders-.html" + swagger-title: PATCH /folders/{folder_id} + data-api-method: PATCH + data-api-path: "/folders/{folder_id}" + data-summary: Update a folder partially + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Update a folder + url: "/tenancyv4/put-folders-.html" + swagger-title: PUT /folders/{folder_id} + data-api-method: PUT + data-api-path: "/folders/{folder_id}" + data-summary: Update a folder + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: List all folders under a parent folder + url: "/tenancyv4/get-folders-folders.html" + swagger-title: GET /folders/{folder_id}/folders + data-api-method: GET + data-api-path: "/folders/{folder_id}/folders" + data-summary: List all folders under a parent folder + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Create a child folder under a parent folder + url: "/tenancyv4/post-folders-folders.html" + swagger-title: POST /folders/{folder_id}/folders + data-api-method: POST + data-api-path: "/folders/{folder_id}/folders" + data-summary: Create a child folder under a parent folder + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Remove a child folder from a parent folder + url: "/tenancyv4/delete-folders-folders-.html" + swagger-title: DELETE /folders/{folder_id}/folders/{childfolder_id} + data-api-method: DELETE + data-api-path: "/folders/{folder_id}/folders/{childfolder_id}" + data-summary: Remove a child folder from a parent folder + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Retrieve a child folder under a parent folder + url: "/tenancyv4/get-folders-folders-.html" + swagger-title: GET /folders/{folder_id}/folders/{childfolder_id} + data-api-method: GET + data-api-path: "/folders/{folder_id}/folders/{childfolder_id}" + data-summary: Retrieve a child folder under a parent folder + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: List all projects under a folder + url: "/tenancyv4/get-folders-projects.html" + swagger-title: GET /folders/{folder_id}/projects + data-api-method: GET + data-api-path: "/folders/{folder_id}/projects" + data-summary: List all projects under a folder + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Create a new project under a folder + url: "/tenancyv4/post-folders-projects.html" + swagger-title: POST /folders/{folder_id}/projects + data-api-method: POST + data-api-path: "/folders/{folder_id}/projects" + data-summary: Create a new project under a folder + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Remove a project from a folder + url: "/tenancyv4/delete-folders-projects-.html" + swagger-title: DELETE /folders/{folder_id}/projects/{project_id} + data-api-method: DELETE + data-api-path: "/folders/{folder_id}/projects/{project_id}" + data-summary: Remove a project from a folder + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Retrieve a project under a folder + url: "/tenancyv4/get-folders-projects-.html" + swagger-title: GET /folders/{folder_id}/projects/{project_id} + data-api-method: GET + data-api-path: "/folders/{folder_id}/projects/{project_id}" + data-summary: Retrieve a project under a folder + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Update a project under a folder partially + url: "/tenancyv4/patch-folders-projects-.html" + swagger-title: PATCH /folders/{folder_id}/projects/{project_id} + data-api-method: PATCH + data-api-path: "/folders/{folder_id}/projects/{project_id}" + data-summary: Update a project under a folder partially + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Modify a project under a folder + url: "/tenancyv4/put-folders-projects-.html" + swagger-title: PUT /folders/{folder_id}/projects/{project_id} + data-api-method: PUT + data-api-path: "/folders/{folder_id}/projects/{project_id}" + data-summary: Modify a project under a folder + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: List all organizations + url: "/tenancyv4/get-organizations.html" + swagger-title: GET /organizations + data-api-method: GET + data-api-path: "/organizations" + data-summary: List all organizations + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Create a new organization + url: "/tenancyv4/post-organizations.html" + swagger-title: POST /organizations + data-api-method: POST + data-api-path: "/organizations" + data-summary: Create a new organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Retrieve an organization + url: "/tenancyv4/get-organizations-.html" + swagger-title: GET /organizations/{organization_id} + data-api-method: GET + data-api-path: "/organizations/{organization_id}" + data-summary: Retrieve an organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Update an organization partially + url: "/tenancyv4/patch-organizations-.html" + swagger-title: PATCH /organizations/{organization_id} + data-api-method: PATCH + data-api-path: "/organizations/{organization_id}" + data-summary: Update an organization partially + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Modify an organization + url: "/tenancyv4/put-organizations-.html" + swagger-title: PUT /organizations/{organization_id} + data-api-method: PUT + data-api-path: "/organizations/{organization_id}" + data-summary: Modify an organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: List all folders under an organization + url: "/tenancyv4/get-organizations-folders.html" + swagger-title: GET /organizations/{organization_id}/folders + data-api-method: GET + data-api-path: "/organizations/{organization_id}/folders" + data-summary: List all folders under an organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Create a new folder under an organization + url: "/tenancyv4/post-organizations-folders.html" + swagger-title: POST /organizations/{organization_id}/folders + data-api-method: POST + data-api-path: "/organizations/{organization_id}/folders" + data-summary: Create a new folder under an organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Remove a folder from an organization + url: "/tenancyv4/delete-organizations-folders-.html" + swagger-title: DELETE /organizations/{organization_id}/folders/{folder_id} + data-api-method: DELETE + data-api-path: "/organizations/{organization_id}/folders/{folder_id}" + data-summary: Remove a folder from an organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Retrieve a folder under an organization + url: "/tenancyv4/get-organizations-folders-.html" + swagger-title: GET /organizations/{organization_id}/folders/{folder_id} + data-api-method: GET + data-api-path: "/organizations/{organization_id}/folders/{folder_id}" + data-summary: Retrieve a folder under an organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Update a folder under an organization partially + url: "/tenancyv4/patch-organizations-folders-.html" + swagger-title: PATCH /organizations/{organization_id}/folders/{folder_id} + data-api-method: PATCH + data-api-path: "/organizations/{organization_id}/folders/{folder_id}" + data-summary: Update a folder under an organization partially + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Update a folder under an organization + url: "/tenancyv4/put-organizations-folders-.html" + swagger-title: PUT /organizations/{organization_id}/folders/{folder_id} + data-api-method: PUT + data-api-path: "/organizations/{organization_id}/folders/{folder_id}" + data-summary: Update a folder under an organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Remove a child organization from a parent organization + url: "/tenancyv4/delete-organizations-organizations-.html" + swagger-title: DELETE /organizations/{organization_id}/organizations/{childorganization_id} + data-api-method: DELETE + data-api-path: "/organizations/{organization_id}/organizations/{childorganization_id}" + data-summary: Remove a child organization from a parent organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: List all projects under an organization + url: "/tenancyv4/get-organizations-projects.html" + swagger-title: GET /organizations/{organization_id}/projects + data-api-method: GET + data-api-path: "/organizations/{organization_id}/projects" + data-summary: List all projects under an organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Create a new project under an organization + url: "/tenancyv4/post-organizations-projects.html" + swagger-title: POST /organizations/{organization_id}/projects + data-api-method: POST + data-api-path: "/organizations/{organization_id}/projects" + data-summary: Create a new project under an organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Remove a project from an organization + url: "/tenancyv4/delete-organizations-projects-.html" + swagger-title: DELETE /organizations/{organization_id}/projects/{project_id} + data-api-method: DELETE + data-api-path: "/organizations/{organization_id}/projects/{project_id}" + data-summary: Remove a project from an organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Retrieve a project under an organization + url: "/tenancyv4/get-organizations-projects-.html" + swagger-title: GET /organizations/{organization_id}/projects/{project_id} + data-api-method: GET + data-api-path: "/organizations/{organization_id}/projects/{project_id}" + data-summary: Retrieve a project under an organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Update a project under an organization partially + url: "/tenancyv4/patch-organizations-projects-.html" + swagger-title: PATCH /organizations/{organization_id}/projects/{project_id} + data-api-method: PATCH + data-api-path: "/organizations/{organization_id}/projects/{project_id}" + data-summary: Update a project under an organization partially + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Modify a project under an organization + url: "/tenancyv4/put-organizations-projects-.html" + swagger-title: PUT /organizations/{organization_id}/projects/{project_id} + data-api-method: PUT + data-api-path: "/organizations/{organization_id}/projects/{project_id}" + data-summary: Modify a project under an organization + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: List all projects + url: "/tenancyv4/get-projects.html" + swagger-title: GET /projects + data-api-method: GET + data-api-path: "/projects" + data-summary: List all projects + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Create a new project + url: "/tenancyv4/post-projects.html" + swagger-title: POST /projects + data-api-method: POST + data-api-path: "/projects" + data-summary: Create a new project + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Delete a project + url: "/tenancyv4/delete-projects-.html" + swagger-title: DELETE /projects/{project_id} + data-api-method: DELETE + data-api-path: "/projects/{project_id}" + data-summary: Delete a project + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Retrieve a project + url: "/tenancyv4/get-projects-.html" + swagger-title: GET /projects/{project_id} + data-api-method: GET + data-api-path: "/projects/{project_id}" + data-summary: Retrieve a project + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Update a project partially + url: "/tenancyv4/patch-projects-.html" + swagger-title: PATCH /projects/{project_id} + data-api-method: PATCH + data-api-path: "/projects/{project_id}" + data-summary: Update a project partially + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Modify a project + url: "/tenancyv4/put-projects-.html" + swagger-title: PUT /projects/{project_id} + data-api-method: PUT + data-api-path: "/projects/{project_id}" + data-summary: Modify a project + data-deprecated: false + data-category: Hierarchy + data-tag-description: |- + The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + + A Hierarchy is composed of multiple elements: +
      +
    • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
      • +
    • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
      • +
    • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
      • +
    • Resources are associated with one or more folders or projects.
      • +
    + data-introduced: '' + - title: Partnership + entries: + - title: Overview + url: "/tenancyv4/partnership_overview.html" + - title: List all partnerships + url: "/tenancyv4/get-partnerships.html" + swagger-title: GET /partnerships + data-api-method: GET + data-api-path: "/partnerships" + data-summary: List all partnerships + data-deprecated: false + data-category: Partnership + data-tag-description: "The partnership endpoints enable collaboration between + two organizations in the NetApp Console.\n\nA partnership represents an + organization sharing resources (the source organization) with users of a + different organization (the destination organization). Partnership allows + the source organization to grant permissions to users from the destination + organization, enabling them to manage one or more organization's resources. + Grants define the access (set of permissions) that a user from the destination + organization has on a resource from the source organization.\n\nA partnership + has multiple grants. A grant is defined by:\n
    • A list of users from + the destination organization
      • \n
    • A list of resources from the source + organization
      • \n
    • A role applicable between these two groups which + is referenced in the partnershipType.
      • \n
    \n\nThe partnership + type defines the possible roles that can be applied between users and resources. + The current supported partnership types are Self-Service." + data-introduced: '' + - title: Create a new partnership + url: "/tenancyv4/post-partnerships.html" + swagger-title: POST /partnerships + data-api-method: POST + data-api-path: "/partnerships" + data-summary: Create a new partnership + data-deprecated: false + data-category: Partnership + data-tag-description: "The partnership endpoints enable collaboration between + two organizations in the NetApp Console.\n\nA partnership represents an + organization sharing resources (the source organization) with users of a + different organization (the destination organization). Partnership allows + the source organization to grant permissions to users from the destination + organization, enabling them to manage one or more organization's resources. + Grants define the access (set of permissions) that a user from the destination + organization has on a resource from the source organization.\n\nA partnership + has multiple grants. A grant is defined by:\n
    • A list of users from + the destination organization
      • \n
    • A list of resources from the source + organization
      • \n
    • A role applicable between these two groups which + is referenced in the partnershipType.
      • \n
    \n\nThe partnership + type defines the possible roles that can be applied between users and resources. + The current supported partnership types are Self-Service." + data-introduced: '' + - title: Delete a partnership + url: "/tenancyv4/delete-partnerships-.html" + swagger-title: DELETE /partnerships/{partnership_id} + data-api-method: DELETE + data-api-path: "/partnerships/{partnership_id}" + data-summary: Delete a partnership + data-deprecated: false + data-category: Partnership + data-tag-description: "The partnership endpoints enable collaboration between + two organizations in the NetApp Console.\n\nA partnership represents an + organization sharing resources (the source organization) with users of a + different organization (the destination organization). Partnership allows + the source organization to grant permissions to users from the destination + organization, enabling them to manage one or more organization's resources. + Grants define the access (set of permissions) that a user from the destination + organization has on a resource from the source organization.\n\nA partnership + has multiple grants. A grant is defined by:\n
    • A list of users from + the destination organization
      • \n
    • A list of resources from the source + organization
      • \n
    • A role applicable between these two groups which + is referenced in the partnershipType.
      • \n
    \n\nThe partnership + type defines the possible roles that can be applied between users and resources. + The current supported partnership types are Self-Service." + data-introduced: '' + - title: Retrieve a partnership + url: "/tenancyv4/get-partnerships-.html" + swagger-title: GET /partnerships/{partnership_id} + data-api-method: GET + data-api-path: "/partnerships/{partnership_id}" + data-summary: Retrieve a partnership + data-deprecated: false + data-category: Partnership + data-tag-description: "The partnership endpoints enable collaboration between + two organizations in the NetApp Console.\n\nA partnership represents an + organization sharing resources (the source organization) with users of a + different organization (the destination organization). Partnership allows + the source organization to grant permissions to users from the destination + organization, enabling them to manage one or more organization's resources. + Grants define the access (set of permissions) that a user from the destination + organization has on a resource from the source organization.\n\nA partnership + has multiple grants. A grant is defined by:\n
    • A list of users from + the destination organization
      • \n
    • A list of resources from the source + organization
      • \n
    • A role applicable between these two groups which + is referenced in the partnershipType.
      • \n
    \n\nThe partnership + type defines the possible roles that can be applied between users and resources. + The current supported partnership types are Self-Service." + data-introduced: '' + - title: Update a partnership partially + url: "/tenancyv4/patch-partnerships-.html" + swagger-title: PATCH /partnerships/{partnership_id} + data-api-method: PATCH + data-api-path: "/partnerships/{partnership_id}" + data-summary: Update a partnership partially + data-deprecated: false + data-category: Partnership + data-tag-description: "The partnership endpoints enable collaboration between + two organizations in the NetApp Console.\n\nA partnership represents an + organization sharing resources (the source organization) with users of a + different organization (the destination organization). Partnership allows + the source organization to grant permissions to users from the destination + organization, enabling them to manage one or more organization's resources. + Grants define the access (set of permissions) that a user from the destination + organization has on a resource from the source organization.\n\nA partnership + has multiple grants. A grant is defined by:\n
    • A list of users from + the destination organization
      • \n
    • A list of resources from the source + organization
      • \n
    • A role applicable between these two groups which + is referenced in the partnershipType.
      • \n
    \n\nThe partnership + type defines the possible roles that can be applied between users and resources. + The current supported partnership types are Self-Service." + data-introduced: '' + - title: List all grants for a partnership + url: "/tenancyv4/get-partnerships-grants.html" + swagger-title: GET /partnerships/{partnership_id}/grants + data-api-method: GET + data-api-path: "/partnerships/{partnership_id}/grants" + data-summary: List all grants for a partnership + data-deprecated: false + data-category: Partnership + data-tag-description: "The partnership endpoints enable collaboration between + two organizations in the NetApp Console.\n\nA partnership represents an + organization sharing resources (the source organization) with users of a + different organization (the destination organization). Partnership allows + the source organization to grant permissions to users from the destination + organization, enabling them to manage one or more organization's resources. + Grants define the access (set of permissions) that a user from the destination + organization has on a resource from the source organization.\n\nA partnership + has multiple grants. A grant is defined by:\n
    • A list of users from + the destination organization
      • \n
    • A list of resources from the source + organization
      • \n
    • A role applicable between these two groups which + is referenced in the partnershipType.
      • \n
    \n\nThe partnership + type defines the possible roles that can be applied between users and resources. + The current supported partnership types are Self-Service." + data-introduced: '' + - title: Create a new grant + url: "/tenancyv4/post-partnerships-grants.html" + swagger-title: POST /partnerships/{partnership_id}/grants + data-api-method: POST + data-api-path: "/partnerships/{partnership_id}/grants" + data-summary: Create a new grant + data-deprecated: false + data-category: Partnership + data-tag-description: "The partnership endpoints enable collaboration between + two organizations in the NetApp Console.\n\nA partnership represents an + organization sharing resources (the source organization) with users of a + different organization (the destination organization). Partnership allows + the source organization to grant permissions to users from the destination + organization, enabling them to manage one or more organization's resources. + Grants define the access (set of permissions) that a user from the destination + organization has on a resource from the source organization.\n\nA partnership + has multiple grants. A grant is defined by:\n
    • A list of users from + the destination organization
      • \n
    • A list of resources from the source + organization
      • \n
    • A role applicable between these two groups which + is referenced in the partnershipType.
      • \n
    \n\nThe partnership + type defines the possible roles that can be applied between users and resources. + The current supported partnership types are Self-Service." + data-introduced: '' + - title: Delete a grant + url: "/tenancyv4/delete-partnerships-grants-.html" + swagger-title: DELETE /partnerships/{partnership_id}/grants/{grant_id} + data-api-method: DELETE + data-api-path: "/partnerships/{partnership_id}/grants/{grant_id}" + data-summary: Delete a grant + data-deprecated: false + data-category: Partnership + data-tag-description: "The partnership endpoints enable collaboration between + two organizations in the NetApp Console.\n\nA partnership represents an + organization sharing resources (the source organization) with users of a + different organization (the destination organization). Partnership allows + the source organization to grant permissions to users from the destination + organization, enabling them to manage one or more organization's resources. + Grants define the access (set of permissions) that a user from the destination + organization has on a resource from the source organization.\n\nA partnership + has multiple grants. A grant is defined by:\n
    • A list of users from + the destination organization
      • \n
    • A list of resources from the source + organization
      • \n
    • A role applicable between these two groups which + is referenced in the partnershipType.
      • \n
    \n\nThe partnership + type defines the possible roles that can be applied between users and resources. + The current supported partnership types are Self-Service." + data-introduced: '' + - title: Retrieve a grant + url: "/tenancyv4/get-partnerships-grants-.html" + swagger-title: GET /partnerships/{partnership_id}/grants/{grant_id} + data-api-method: GET + data-api-path: "/partnerships/{partnership_id}/grants/{grant_id}" + data-summary: Retrieve a grant + data-deprecated: false + data-category: Partnership + data-tag-description: "The partnership endpoints enable collaboration between + two organizations in the NetApp Console.\n\nA partnership represents an + organization sharing resources (the source organization) with users of a + different organization (the destination organization). Partnership allows + the source organization to grant permissions to users from the destination + organization, enabling them to manage one or more organization's resources. + Grants define the access (set of permissions) that a user from the destination + organization has on a resource from the source organization.\n\nA partnership + has multiple grants. A grant is defined by:\n
    • A list of users from + the destination organization
      • \n
    • A list of resources from the source + organization
      • \n
    • A role applicable between these two groups which + is referenced in the partnershipType.
      • \n
    \n\nThe partnership + type defines the possible roles that can be applied between users and resources. + The current supported partnership types are Self-Service." + data-introduced: '' + - title: Permission + entries: + - title: Overview + url: "/tenancyv4/permission_overview.html" + - title: List all permissions + url: "/tenancyv4/get-permissions.html" + swagger-title: GET /permissions + data-api-method: GET + data-api-path: "/permissions" + data-summary: List all permissions + data-deprecated: false + data-category: Permission + data-tag-description: "The permission endpoints provide access to an internal + collection of available permissions in NetApp Console identity and access + management (IAM). Permissions are defined as a low-level string of characters + that a user or service account can use to determine authorization.\n \nA + user can have permissions for the resources in the entire organization or + in specific folders and projects. Permissions prevent or allow a user to + perform specific actions at a specific level of the resource hierarchy." + data-introduced: '' + - title: Retrieve a permission + url: "/tenancyv4/get-permissions-.html" + swagger-title: GET /permissions/{permission_id} + data-api-method: GET + data-api-path: "/permissions/{permission_id}" + data-summary: Retrieve a permission + data-deprecated: false + data-category: Permission + data-tag-description: "The permission endpoints provide access to an internal + collection of available permissions in NetApp Console identity and access + management (IAM). Permissions are defined as a low-level string of characters + that a user or service account can use to determine authorization.\n \nA + user can have permissions for the resources in the entire organization or + in specific folders and projects. Permissions prevent or allow a user to + perform specific actions at a specific level of the resource hierarchy." + data-introduced: '' + - title: List all permissions for a resource + url: "/tenancyv4/get-resources-permissions.html" + swagger-title: GET /resources/{resource_id}/permissions + data-api-method: GET + data-api-path: "/resources/{resource_id}/permissions" + data-summary: List all permissions for a resource + data-deprecated: false + data-category: Permission + data-tag-description: "The permission endpoints provide access to an internal + collection of available permissions in NetApp Console identity and access + management (IAM). Permissions are defined as a low-level string of characters + that a user or service account can use to determine authorization.\n \nA + user can have permissions for the resources in the entire organization or + in specific folders and projects. Permissions prevent or allow a user to + perform specific actions at a specific level of the resource hierarchy." + data-introduced: '' + - title: List all permissions for a role + url: "/tenancyv4/get-roles-permissions.html" + swagger-title: GET /roles/{role_id}/permissions + data-api-method: GET + data-api-path: "/roles/{role_id}/permissions" + data-summary: List all permissions for a role + data-deprecated: false + data-category: Permission + data-tag-description: "The permission endpoints provide access to an internal + collection of available permissions in NetApp Console identity and access + management (IAM). Permissions are defined as a low-level string of characters + that a user or service account can use to determine authorization.\n \nA + user can have permissions for the resources in the entire organization or + in specific folders and projects. Permissions prevent or allow a user to + perform specific actions at a specific level of the resource hierarchy." + data-introduced: '' + - title: Retrieve a permission for a role + url: "/tenancyv4/get-roles-permissions-.html" + swagger-title: GET /roles/{role_id}/permissions/{permission_id} + data-api-method: GET + data-api-path: "/roles/{role_id}/permissions/{permission_id}" + data-summary: Retrieve a permission for a role + data-deprecated: false + data-category: Permission + data-tag-description: "The permission endpoints provide access to an internal + collection of available permissions in NetApp Console identity and access + management (IAM). Permissions are defined as a low-level string of characters + that a user or service account can use to determine authorization.\n \nA + user can have permissions for the resources in the entire organization or + in specific folders and projects. Permissions prevent or allow a user to + perform specific actions at a specific level of the resource hierarchy." + data-introduced: '' + - title: List all permissions for a user + url: "/tenancyv4/get-users-permissions.html" + swagger-title: GET /users/{user_id}/permissions + data-api-method: GET + data-api-path: "/users/{user_id}/permissions" + data-summary: List all permissions for a user + data-deprecated: false + data-category: Permission + data-tag-description: "The permission endpoints provide access to an internal + collection of available permissions in NetApp Console identity and access + management (IAM). Permissions are defined as a low-level string of characters + that a user or service account can use to determine authorization.\n \nA + user can have permissions for the resources in the entire organization or + in specific folders and projects. Permissions prevent or allow a user to + perform specific actions at a specific level of the resource hierarchy." + data-introduced: '' + - title: List all permissions a user has for a resource + url: "/tenancyv4/get-users-resources-permissions.html" + swagger-title: GET /users/{user_id}/resources/{resource_id}/permissions + data-api-method: GET + data-api-path: "/users/{user_id}/resources/{resource_id}/permissions" + data-summary: List all permissions a user has for a resource + data-deprecated: false + data-category: Permission + data-tag-description: "The permission endpoints provide access to an internal + collection of available permissions in NetApp Console identity and access + management (IAM). Permissions are defined as a low-level string of characters + that a user or service account can use to determine authorization.\n \nA + user can have permissions for the resources in the entire organization or + in specific folders and projects. Permissions prevent or allow a user to + perform specific actions at a specific level of the resource hierarchy." + data-introduced: '' + - title: Retrieve a permission on a resource for a user + url: "/tenancyv4/get-users-resources-permissions-.html" + swagger-title: GET /users/{user_id}/resources/{resource_id}/permissions/{permission_id} + data-api-method: GET + data-api-path: "/users/{user_id}/resources/{resource_id}/permissions/{permission_id}" + data-summary: Retrieve a permission on a resource for a user + data-deprecated: false + data-category: Permission + data-tag-description: "The permission endpoints provide access to an internal + collection of available permissions in NetApp Console identity and access + management (IAM). Permissions are defined as a low-level string of characters + that a user or service account can use to determine authorization.\n \nA + user can have permissions for the resources in the entire organization or + in specific folders and projects. Permissions prevent or allow a user to + perform specific actions at a specific level of the resource hierarchy." + data-introduced: '' + - title: Resource and resourcegroup + entries: + - title: Overview + url: "/tenancyv4/resource_and_resourcegroup_overview.html" + - title: List all resources under a folder + url: "/tenancyv4/get-folders-resources.html" + swagger-title: GET /folders/{folder_id}/resources + data-api-method: GET + data-api-path: "/folders/{folder_id}/resources" + data-summary: List all resources under a folder + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Add resources to a folder + url: "/tenancyv4/post-folders-resources.html" + swagger-title: POST /folders/{folder_id}/resources + data-api-method: POST + data-api-path: "/folders/{folder_id}/resources" + data-summary: Add resources to a folder + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Remove a resource from a folder + url: "/tenancyv4/delete-folders-resources-.html" + swagger-title: DELETE /folders/{folder_id}/resources/{resource_id} + data-api-method: DELETE + data-api-path: "/folders/{folder_id}/resources/{resource_id}" + data-summary: Remove a resource from a folder + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Retrieve a resource under a folder + url: "/tenancyv4/get-folders-resources-.html" + swagger-title: GET /folders/{folder_id}/resources/{resource_id} + data-api-method: GET + data-api-path: "/folders/{folder_id}/resources/{resource_id}" + data-summary: Retrieve a resource under a folder + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: List all resource groups under an organization + url: "/tenancyv4/get-organizations-resourcegroups.html" + swagger-title: GET /organizations/{organization_id}/resourcegroups + data-api-method: GET + data-api-path: "/organizations/{organization_id}/resourcegroups" + data-summary: List all resource groups under an organization + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Add resource groups to an organization + url: "/tenancyv4/post-organizations-resourcegroups.html" + swagger-title: POST /organizations/{organization_id}/resourcegroups + data-api-method: POST + data-api-path: "/organizations/{organization_id}/resourcegroups" + data-summary: Add resource groups to an organization + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Remove a resource group from an organization + url: "/tenancyv4/delete-organizations-resourcegroups-.html" + swagger-title: DELETE /organizations/{organization_id}/resourcegroups/{resourcegroup_id} + data-api-method: DELETE + data-api-path: "/organizations/{organization_id}/resourcegroups/{resourcegroup_id}" + data-summary: Remove a resource group from an organization + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Retrieve a resource group under an organization + url: "/tenancyv4/get-organizations-resourcegroups-.html" + swagger-title: GET /organizations/{organization_id}/resourcegroups/{resourcegroup_id} + data-api-method: GET + data-api-path: "/organizations/{organization_id}/resourcegroups/{resourcegroup_id}" + data-summary: Retrieve a resource group under an organization + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: List all resources under an organization + url: "/tenancyv4/get-organizations-resources.html" + swagger-title: GET /organizations/{organization_id}/resources + data-api-method: GET + data-api-path: "/organizations/{organization_id}/resources" + data-summary: List all resources under an organization + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Add resources to an organization + url: "/tenancyv4/post-organizations-resources.html" + swagger-title: POST /organizations/{organization_id}/resources + data-api-method: POST + data-api-path: "/organizations/{organization_id}/resources" + data-summary: Add resources to an organization + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Remove a resource from an organization + url: "/tenancyv4/delete-organizations-resources-.html" + swagger-title: DELETE /organizations/{organization_id}/resources/{resource_id} + data-api-method: DELETE + data-api-path: "/organizations/{organization_id}/resources/{resource_id}" + data-summary: Remove a resource from an organization + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Retrieve a resource under an organization + url: "/tenancyv4/get-organizations-resources-.html" + swagger-title: GET /organizations/{organization_id}/resources/{resource_id} + data-api-method: GET + data-api-path: "/organizations/{organization_id}/resources/{resource_id}" + data-summary: Retrieve a resource under an organization + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: List all resources for a grant in a partnership + url: "/tenancyv4/get-partnerships-grants-resources.html" + swagger-title: GET /partnerships/{partnership_id}/grants/{grant_id}/resources + data-api-method: GET + data-api-path: "/partnerships/{partnership_id}/grants/{grant_id}/resources" + data-summary: List all resources for a grant in a partnership + data-deprecated: false + data-category: Resource and Resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Add resources to a grant in a partnership + url: "/tenancyv4/post-partnerships-grants-resources.html" + swagger-title: POST /partnerships/{partnership_id}/grants/{grant_id}/resources + data-api-method: POST + data-api-path: "/partnerships/{partnership_id}/grants/{grant_id}/resources" + data-summary: Add resources to a grant in a partnership + data-deprecated: false + data-category: Resource and Resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Remove a resource from a grant in a partnership + url: "/tenancyv4/delete-partnerships-grants-resources-.html" + swagger-title: DELETE /partnerships/{partnership_id}/grants/{grant_id}/resources/{resource_id} + data-api-method: DELETE + data-api-path: "/partnerships/{partnership_id}/grants/{grant_id}/resources/{resource_id}" + data-summary: Remove a resource from a grant in a partnership + data-deprecated: false + data-category: Resource and Resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Retrieve a resource from a grant in a partnership + url: "/tenancyv4/get-partnerships-grants-resources-.html" + swagger-title: GET /partnerships/{partnership_id}/grants/{grant_id}/resources/{resource_id} + data-api-method: GET + data-api-path: "/partnerships/{partnership_id}/grants/{grant_id}/resources/{resource_id}" + data-summary: Retrieve a resource from a grant in a partnership + data-deprecated: false + data-category: Resource and Resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: List all partnership types + url: "/tenancyv4/get-partnershiptypes.html" + swagger-title: GET /partnershiptypes + data-api-method: GET + data-api-path: "/partnershiptypes" + data-summary: List all partnership types + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Retrieve a partnership type + url: "/tenancyv4/get-partnershiptypes-.html" + swagger-title: GET /partnershiptypes/{partnershiptype_id} + data-api-method: GET + data-api-path: "/partnershiptypes/{partnershiptype_id}" + data-summary: Retrieve a partnership type + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: List all resources in a project + url: "/tenancyv4/get-projects-resources.html" + swagger-title: GET /projects/{project_id}/resources + data-api-method: GET + data-api-path: "/projects/{project_id}/resources" + data-summary: List all resources in a project + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Add resources to a project + url: "/tenancyv4/post-projects-resources.html" + swagger-title: POST /projects/{project_id}/resources + data-api-method: POST + data-api-path: "/projects/{project_id}/resources" + data-summary: Add resources to a project + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Remove a resource from a project + url: "/tenancyv4/delete-projects-resources-.html" + swagger-title: DELETE /projects/{project_id}/resources/{resource_id} + data-api-method: DELETE + data-api-path: "/projects/{project_id}/resources/{resource_id}" + data-summary: Remove a resource from a project + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Retrieve a resource in a project + url: "/tenancyv4/get-projects-resources-.html" + swagger-title: GET /projects/{project_id}/resources/{resource_id} + data-api-method: GET + data-api-path: "/projects/{project_id}/resources/{resource_id}" + data-summary: Retrieve a resource in a project + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: List all resource groups + url: "/tenancyv4/get-resourcegroups.html" + swagger-title: GET /resourcegroups + data-api-method: GET + data-api-path: "/resourcegroups" + data-summary: List all resource groups + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Create a new resource group + url: "/tenancyv4/post-resourcegroups.html" + swagger-title: POST /resourcegroups + data-api-method: POST + data-api-path: "/resourcegroups" + data-summary: Create a new resource group + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Delete a resource group + url: "/tenancyv4/delete-resourcegroups-.html" + swagger-title: DELETE /resourcegroups/{resourcegroup_id} + data-api-method: DELETE + data-api-path: "/resourcegroups/{resourcegroup_id}" + data-summary: Delete a resource group + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Retrieve a resource group + url: "/tenancyv4/get-resourcegroups-.html" + swagger-title: GET /resourcegroups/{resourcegroup_id} + data-api-method: GET + data-api-path: "/resourcegroups/{resourcegroup_id}" + data-summary: Retrieve a resource group + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Update a resource group + url: "/tenancyv4/patch-resourcegroups-.html" + swagger-title: PATCH /resourcegroups/{resourcegroup_id} + data-api-method: PATCH + data-api-path: "/resourcegroups/{resourcegroup_id}" + data-summary: Update a resource group + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Modify a resource group + url: "/tenancyv4/put-resourcegroups-.html" + swagger-title: PUT /resourcegroups/{resourcegroup_id} + data-api-method: PUT + data-api-path: "/resourcegroups/{resourcegroup_id}" + data-summary: Modify a resource group + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: List all resources for a resource group + url: "/tenancyv4/get-resourcegroups-resources.html" + swagger-title: GET /resourcegroups/{resourcegroup_id}/resources + data-api-method: GET + data-api-path: "/resourcegroups/{resourcegroup_id}/resources" + data-summary: List all resources for a resource group + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Add resources to a resource group + url: "/tenancyv4/post-resourcegroups-resources.html" + swagger-title: POST /resourcegroups/{resourcegroup_id}/resources + data-api-method: POST + data-api-path: "/resourcegroups/{resourcegroup_id}/resources" + data-summary: Add resources to a resource group + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Remove a resource from a resource group + url: "/tenancyv4/delete-resourcegroups-resources-.html" + swagger-title: DELETE /resourcegroups/{resourcegroup_id}/resources/{resource_id} + data-api-method: DELETE + data-api-path: "/resourcegroups/{resourcegroup_id}/resources/{resource_id}" + data-summary: Remove a resource from a resource group + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Retrieve a resource in a resource group + url: "/tenancyv4/get-resourcegroups-resources-.html" + swagger-title: GET /resourcegroups/{resourcegroup_id}/resources/{resource_id} + data-api-method: GET + data-api-path: "/resourcegroups/{resourcegroup_id}/resources/{resource_id}" + data-summary: Retrieve a resource in a resource group + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: List all resources + url: "/tenancyv4/get-resources.html" + swagger-title: GET /resources + data-api-method: GET + data-api-path: "/resources" + data-summary: List all resources + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Create a new resource + url: "/tenancyv4/post-resources.html" + swagger-title: POST /resources + data-api-method: POST + data-api-path: "/resources" + data-summary: Create a new resource + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Delete a resource + url: "/tenancyv4/delete-resources-.html" + swagger-title: DELETE /resources/{resource_id} + data-api-method: DELETE + data-api-path: "/resources/{resource_id}" + data-summary: Delete a resource + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Retrieve a resource + url: "/tenancyv4/get-resources-.html" + swagger-title: GET /resources/{resource_id} + data-api-method: GET + data-api-path: "/resources/{resource_id}" + data-summary: Retrieve a resource + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Update a resource + url: "/tenancyv4/patch-resources-.html" + swagger-title: PATCH /resources/{resource_id} + data-api-method: PATCH + data-api-path: "/resources/{resource_id}" + data-summary: Update a resource + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Modify a resource + url: "/tenancyv4/put-resources-.html" + swagger-title: PUT /resources/{resource_id} + data-api-method: PUT + data-api-path: "/resources/{resource_id}" + data-summary: Modify a resource + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: List all partnership organizations for the specified user + url: "/tenancyv4/get-users-partnerorganizations.html" + swagger-title: GET /users/{user_id}/partnerOrganizations + data-api-method: GET + data-api-path: "/users/{user_id}/partnerOrganizations" + data-summary: List all partnership organizations for the specified user + data-deprecated: false + data-category: Resource and Resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: List all resources for a user with a permission + url: "/tenancyv4/get-users-permissions-resources.html" + swagger-title: GET /users/{user_id}/permissions/{permission_id}/resources + data-api-method: GET + data-api-path: "/users/{user_id}/permissions/{permission_id}/resources" + data-summary: List all resources for a user with a permission + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Retrieve a resource for a user with a permission + url: "/tenancyv4/get-users-permissions-resources-.html" + swagger-title: GET /users/{user_id}/permissions/{permission_id}/resources/{resource_id} + data-api-method: GET + data-api-path: "/users/{user_id}/permissions/{permission_id}/resources/{resource_id}" + data-summary: Retrieve a resource for a user with a permission + data-deprecated: false + data-category: Resource and Resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: List all resources for a user + url: "/tenancyv4/get-users-resources.html" + swagger-title: GET /users/{user_id}/resources + data-api-method: GET + data-api-path: "/users/{user_id}/resources" + data-summary: List all resources for a user + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Check if a user has permission for a resource + url: "/tenancyv4/get-users-resources-.html" + swagger-title: GET /users/{user_id}/resources/{resource_id} + data-api-method: GET + data-api-path: "/users/{user_id}/resources/{resource_id}" + data-summary: Check if a user has permission for a resource + data-deprecated: false + data-category: Resource and resourcegroup + data-tag-description: |- + The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + + ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + + A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + + A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + data-introduced: '' + - title: Role + entries: + - title: Overview + url: "/tenancyv4/role_overview.html" + - title: List all roles + url: "/tenancyv4/get-roles.html" + swagger-title: GET /roles + data-api-method: GET + data-api-path: "/roles" + data-summary: List all roles + data-deprecated: false + data-category: Role + data-tag-description: "The role endpoints enable you to create and view roles, + which are sets of permissions. \n\nIn NetApp Console identity and access + management (IAM), you don't assign permissions directly to users in an organization. + Instead, you assign each user a role. A role contains a set of permissions + that enables a user to perform specific actions at a specific level of the + resource hierarchy. Roles can represent actions or features, or the access + level that user has for a particular service.\n\nIAM supports several predefined + roles that you can assign to the users in your organization. Custom roles + are not supported." + data-introduced: '' + - title: Retrieve a role + url: "/tenancyv4/get-roles-.html" + swagger-title: GET /roles/{role_id} + data-api-method: GET + data-api-path: "/roles/{role_id}" + data-summary: Retrieve a role + data-deprecated: false + data-category: Role + data-tag-description: "The role endpoints enable you to create and view roles, + which are sets of permissions. \n\nIn NetApp Console identity and access + management (IAM), you don't assign permissions directly to users in an organization. + Instead, you assign each user a role. A role contains a set of permissions + that enables a user to perform specific actions at a specific level of the + resource hierarchy. Roles can represent actions or features, or the access + level that user has for a particular service.\n\nIAM supports several predefined + roles that you can assign to the users in your organization. Custom roles + are not supported." + data-introduced: '' + - title: List all the roles for a user + url: "/tenancyv4/get-users-roles.html" + swagger-title: GET /users/{user_id}/roles + data-api-method: GET + data-api-path: "/users/{user_id}/roles" + data-summary: List all the roles for a user + data-deprecated: false + data-category: Role + data-tag-description: "The role endpoints enable you to create and view roles, + which are sets of permissions. \n\nIn NetApp Console identity and access + management (IAM), you don't assign permissions directly to users in an organization. + Instead, you assign each user a role. A role contains a set of permissions + that enables a user to perform specific actions at a specific level of the + resource hierarchy. Roles can represent actions or features, or the access + level that user has for a particular service.\n\nIAM supports several predefined + roles that you can assign to the users in your organization. Custom roles + are not supported." + data-introduced: '' + - title: User and usergroup + entries: + - title: Overview + url: "/tenancyv4/user_and_usergroup_overview.html" + - title: Create a new user group in a folder + url: "/tenancyv4/post-folders-roles-usergroups.html" + swagger-title: POST /folders/{folder_id}/roles/{role_id}/usergroups + data-api-method: POST + data-api-path: "/folders/{folder_id}/roles/{role_id}/usergroups" + data-summary: Create a new user group in a folder + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Remove a user from a folder + url: "/tenancyv4/delete-folders-roles-users-.html" + swagger-title: DELETE /folders/{folder_id}/roles/{role_id}/users/{user_id} + data-api-method: DELETE + data-api-path: "/folders/{folder_id}/roles/{role_id}/users/{user_id}" + data-summary: Remove a user from a folder + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all users for a folder + url: "/tenancyv4/get-folders-users.html" + swagger-title: GET /folders/{folder_id}/users + data-api-method: GET + data-api-path: "/folders/{folder_id}/users" + data-summary: List all users for a folder + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Add users to a folder + url: "/tenancyv4/post-folders-users.html" + swagger-title: POST /folders/{folder_id}/users + data-api-method: POST + data-api-path: "/folders/{folder_id}/users" + data-summary: Add users to a folder + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Remove a user from a folder + url: "/tenancyv4/delete-folders-users-.html" + swagger-title: DELETE /folders/{folder_id}/users/{user_id} + data-api-method: DELETE + data-api-path: "/folders/{folder_id}/users/{user_id}" + data-summary: Remove a user from a folder + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Retrieve a user associated with a folder + url: "/tenancyv4/get-folders-users-.html" + swagger-title: GET /folders/{folder_id}/users/{user_id} + data-api-method: GET + data-api-path: "/folders/{folder_id}/users/{user_id}" + data-summary: Retrieve a user associated with a folder + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Create a new user group in an organization + url: "/tenancyv4/post-organizations-roles-usergroups.html" + swagger-title: POST /organizations/{organization_id}/roles/{role_id}/usergroups + data-api-method: POST + data-api-path: "/organizations/{organization_id}/roles/{role_id}/usergroups" + data-summary: Create a new user group in an organization + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Associate users in an organization with a role + url: "/tenancyv4/post-organizations-roles-users.html" + swagger-title: POST /organizations/{organization_id}/roles/{role_id}/users + data-api-method: POST + data-api-path: "/organizations/{organization_id}/roles/{role_id}/users" + data-summary: Associate users in an organization with a role + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Remove a user from an organization + url: "/tenancyv4/delete-organizations-roles-users-.html" + swagger-title: DELETE /organizations/{organization_id}/roles/{role_id}/users/{user_id} + data-api-method: DELETE + data-api-path: "/organizations/{organization_id}/roles/{role_id}/users/{user_id}" + data-summary: Remove a user from an organization + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Create a new service account + url: "/tenancyv4/post-organizations-serviceaccounts.html" + swagger-title: POST /organizations/{organization_id}/serviceAccounts + data-api-method: POST + data-api-path: "/organizations/{organization_id}/serviceAccounts" + data-summary: Create a new service account + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Delete a service account + url: "/tenancyv4/delete-organizations-serviceaccounts-.html" + swagger-title: DELETE /organizations/{organization_id}/serviceAccounts/{serviceaccount_id} + data-api-method: DELETE + data-api-path: "/organizations/{organization_id}/serviceAccounts/{serviceaccount_id}" + data-summary: Delete a service account + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Retrieve a service account + url: "/tenancyv4/get-organizations-serviceaccounts-.html" + swagger-title: GET /organizations/{organization_id}/serviceAccounts/{serviceaccount_id} + data-api-method: GET + data-api-path: "/organizations/{organization_id}/serviceAccounts/{serviceaccount_id}" + data-summary: Retrieve a service account + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Update a service account partially + url: "/tenancyv4/patch-organizations-serviceaccounts-.html" + swagger-title: PATCH /organizations/{organization_id}/serviceAccounts/{serviceaccount_id} + data-api-method: PATCH + data-api-path: "/organizations/{organization_id}/serviceAccounts/{serviceaccount_id}" + data-summary: Update a service account partially + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Modify a service account + url: "/tenancyv4/put-organizations-serviceaccounts-.html" + swagger-title: PUT /organizations/{organization_id}/serviceAccounts/{serviceaccount_id} + data-api-method: PUT + data-api-path: "/organizations/{organization_id}/serviceAccounts/{serviceaccount_id}" + data-summary: Modify a service account + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Create a new client secret for a service account + url: "/tenancyv4/post-organizations-serviceaccounts-clientsecret.html" + swagger-title: POST /organizations/{organization_id}/serviceAccounts/{serviceaccount_id}/clientSecret + data-api-method: POST + data-api-path: "/organizations/{organization_id}/serviceAccounts/{serviceaccount_id}/clientSecret" + data-summary: Create a new client secret for a service account + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all the public keys for a service account + url: "/tenancyv4/get-organizations-serviceaccounts-publickeys.html" + swagger-title: GET /organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys + data-api-method: GET + data-api-path: "/organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys" + data-summary: List all the public keys for a service account + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Create a public key for a service account + url: "/tenancyv4/post-organizations-serviceaccounts-publickeys.html" + swagger-title: POST /organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys + data-api-method: POST + data-api-path: "/organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys" + data-summary: Create a public key for a service account + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Delete a public key for a service account + url: "/tenancyv4/delete-organizations-serviceaccounts-publickeys-.html" + swagger-title: DELETE /organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys/{publickey_id} + data-api-method: DELETE + data-api-path: "/organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys/{publickey_id}" + data-summary: Delete a public key for a service account + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Partially update a public key for a service account + url: "/tenancyv4/patch-organizations-serviceaccounts-publickeys-.html" + swagger-title: PATCH /organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys/{publickey_id} + data-api-method: PATCH + data-api-path: "/organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys/{publickey_id}" + data-summary: Partially update a public key for a service account + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all user groups under an organization + url: "/tenancyv4/get-organizations-usergroups.html" + swagger-title: GET /organizations/{organization_id}/usergroups + data-api-method: GET + data-api-path: "/organizations/{organization_id}/usergroups" + data-summary: List all user groups under an organization + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Add user groups to an organization + url: "/tenancyv4/post-organizations-usergroups.html" + swagger-title: POST /organizations/{organization_id}/usergroups + data-api-method: POST + data-api-path: "/organizations/{organization_id}/usergroups" + data-summary: Add user groups to an organization + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Remove a user group from an organization + url: "/tenancyv4/delete-organizations-usergroups-.html" + swagger-title: DELETE /organizations/{organization_id}/usergroups/{usergroup_id} + data-api-method: DELETE + data-api-path: "/organizations/{organization_id}/usergroups/{usergroup_id}" + data-summary: Remove a user group from an organization + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Retrieve a user group under an organization + url: "/tenancyv4/get-organizations-usergroups-.html" + swagger-title: GET /organizations/{organization_id}/usergroups/{usergroup_id} + data-api-method: GET + data-api-path: "/organizations/{organization_id}/usergroups/{usergroup_id}" + data-summary: Retrieve a user group under an organization + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all users under an organization + url: "/tenancyv4/get-organizations-users.html" + swagger-title: GET /organizations/{organization_id}/users + data-api-method: GET + data-api-path: "/organizations/{organization_id}/users" + data-summary: List all users under an organization + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Add users to an organization + url: "/tenancyv4/post-organizations-users.html" + swagger-title: POST /organizations/{organization_id}/users + data-api-method: POST + data-api-path: "/organizations/{organization_id}/users" + data-summary: Add users to an organization + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Remove a user from an organization + url: "/tenancyv4/delete-organizations-users-.html" + swagger-title: DELETE /organizations/{organization_id}/users/{user_id} + data-api-method: DELETE + data-api-path: "/organizations/{organization_id}/users/{user_id}" + data-summary: Remove a user from an organization + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Retrieve a user under an organization + url: "/tenancyv4/get-organizations-users-.html" + swagger-title: GET /organizations/{organization_id}/users/{user_id} + data-api-method: GET + data-api-path: "/organizations/{organization_id}/users/{user_id}" + data-summary: Retrieve a user under an organization + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Modify a user + url: "/tenancyv4/patch-organizations-users-.html" + swagger-title: PATCH /organizations/{organization_id}/users/{user_id} + data-api-method: PATCH + data-api-path: "/organizations/{organization_id}/users/{user_id}" + data-summary: Modify a user + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all users for a grant in a partnership + url: "/tenancyv4/get-partnerships-grants-users.html" + swagger-title: GET /partnerships/{partnership_id}/grants/{grant_id}/users + data-api-method: GET + data-api-path: "/partnerships/{partnership_id}/grants/{grant_id}/users" + data-summary: List all users for a grant in a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Add users to a grant in a partnership + url: "/tenancyv4/post-partnerships-grants-users.html" + swagger-title: POST /partnerships/{partnership_id}/grants/{grant_id}/users + data-api-method: POST + data-api-path: "/partnerships/{partnership_id}/grants/{grant_id}/users" + data-summary: Add users to a grant in a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Remove a user from a grant in a partnership + url: "/tenancyv4/delete-partnerships-grants-users-.html" + swagger-title: DELETE /partnerships/{partnership_id}/grants/{grant_id}/users/{user_id} + data-api-method: DELETE + data-api-path: "/partnerships/{partnership_id}/grants/{grant_id}/users/{user_id}" + data-summary: Remove a user from a grant in a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Retrieve a user with a grant in a partnership + url: "/tenancyv4/get-partnerships-grants-users-.html" + swagger-title: GET /partnerships/{partnership_id}/grants/{grant_id}/users/{user_id} + data-api-method: GET + data-api-path: "/partnerships/{partnership_id}/grants/{grant_id}/users/{user_id}" + data-summary: Retrieve a user with a grant in a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all users for a partnership + url: "/tenancyv4/get-partnerships-resourceadmins.html" + swagger-title: GET /partnerships/{partnership_id}/resourceadmins + data-api-method: GET + data-api-path: "/partnerships/{partnership_id}/resourceadmins" + data-summary: List all users for a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Add users with the ResourceAdmin role to a partnership + url: "/tenancyv4/post-partnerships-resourceadmins.html" + swagger-title: POST /partnerships/{partnership_id}/resourceadmins + data-api-method: POST + data-api-path: "/partnerships/{partnership_id}/resourceadmins" + data-summary: Add users with the ResourceAdmin role to a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Remove a user from a partnership ResourceAdmin group + url: "/tenancyv4/delete-partnerships-resourceadmins-.html" + swagger-title: DELETE /partnerships/{partnership_id}/resourceadmins/{user_id} + data-api-method: DELETE + data-api-path: "/partnerships/{partnership_id}/resourceadmins/{user_id}" + data-summary: Remove a user from a partnership ResourceAdmin group + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Retrieve a user in a partnership ResourceAdmin group + url: "/tenancyv4/get-partnerships-resourceadmins-.html" + swagger-title: GET /partnerships/{partnership_id}/resourceadmins/{user_id} + data-api-method: GET + data-api-path: "/partnerships/{partnership_id}/resourceadmins/{user_id}" + data-summary: Retrieve a user in a partnership ResourceAdmin group + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all users with the UserAdmin role in a partnership + url: "/tenancyv4/get-partnerships-useradmins.html" + swagger-title: GET /partnerships/{partnership_id}/useradmins + data-api-method: GET + data-api-path: "/partnerships/{partnership_id}/useradmins" + data-summary: List all users with the UserAdmin role in a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Add users to the UserAdmin role in a partnership + url: "/tenancyv4/post-partnerships-useradmins.html" + swagger-title: POST /partnerships/{partnership_id}/useradmins + data-api-method: POST + data-api-path: "/partnerships/{partnership_id}/useradmins" + data-summary: Add users to the UserAdmin role in a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Remove a user from the UserAdmin group in a partnership + url: "/tenancyv4/delete-partnerships-useradmins-.html" + swagger-title: DELETE /partnerships/{partnership_id}/useradmins/{user_id} + data-api-method: DELETE + data-api-path: "/partnerships/{partnership_id}/useradmins/{user_id}" + data-summary: Remove a user from the UserAdmin group in a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Retrieve a user in the UserAdmin group in a partnership + url: "/tenancyv4/get-partnerships-useradmins-.html" + swagger-title: GET /partnerships/{partnership_id}/useradmins/{user_id} + data-api-method: GET + data-api-path: "/partnerships/{partnership_id}/useradmins/{user_id}" + data-summary: Retrieve a user in the UserAdmin group in a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all users for a partnership + url: "/tenancyv4/get-partnerships-users.html" + swagger-title: GET /partnerships/{partnership_id}/users + data-api-method: GET + data-api-path: "/partnerships/{partnership_id}/users" + data-summary: List all users for a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Add users to a partnership + url: "/tenancyv4/post-partnerships-users.html" + swagger-title: POST /partnerships/{partnership_id}/users + data-api-method: POST + data-api-path: "/partnerships/{partnership_id}/users" + data-summary: Add users to a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Remove a user from a partnership + url: "/tenancyv4/delete-partnerships-users-.html" + swagger-title: DELETE /partnerships/{partnership_id}/users/{user_id} + data-api-method: DELETE + data-api-path: "/partnerships/{partnership_id}/users/{user_id}" + data-summary: Remove a user from a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Retrieve a user in a partnership + url: "/tenancyv4/get-partnerships-users-.html" + swagger-title: GET /partnerships/{partnership_id}/users/{user_id} + data-api-method: GET + data-api-path: "/partnerships/{partnership_id}/users/{user_id}" + data-summary: Retrieve a user in a partnership + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Create a new user group in a project + url: "/tenancyv4/post-projects-roles-usergroups.html" + swagger-title: POST /projects/{project_id}/roles/{role_id}/usergroups + data-api-method: POST + data-api-path: "/projects/{project_id}/roles/{role_id}/usergroups" + data-summary: Create a new user group in a project + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Remove a user from a project + url: "/tenancyv4/delete-projects-roles-users-.html" + swagger-title: DELETE /projects/{project_id}/roles/{role_id}/users/{user_id} + data-api-method: DELETE + data-api-path: "/projects/{project_id}/roles/{role_id}/users/{user_id}" + data-summary: Remove a user from a project + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all users for a project + url: "/tenancyv4/get-projects-users.html" + swagger-title: GET /projects/{project_id}/users + data-api-method: GET + data-api-path: "/projects/{project_id}/users" + data-summary: List all users for a project + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Add users to a project + url: "/tenancyv4/post-projects-users.html" + swagger-title: POST /projects/{project_id}/users + data-api-method: POST + data-api-path: "/projects/{project_id}/users" + data-summary: Add users to a project + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Remove a user from a project + url: "/tenancyv4/delete-projects-users-.html" + swagger-title: DELETE /projects/{project_id}/users/{user_id} + data-api-method: DELETE + data-api-path: "/projects/{project_id}/users/{user_id}" + data-summary: Remove a user from a project + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Retrieve a user under a project + url: "/tenancyv4/get-projects-users-.html" + swagger-title: GET /projects/{project_id}/users/{user_id} + data-api-method: GET + data-api-path: "/projects/{project_id}/users/{user_id}" + data-summary: Retrieve a user under a project + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all users with a specific permission for a resource + url: "/tenancyv4/get-resources-permissions-users.html" + swagger-title: GET /resources/{resource_id}/permissions/{permission_id}/users + data-api-method: GET + data-api-path: "/resources/{resource_id}/permissions/{permission_id}/users" + data-summary: List all users with a specific permission for a resource + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Retrieve a user with a permission for a resource + url: "/tenancyv4/get-resources-permissions-users-.html" + swagger-title: GET /resources/{resource_id}/permissions/{permission_id}/users/{user_id} + data-api-method: GET + data-api-path: "/resources/{resource_id}/permissions/{permission_id}/users/{user_id}" + data-summary: Retrieve a user with a permission for a resource + data-deprecated: false + data-category: User and Usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all users with permissions for a resource + url: "/tenancyv4/get-resources-users.html" + swagger-title: GET /resources/{resource_id}/users + data-api-method: GET + data-api-path: "/resources/{resource_id}/users" + data-summary: List all users with permissions for a resource + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all user groups + url: "/tenancyv4/get-usergroups.html" + swagger-title: GET /usergroups + data-api-method: GET + data-api-path: "/usergroups" + data-summary: List all user groups + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Create a new user group + url: "/tenancyv4/post-usergroups.html" + swagger-title: POST /usergroups + data-api-method: POST + data-api-path: "/usergroups" + data-summary: Create a new user group + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Delete a user group + url: "/tenancyv4/delete-usergroups-.html" + swagger-title: DELETE /usergroups/{usergroup_id} + data-api-method: DELETE + data-api-path: "/usergroups/{usergroup_id}" + data-summary: Delete a user group + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Retrieve a user group + url: "/tenancyv4/get-usergroups-.html" + swagger-title: GET /usergroups/{usergroup_id} + data-api-method: GET + data-api-path: "/usergroups/{usergroup_id}" + data-summary: Retrieve a user group + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Update a user group partially + url: "/tenancyv4/patch-usergroups-.html" + swagger-title: PATCH /usergroups/{usergroup_id} + data-api-method: PATCH + data-api-path: "/usergroups/{usergroup_id}" + data-summary: Update a user group partially + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Modify a user group + url: "/tenancyv4/put-usergroups-.html" + swagger-title: PUT /usergroups/{usergroup_id} + data-api-method: PUT + data-api-path: "/usergroups/{usergroup_id}" + data-summary: Modify a user group + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all users for a user group + url: "/tenancyv4/get-usergroups-users.html" + swagger-title: GET /usergroups/{usergroup_id}/users + data-api-method: GET + data-api-path: "/usergroups/{usergroup_id}/users" + data-summary: List all users for a user group + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Add users to a user group + url: "/tenancyv4/post-usergroups-users.html" + swagger-title: POST /usergroups/{usergroup_id}/users + data-api-method: POST + data-api-path: "/usergroups/{usergroup_id}/users" + data-summary: Add users to a user group + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Remove a user from a user group + url: "/tenancyv4/delete-usergroups-users-.html" + swagger-title: DELETE /usergroups/{usergroup_id}/users/{user_id} + data-api-method: DELETE + data-api-path: "/usergroups/{usergroup_id}/users/{user_id}" + data-summary: Remove a user from a user group + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Retrieve a user in a user group + url: "/tenancyv4/get-usergroups-users-.html" + swagger-title: GET /usergroups/{usergroup_id}/users/{user_id} + data-api-method: GET + data-api-path: "/usergroups/{usergroup_id}/users/{user_id}" + data-summary: Retrieve a user in a user group + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: List all users + url: "/tenancyv4/get-users.html" + swagger-title: GET /users + data-api-method: GET + data-api-path: "/users" + data-summary: List all users + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Create a new user + url: "/tenancyv4/post-users.html" + swagger-title: POST /users + data-api-method: POST + data-api-path: "/users" + data-summary: Create a new user + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Delete a user + url: "/tenancyv4/delete-users-.html" + swagger-title: DELETE /users/{user_id} + data-api-method: DELETE + data-api-path: "/users/{user_id}" + data-summary: Delete a user + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Retrieve a user + url: "/tenancyv4/get-users-.html" + swagger-title: GET /users/{user_id} + data-api-method: GET + data-api-path: "/users/{user_id}" + data-summary: Retrieve a user + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Update a user partially + url: "/tenancyv4/patch-users-.html" + swagger-title: PATCH /users/{user_id} + data-api-method: PATCH + data-api-path: "/users/{user_id}" + data-summary: Update a user partially + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - title: Modify a user + url: "/tenancyv4/put-users-.html" + swagger-title: PUT /users/{user_id} + data-api-method: PUT + data-api-path: "/users/{user_id}" + data-summary: Modify a user + data-deprecated: false + data-category: User and usergroup + data-tag-description: |- + The user and usergroup endpoints enable you to create and manage users and user groups. + + In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + + A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + data-introduced: '' + - section: automate + - section: support + - title: Legal notices + url: "/legal-notices.html" +product-family: + name: NetApp Console + repo: console-family diff --git a/tenancy/account_overview.adoc b/tenancy/account_overview.adoc new file mode 100644 index 00000000..954473a1 --- /dev/null +++ b/tenancy/account_overview.adoc @@ -0,0 +1,27 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/account_overview.html' +summary: 'Account endpoints in the Accounts REST API' +--- + += Account endpoints in the Accounts REST API + + + ++++
    +++The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following: * Single person * Group of people * Internal software service + +A single person or group of people is identified through a user token. A software service is represented with a service token. + +At a high level, an account is a collection of the following: + +* Associated person or group of people or software service * One or more workspaces * One or more BlueXP Connectors + +Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account. + +The following actions can be performed with the account endpoints: + +* Create an account * Delete an account * Associate a user (person) to an account * Disassociate a user from an account * List the users of an account * List the services (service accounts) of an account * List the members (users and services) of an account * List the roles and permissions of an account * Leave an account * Allow a user to enable or disable receiving BlueXP notifications * List the accounts a user is associated with * Migrate the configuration data from one account to another account * Rename an account * Set miscellaneous account enablement options+++
    +++ + + diff --git a/tenancy/authorize_overview.adoc b/tenancy/authorize_overview.adoc new file mode 100644 index 00000000..6474aa47 --- /dev/null +++ b/tenancy/authorize_overview.adoc @@ -0,0 +1,19 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/authorize_overview.html' +summary: 'Authorize endpoints in the Accounts REST API' +--- + += Authorize endpoints in the Accounts REST API + + + ++++
    +++The authorization endpoints provide the ability to set various permissions for workspaces, Connectors, and resources that allow them to take specific actions. + +The following actions can be performed with the authorization endpoints: + +* Authorize a resource to take specific actions * Authorize a Connector * Authorize a workspace and a Connector in the workspace * Authorize a user as an account administrator * Authorize a user in an account * Authorize an agent in an account+++
    +++ + + diff --git a/tenancy/delete-tenancy-account-id.adoc b/tenancy/delete-tenancy-account-id.adoc new file mode 100644 index 00000000..a56eafec --- /dev/null +++ b/tenancy/delete-tenancy-account-id.adoc @@ -0,0 +1,61 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/delete-tenancy-account-id.html' +summary: 'Delete an account' +--- + += Delete an account + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/tenancy/account/{accountId}`# + + + +Deletes the specified account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/delete-tenancy-account-service-account-del.adoc b/tenancy/delete-tenancy-account-service-account-del.adoc new file mode 100644 index 00000000..8a1d938d --- /dev/null +++ b/tenancy/delete-tenancy-account-service-account-del.adoc @@ -0,0 +1,73 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/delete-tenancy-account-service-account-del.html' +summary: 'Delete a service account' +--- + += Delete a service account + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/tenancy/account/{accountId}/service-account/{serviceAccountId}`# + + + +Deletes a service account from a specified account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|serviceAccountId +|string +|path +|True +a|Service Account Client ID. Do not provide the Service Account Public ID. + +* example: BjwDgGkg28cLKg70pLUwz9rY87Ff5xHK + + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/delete-tenancy-account-workspace-id.adoc b/tenancy/delete-tenancy-account-workspace-id.adoc new file mode 100644 index 00000000..deb9f4af --- /dev/null +++ b/tenancy/delete-tenancy-account-workspace-id.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/delete-tenancy-account-workspace-id.html' +summary: 'Delete a workspace' +--- + += Delete a workspace + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/tenancy/account/{accountId}/workspace/{workspacePublicId}`# + + + +Deletes a specified workspace. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workspacePublicId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/delete-tenancy-resource-id.adoc b/tenancy/delete-tenancy-resource-id.adoc new file mode 100644 index 00000000..d620659e --- /dev/null +++ b/tenancy/delete-tenancy-resource-id.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/delete-tenancy-resource-id.html' +summary: 'Delete a resource from an account' +--- + += Delete a resource from an account + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/tenancy/resource/{resourceIdentifier}`# + + + +Deletes a resource from a specified account. accountId must be passed to the X-Tenancy-Account-Id request header. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|resourceIdentifier +|string +|path +|True +a| + +|Authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Tenancy-Account-Id +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/delete-tenancy-service-resource-.adoc b/tenancy/delete-tenancy-service-resource-.adoc new file mode 100644 index 00000000..c356087b --- /dev/null +++ b/tenancy/delete-tenancy-service-resource-.adoc @@ -0,0 +1,109 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/delete-tenancy-service-resource-.html' +summary: 'Delete service resources' +--- + += Delete service resources + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/tenancy/service-resources`# + + + +Deletes service resources from a specified account. + + +*Token usage:* BlueXP service token with the following scopes: tenancy:internal. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resourceIdentifiers +|array[string] +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "resourceIdentifiers": [ + "string" + ] +} +==== + +== Response + +``` +Status: 200, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resourceIdentifiers +|array[string] +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/delete-tenancy-service-resource-id.adoc b/tenancy/delete-tenancy-service-resource-id.adoc new file mode 100644 index 00000000..78f7f986 --- /dev/null +++ b/tenancy/delete-tenancy-service-resource-id.adoc @@ -0,0 +1,55 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/delete-tenancy-service-resource-id.html' +summary: 'Delete a service resource' +--- + += Delete a service resource + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/tenancy/service-resource/{resourceIdentifier}`# + + + +Deletes a service resource from a specified account. + + +*Token usage:* BlueXP service token with the following scopes: tenancy:internal. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|resourceIdentifier +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/get-tenancy-account-id.adoc b/tenancy/get-tenancy-account-id.adoc new file mode 100644 index 00000000..b5bdf9e2 --- /dev/null +++ b/tenancy/get-tenancy-account-id.adoc @@ -0,0 +1,111 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/get-tenancy-account-id.html' +summary: 'Retrieve an account' +--- + += Retrieve an account + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenancy/account/{accountId}`# + + + +Retrieves a specific account by an account identifier. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountPublicId +|string +|False +a| + +|accountName +|string +|False +a| + +|isRestricted +|boolean +|False +a| + +|isPrivatePreviewEnabled +|boolean +|False +a| + +|is3rdPartyServicesEnabled +|boolean +|False +a| + +|accountSerial +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountPublicId": "string", + "accountName": "string", + "accountSerial": "string" +} +==== + diff --git a/tenancy/get-tenancy-account-members.adoc b/tenancy/get-tenancy-account-members.adoc new file mode 100644 index 00000000..9d93d0b2 --- /dev/null +++ b/tenancy/get-tenancy-account-members.adoc @@ -0,0 +1,61 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/get-tenancy-account-members.html' +summary: 'Retrieve user and service account data' +--- + += Retrieve user and service account data + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenancy/account/{accountId}/members`# + + + +Retrieves the user and service account data of the specified account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/get-tenancy-account-permissions-for-user.adoc b/tenancy/get-tenancy-account-permissions-for-user.adoc new file mode 100644 index 00000000..5baada8b --- /dev/null +++ b/tenancy/get-tenancy-account-permissions-for-user.adoc @@ -0,0 +1,94 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/get-tenancy-account-permissions-for-user.html' +summary: 'Retrieve user role and permissions' +--- + += Retrieve user role and permissions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenancy/account/{accountId}/permissions-for-user`# + + + +Retrieves the user role and permissions of the specified account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|role +|string +|False +a| + +|permissions +|array[string] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "role": "string", + "permissions": [ + "string" + ] +} +==== + diff --git a/tenancy/get-tenancy-account-service-accounts.adoc b/tenancy/get-tenancy-account-service-accounts.adoc new file mode 100644 index 00000000..87e3ed69 --- /dev/null +++ b/tenancy/get-tenancy-account-service-accounts.adoc @@ -0,0 +1,61 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/get-tenancy-account-service-accounts.html' +summary: 'Retrieve service account data' +--- + += Retrieve service account data + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenancy/account/{accountId}/service-accounts`# + + + +Retrieves the service account data of the specified account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/get-tenancy-account-user-workspaces.adoc b/tenancy/get-tenancy-account-user-workspaces.adoc new file mode 100644 index 00000000..7071326c --- /dev/null +++ b/tenancy/get-tenancy-account-user-workspaces.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/get-tenancy-account-user-workspaces.html' +summary: 'Retrieve user account workspaces' +--- + += Retrieve user account workspaces + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenancy/account/{accountId}/user/{userId}/workspaces`# + + + +Retrieves specified user account workspaces. + + +*Token usage:* BlueXP service token with the following scopes: tenancy:external. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|userId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/get-tenancy-account-users.adoc b/tenancy/get-tenancy-account-users.adoc new file mode 100644 index 00000000..4fdb0344 --- /dev/null +++ b/tenancy/get-tenancy-account-users.adoc @@ -0,0 +1,61 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/get-tenancy-account-users.html' +summary: 'Retrieve user data' +--- + += Retrieve user data + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenancy/account/{accountId}/users`# + + + +Retrieves the user data of the specified account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/get-tenancy-account-workspace-agents.adoc b/tenancy/get-tenancy-account-workspace-agents.adoc new file mode 100644 index 00000000..ff575d02 --- /dev/null +++ b/tenancy/get-tenancy-account-workspace-agents.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/get-tenancy-account-workspace-agents.html' +summary: 'Retrieve agents' +--- + += Retrieve agents + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenancy/account/{accountId}/workspace/{workspacePublicId}/agents`# + + + +Retrieves agents associated with a specified workspace. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workspacePublicId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/get-tenancy-account-workspace.adoc b/tenancy/get-tenancy-account-workspace.adoc new file mode 100644 index 00000000..0e96bdd3 --- /dev/null +++ b/tenancy/get-tenancy-account-workspace.adoc @@ -0,0 +1,61 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/get-tenancy-account-workspace.html' +summary: 'Retrieve workspaces' +--- + += Retrieve workspaces + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenancy/account/{accountId}/workspace`# + + + +Retrieves workspaces associated with a specified account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/get-tenancy-account.adoc b/tenancy/get-tenancy-account.adoc new file mode 100644 index 00000000..9dba7050 --- /dev/null +++ b/tenancy/get-tenancy-account.adoc @@ -0,0 +1,55 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/get-tenancy-account.html' +summary: 'Retrieve user accounts' +--- + += Retrieve user accounts + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenancy/account`# + + + +Retrieves all accounts related to the user. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/get-tenancy-resource.adoc b/tenancy/get-tenancy-resource.adoc new file mode 100644 index 00000000..85dc2270 --- /dev/null +++ b/tenancy/get-tenancy-resource.adoc @@ -0,0 +1,79 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/get-tenancy-resource.html' +summary: 'Retrieve a resource' +--- + += Retrieve a resource + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenancy/resource`# + + + +Retrieves a resource for an account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|account +|string +|query +|True +a| + +|resource-type +|string +|query +|False +a| + +|workspace +|string +|query +|False +a| + +|resource-class +|string +|query +|False +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/get-tenancy-users-for-action--id.adoc b/tenancy/get-tenancy-users-for-action--id.adoc new file mode 100644 index 00000000..6f77eeb4 --- /dev/null +++ b/tenancy/get-tenancy-users-for-action--id.adoc @@ -0,0 +1,100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/get-tenancy-users-for-action--id.html' +summary: 'Retrieve users authorized for single resource' +--- + += Retrieve users authorized for single resource + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenancy/users/for-action/{accountId}/{action}/{resourceId}`# + + + +Retrieves users authorized for actions on a particular resource. + + +*Token usage:* BlueXP service token with the following scopes: tenancy:internal. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|enforce_ws +|boolean +|query +|False +a| + +|accountId +|string +|path +|True +a| + +|action +|string +|path +|True +a| + +|resourceId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|userIds +|array[string] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "userIds": [ + "string" + ] +} +==== + diff --git a/tenancy/get-tenancy-users-for-action-id.adoc b/tenancy/get-tenancy-users-for-action-id.adoc new file mode 100644 index 00000000..acb2d8df --- /dev/null +++ b/tenancy/get-tenancy-users-for-action-id.adoc @@ -0,0 +1,88 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/get-tenancy-users-for-action-id.html' +summary: 'Retrieve users authorized for all resources' +--- + += Retrieve users authorized for all resources + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/tenancy/users/for-action/{accountId}/{action}`# + + + +Retrieves users authorized for actions across all resources. + + +*Token usage:* BlueXP service token with the following scopes: tenancy:internal. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|action +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|userIds +|array[string] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "userIds": [ + "string" + ] +} +==== + diff --git a/tenancy/overview.adoc b/tenancy/overview.adoc new file mode 100644 index 00000000..d4df44cc --- /dev/null +++ b/tenancy/overview.adoc @@ -0,0 +1,186 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/overview.html' +summary: 'Accounts REST API' +--- + += Accounts REST API + + + +The Tenancy service provides secure and granular role-based access control (RBAC) for the resources in the BlueXP platform when using BlueXP in restricted mode or private mode. + + +It consists of several internal major components that operate together to enable and restrict resource access. + +The service operates within the context of a BlueXP account. The identity of the API caller and the account are established through a user or service token. + +If you're using BlueXP in standard mode, you no longer have a BlueXP account. Instead, you have a BlueXP organization that you manage using BlueXP identity and access management (IAM). A separate API is available for BlueXP IAM. If you've been using the tenancy API to manage accounts, the API for BlueXP IAM is backwards compatible with the tenancy API. +https://docs.netapp.com/us-en/bluexp-automation/tenancyv4/overview.html[View the API for BlueXP IAM] + +There are six components defined within the Tenancy service. + +* account +* authorize +* resource +* service account +* user +* workspace + +**Note**: Before using the API reference documentation, review the https://docs.netapp.com/us-en/cloud-manager-automation/platform/overview.html[Get started] section for the BlueXP APIs. For more information about the security tokens and identifiers you'll need when using the API, review the https://docs.netapp.com/us-en/cloud-manager-automation/platform/get_identifiers.html[Common workflows and tasks] section. + +''' + +== REST implementation + +=== HTTP methods + +|=== +| Method | Description + +| `POST` +| Create an object instance + +| `GET` +| Retrieve an object instance or collection + +| `PATCH` +| Update an existing object + +| `DELETE` +| Remove an existing object +|=== + +=== Request headers + +|=== +| Request Header | Description + +| `Authorization` +| Required. Contains a JWT access token + +| `X-service-request-id` +| Used to tag a request with application-specific keys for improved supportability + +| `X-agent-id` +| Contains the BlueXP Connector ID and can be included depending on the call + +| `X-tenancy-account-id` +| Contains the account identifier and can be included depending on the call +|=== + +=== Query parameters + +You can use query parameters with endpoints in the following components: + +|=== +| Component | Query Parameter + +| Resource +| account (required) + +resourceType + +workspace + +resourceClass + +resourceId + +| +| +|=== + +=== Response headers + +This API uses the standard HTTP response headers common with all BlueXP APIs. See https://docs.netapp.com/us-en/cloud-manager-automation/platform/http_details.html[REST implementation] for more information. + +=== HTTP status codes + +|=== +| HTTP Status Code | Description + +| `200` +| OK: Returned for successful operation completion + +| `400` +| Bad Request: Returned if the input is malformed and could not be parsed + +| `401` +| Unauthorized: Returned if user authentication failed or the token has expired + +| `403` +| Forbidden: Returned for authorization errors depending on the resource and token +|=== + +''' + +== Error handling + +There are three processes involved with error handling and processing. + +* The error is logged for supportability +* The error is also returned to the caller for any specific handling +* The database connection is rolled back + +''' + +== cURL examples + +=== Retrieve resources for a specified account + +This example retrieves the resources for a specified account. + +.... + + curl -X GET "https://cloudmanager.cloud.netapp.com/tenancy/resource?account=" -H "accept: application/json" -H "authorization: " +.... + +''' + +== Frequently asked questions + +**What is the use case for account migration, where the account configuration data is moved from one account to another?** + +Suppose a company is in stealth mode and doing a proof of concept (PoC) with a BlueXP account. If it's successful, the company might want to move from the PoC account to a development account. Another migration use case is account consolidation. + +**If the '`CMNotificationOptIn`' account option is enabled, will all users associated with the account receive the BlueXP event notifications?** + +No. The API endpoint used in this case is "PATCH tenancy/account/\{accountId}/update-user". The occm service token is carried in the "authorization" request header and the specific user to receive the notifications is identified with the "x-user-token" header. + +**What are the SaaS enablement and third-part service enablement options for a BlueXP account?** + +SaaS enablement is used to allow an account to have access to the BlueXP portal. Third-party service enablement allows or enables third party services (such as Fluid). + +**What are some examples of actions that can be performed with the Authorize REST endpoint?** + +Actions are defined as permissions. The general definition pattern is `:`. Two examples include `accounts:create` and `workspace:*`. + +**The API endpoint 'authorize-user-is-in-account' only accepts the parameter '`accountId`'. In this case, how does the API determine which user is to be authorized?** + +It checks if the user belongs to the account. The '`authorization`' header contains the user token identifying the user. One possible use case is account migration, where the application continually polls to determine if all the users are migrated to the destination account. + +**The API endpoint 'authorize-agent-in-account' accepts the '`x-agent-id`' request header. What does this mean?** + +The '`authorization`' header contains the user token and the '`x-agent-id`' header has the BlueXP client identifier. + +**Every BlueXP resource has the data field '`cloud_id`'. What is this field and how is it used?** + +This field is the cloud identifier for the resource. For example, this could be the cloud VM ID. + +**Every resource can be associated with one or more workspaces, which is a 1:N relationship model. Why would a resource be associated with more than one workspace?** + +An account or workspace administrator can manage multiple workspaces. In this case, for example, it's possible to have one NetApp Cloud Volumes Service resource in multiple workspaces. + +**What is the difference between discovering a resource and creating a resource?** + +Discovery is the process of locating an existing resource and attaching it to the account. Creating a resource, on the other hand, first involves various allocation and provisioning operations and then attaching the resource. + +**What is a service resource? Why is DELETE the only supported operation? Are there other options available when managing a service resource?** + +This question applies to the following REST API call: "DELETE /tenancy/service-resource/\{resource-id}". There is no special meaning associated with a service resource. It's just another way for services to delete resources. + +**There is an API operation '`remove-resource-from-agent`'. Why isn't there a corresponding '`add-to-agent`' call?** + +The add operation occurs during resource discovery or creation. From the view of an external BlueXP user, only the Connector can discover and create resources. However, internally there are some resources available without explicitly attaching them to the Connector (such as license and persistence). These resources instead belong to the account. + +{blank} + + + + + diff --git a/tenancy/patch-tenancy-account-service-account-pat.adoc b/tenancy/patch-tenancy-account-service-account-pat.adoc new file mode 100644 index 00000000..6599020c --- /dev/null +++ b/tenancy/patch-tenancy-account-service-account-pat.adoc @@ -0,0 +1,159 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/patch-tenancy-account-service-account-pat.html' +summary: 'Update details' +--- + += Update details + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/tenancy/account/{accountId}/service-account/{serviceAccountId}`# + + + +Updates the service account details of a specified account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|serviceAccountId +|string +|path +|True +a|Service Account Client ID. Do not provide the Service Account Public ID. + +* example: BjwDgGkg28cLKg70pLUwz9rY87Ff5xHK + + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serviceAccountName +|string +|False +a|Service account name + + +|rolePublicId +|string +|False +a|Service account role + + +|workspacePublicIds +|array[string] +|False +a|Service account workspaces + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serviceAccountName": "string", + "rolePublicId": "string", + "workspacePublicIds": [ + "string" + ] +} +==== + +== Response + +``` +Status: 200, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serviceAccountName +|string +|False +a|Service account name + + +|rolePublicId +|string +|False +a|Service account role + + +|workspacePublicIds +|array[string] +|False +a|Service account workspaces + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/patch-tenancy-account-update-user.adoc b/tenancy/patch-tenancy-account-update-user.adoc new file mode 100644 index 00000000..8afb50eb --- /dev/null +++ b/tenancy/patch-tenancy-account-update-user.adoc @@ -0,0 +1,112 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/patch-tenancy-account-update-user.html' +summary: 'Enable Cloud Manager notifications' +--- + += Enable Cloud Manager notifications + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/tenancy/account/{accountId}/update-user`# + + + +Updates the user cloudManagerNotificationsOptIn property of the specified account. + The cloudManagerNotificationsOptIn property determines whether the user receives BlueXP notifications. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudManagerNotificationsOptIn +|boolean +|True +a| + +|=== + + +== Response + +``` +Status: 200, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudManagerNotificationsOptIn +|boolean +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/patch-tenancy-account-workspace-id.adoc b/tenancy/patch-tenancy-account-workspace-id.adoc new file mode 100644 index 00000000..ab4e380c --- /dev/null +++ b/tenancy/patch-tenancy-account-workspace-id.adoc @@ -0,0 +1,157 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/patch-tenancy-account-workspace-id.html' +summary: 'Rename a workspace' +--- + += Rename a workspace + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/tenancy/account/{accountId}/workspace/{workspacePublicId}`# + + + +Renames a workspace with a specified new name. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workspacePublicId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newName +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "newName": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workspacePublicId +|string +|False +a| + +|workspaceName +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "workspacePublicId": "string", + "workspaceName": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|newName +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-account-associate.adoc b/tenancy/post-tenancy-account-associate.adoc new file mode 100644 index 00000000..5723e5bc --- /dev/null +++ b/tenancy/post-tenancy-account-associate.adoc @@ -0,0 +1,177 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-associate.html' +summary: 'Associate a user' +--- + += Associate a user + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountId}/associate`# + + + +Associates the user to the account by using the user email. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|associatedEmail +|string +|False +a|User email to be associated with the account + + +|rolePublicId +|string +|False +a|User role name. For example, use Role-1 for account admin or Role-2 for workspace admin. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "associatedEmail": "string", + "rolePublicId": "Role-1" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|userPublicId +|string +|False +a| + +|userClientId +|string +|False +a| + +|userRole +|string +|False +a| + +|cloudManagerNotificationsOptIn +|boolean +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "userPublicId": "string", + "userClientId": "string", + "userRole": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|associatedEmail +|string +|False +a|User email to be associated with the account + + +|rolePublicId +|string +|False +a|User role name. For example, use Role-1 for account admin or Role-2 for workspace admin. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-account-dest-account-.adoc b/tenancy/post-tenancy-account-dest-account-.adoc new file mode 100644 index 00000000..4953e4e4 --- /dev/null +++ b/tenancy/post-tenancy-account-dest-account-.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/post-tenancy-account-dest-account-.html' +summary: 'Move account data' +--- + += Move account data + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{srcAccountId}/dest/account/{dstAccountId}`# + + + +Moves account data from the source account to the destination account. + + +*Token usage:* BlueXP service token with the following scopes: tenancy:support. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|srcAccountId +|string +|path +|True +a| + +|dstAccountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/post-tenancy-account-disassociate.adoc b/tenancy/post-tenancy-account-disassociate.adoc new file mode 100644 index 00000000..14c89894 --- /dev/null +++ b/tenancy/post-tenancy-account-disassociate.adoc @@ -0,0 +1,120 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-disassociate.html' +summary: 'Dissociate a user' +--- + += Dissociate a user + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountId}/disassociate`# + + + +Disassociates the user from the specified account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|associatedUserPublicId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "associatedUserPublicId": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|associatedUserPublicId +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-account-enable-3rd-party-services-id.adoc b/tenancy/post-tenancy-account-enable-3rd-party-services-id.adoc new file mode 100644 index 00000000..34b76fbe --- /dev/null +++ b/tenancy/post-tenancy-account-enable-3rd-party-services-id.adoc @@ -0,0 +1,73 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-enable-3rd-party-services-id.html' +summary: 'Enable third-party services' +--- + += Enable third-party services + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountId}/enable-3rd-party-services/{enabled}`# + + + +Sets the third-party enabled property of the specified account. + The enabled property determines whether third-party services are enabled for the account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|enabled +|boolean +|path +|True +a|* Max value: 1 +* Min value: 0 + + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/post-tenancy-account-enable-private-preview-id.adoc b/tenancy/post-tenancy-account-enable-private-preview-id.adoc new file mode 100644 index 00000000..56e8ba29 --- /dev/null +++ b/tenancy/post-tenancy-account-enable-private-preview-id.adoc @@ -0,0 +1,73 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-enable-private-preview-id.html' +summary: 'Enable private preview for SaaS' +--- + += Enable private preview for SaaS + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountId}/enable-private-preview/{privatePreviewEnabled}`# + + + +Sets the privatePreviewEnabled property of the specified account. + The privatePreviewEnabled property determines whether private preview of the SaaS interface is enabled. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|privatePreviewEnabled +|boolean +|path +|True +a|* Max value: 1 +* Min value: 0 + + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/post-tenancy-account-id.adoc b/tenancy/post-tenancy-account-id.adoc new file mode 100644 index 00000000..b23af868 --- /dev/null +++ b/tenancy/post-tenancy-account-id.adoc @@ -0,0 +1,112 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-id.html' +summary: 'Create an account' +--- + += Create an account + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountName}`# + + + +Creates a new account with the specified account name. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountName +|string +|path +|True +a|Account name + +* pattern: {caret}[-_.a-zA-Z0-9]{1,40}$ + + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|isSaasDisabled +|boolean +|False +a|Specifies if created account is saas disabled, default false + + +|=== + + +== Response + +``` +Status: 200, Successful create account response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountPublicId +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountPublicId": "string" +} +==== + diff --git a/tenancy/post-tenancy-account-leave.adoc b/tenancy/post-tenancy-account-leave.adoc new file mode 100644 index 00000000..eaf38119 --- /dev/null +++ b/tenancy/post-tenancy-account-leave.adoc @@ -0,0 +1,61 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-leave.html' +summary: 'Delete a user' +--- + += Delete a user + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountId}/leave`# + + + +Removes the user from the specified account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/post-tenancy-account-rename-id.adoc b/tenancy/post-tenancy-account-rename-id.adoc new file mode 100644 index 00000000..f7fe0dc9 --- /dev/null +++ b/tenancy/post-tenancy-account-rename-id.adoc @@ -0,0 +1,71 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-rename-id.html' +summary: 'Rename an account' +--- + += Rename an account + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountId}/rename/{newAccountName}`# + + + +Renames the specified account with a specified new name. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|newAccountName +|string +|path +|True +a|* pattern: {caret}[-_.a-zA-Z0-9]{1,40}$ + + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/post-tenancy-account-service-account-generate-service-account-secret.adoc b/tenancy/post-tenancy-account-service-account-generate-service-account-secret.adoc new file mode 100644 index 00000000..2b6a8fff --- /dev/null +++ b/tenancy/post-tenancy-account-service-account-generate-service-account-secret.adoc @@ -0,0 +1,104 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-service-account-generate-service-account-secret.html' +summary: 'Generate a secret' +--- + += Generate a secret + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountId}/service-account/{serviceAccountId}/generate-service-account-secret`# + + + +Generates the service account secret. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|serviceAccountId +|string +|path +|True +a|Service Account Client ID. Do not provide the Service Account Public ID. + +* example: BjwDgGkg28cLKg70pLUwz9rY87Ff5xHK + + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clientId +|string +|False +a| + +|clientSecret +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "clientId": "string", + "clientSecret": "string" +} +==== + diff --git a/tenancy/post-tenancy-account-service-account.adoc b/tenancy/post-tenancy-account-service-account.adoc new file mode 100644 index 00000000..415e439e --- /dev/null +++ b/tenancy/post-tenancy-account-service-account.adoc @@ -0,0 +1,187 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-service-account.html' +summary: 'Create a service account' +--- + += Create a service account + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountId}/service-account`# + + + +Creates a service account on a specified account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serviceAccountName +|string +|True +a|Service account name + + +|rolePublicId +|string +|True +a|Service account role + + +|workspacePublicIds +|array[string] +|False +a|Service account workspaces + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "serviceAccountName": "string", + "rolePublicId": "string", + "workspacePublicIds": [ + "string" + ] +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|clientId +|string +|False +a| + +|clientSecret +|string +|False +a| + +|publicId +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "clientId": "string", + "clientSecret": "string", + "publicId": "string" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|serviceAccountName +|string +|True +a|Service account name + + +|rolePublicId +|string +|True +a|Service account role + + +|workspacePublicIds +|array[string] +|False +a|Service account workspaces + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-account-workspace-add-agent-id.adoc b/tenancy/post-tenancy-account-workspace-add-agent-id.adoc new file mode 100644 index 00000000..d581e662 --- /dev/null +++ b/tenancy/post-tenancy-account-workspace-add-agent-id.adoc @@ -0,0 +1,73 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-workspace-add-agent-id.html' +summary: 'Add an agent' +--- + += Add an agent + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountId}/workspace/{workspacePublicId}/add-agent/{agentAuth0Id}`# + + + +Adds an agent to a specified workspace. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|agentAuth0Id +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|workspacePublicId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/post-tenancy-account-workspace-add-user-id.adoc b/tenancy/post-tenancy-account-workspace-add-user-id.adoc new file mode 100644 index 00000000..66316e8e --- /dev/null +++ b/tenancy/post-tenancy-account-workspace-add-user-id.adoc @@ -0,0 +1,73 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-workspace-add-user-id.html' +summary: 'Add a user' +--- + += Add a user + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountId}/workspace/{workspacePublicId}/add-user/{userPublicId}`# + + + +Adds a user to a specified workspace. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|workspacePublicId +|string +|path +|True +a| + +|userPublicId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/post-tenancy-account-workspace-id.adoc b/tenancy/post-tenancy-account-workspace-id.adoc new file mode 100644 index 00000000..6182c8bb --- /dev/null +++ b/tenancy/post-tenancy-account-workspace-id.adoc @@ -0,0 +1,102 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-workspace-id.html' +summary: 'Create a workspace' +--- + += Create a workspace + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountId}/workspace/{name}`# + + + +Creates a workspace in a specified account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountId +|string +|path +|True +a| + +|name +|string +|path +|True +a|* pattern: {caret}[-_.a-zA-Z0-9]{1,40}$ + + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workspacePublicId +|string +|False +a| + +|workspaceName +|string +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "workspacePublicId": "string", + "workspaceName": "string" +} +==== + diff --git a/tenancy/post-tenancy-account-workspace-remove-agent-id.adoc b/tenancy/post-tenancy-account-workspace-remove-agent-id.adoc new file mode 100644 index 00000000..f07adbe6 --- /dev/null +++ b/tenancy/post-tenancy-account-workspace-remove-agent-id.adoc @@ -0,0 +1,73 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-workspace-remove-agent-id.html' +summary: 'Remove an agent' +--- + += Remove an agent + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountId}/workspace/{workspacePublicId}/remove-agent/{agentAuth0Id}`# + + + +Removes an agent from a specified workspace. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|agentAuth0Id +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|workspacePublicId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/post-tenancy-account-workspace-remove-user-id.adoc b/tenancy/post-tenancy-account-workspace-remove-user-id.adoc new file mode 100644 index 00000000..8835b6d8 --- /dev/null +++ b/tenancy/post-tenancy-account-workspace-remove-user-id.adoc @@ -0,0 +1,73 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-account-workspace-remove-user-id.html' +summary: 'Remove a user' +--- + += Remove a user + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/account/{accountPublicId}/workspace/{workspacePublicId}/remove-user/{userPublicId}`# + + + +Removes a user from a specified workspace. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|accountPublicId +|string +|path +|True +a| + +|workspacePublicId +|string +|path +|True +a| + +|userPublicId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/post-tenancy-authorize-agent-in-account.adoc b/tenancy/post-tenancy-authorize-agent-in-account.adoc new file mode 100644 index 00000000..fc887f9f --- /dev/null +++ b/tenancy/post-tenancy-authorize-agent-in-account.adoc @@ -0,0 +1,111 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/post-tenancy-authorize-agent-in-account.html' +summary: 'Authorize an agent' +--- + += Authorize an agent + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/authorize-agent-in-account`# + + + +Authorizes an agent in a specified account. + + +*Token usage:* Both a BlueXP user token and service token. Pass the user token in the Authorization request header and the service token in the X-Agent-Token request header. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|Authorization +|string +|header +|True +a| + +|X-Agent-Token +|string +|header +|True +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountId": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-authorize-agent-workspace.adoc b/tenancy/post-tenancy-authorize-agent-workspace.adoc new file mode 100644 index 00000000..c4ebb379 --- /dev/null +++ b/tenancy/post-tenancy-authorize-agent-workspace.adoc @@ -0,0 +1,129 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-authorize-agent-workspace.html' +summary: 'Authorize an agent workspace' +--- + += Authorize an agent workspace + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/authorize-agent-workspace`# + + + +Authorize an agent in a workspace. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|agentId +|string +|True +a| + +|workspacePublicId +|string +|True +a| + +|action +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "agentId": "string", + "workspacePublicId": "string", + "action": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|agentId +|string +|True +a| + +|workspacePublicId +|string +|True +a| + +|action +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-authorize-agent.adoc b/tenancy/post-tenancy-authorize-agent.adoc new file mode 100644 index 00000000..addc094d --- /dev/null +++ b/tenancy/post-tenancy-authorize-agent.adoc @@ -0,0 +1,118 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-authorize-agent.html' +summary: 'Authorize an external agent' +--- + += Authorize an external agent + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/authorize-agent`# + + + +Authorizes an external agent to perform specific actions. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|agentId +|string +|True +a| + +|action +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "agentId": "string", + "action": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|agentId +|string +|True +a| + +|action +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-authorize-user-is-account-admin.adoc b/tenancy/post-tenancy-authorize-user-is-account-admin.adoc new file mode 100644 index 00000000..9ba55c20 --- /dev/null +++ b/tenancy/post-tenancy-authorize-user-is-account-admin.adoc @@ -0,0 +1,140 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-authorize-user-is-account-admin.html' +summary: 'Authorize a user as account admin' +--- + += Authorize a user as account admin + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/authorize-user-is-account-admin`# + + + +Authorizes a user as an account admin. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|True +a| + +|userId +|string +|False +a| + +|resourceIdentifier +|string +|False +a| + +|agentId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountId": "string", + "userId": "string", + "resourceIdentifier": "string", + "agentId": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|True +a| + +|userId +|string +|False +a| + +|resourceIdentifier +|string +|False +a| + +|agentId +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-authorize-user-is-in-account.adoc b/tenancy/post-tenancy-authorize-user-is-in-account.adoc new file mode 100644 index 00000000..bab1ead7 --- /dev/null +++ b/tenancy/post-tenancy-authorize-user-is-in-account.adoc @@ -0,0 +1,107 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-authorize-user-is-in-account.html' +summary: 'Authorize a user for an account' +--- + += Authorize a user for an account + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/authorize-user-is-in-account`# + + + +Authorizes a user in a specified account. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountId": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountId +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-authorize.adoc b/tenancy/post-tenancy-authorize.adoc new file mode 100644 index 00000000..a39a9800 --- /dev/null +++ b/tenancy/post-tenancy-authorize.adoc @@ -0,0 +1,193 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-authorize.html' +summary: 'Authorize an external resource' +--- + += Authorize an external resource + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/authorize`# + + + +Authorizes an external resource to perform specific actions. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resourceIdentifier +|string +|True +a| + +|action +|string +|True +a| + +|accountId +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "resourceIdentifier": "string", + "action": "string", + "accountId": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|agentId +|string +|False +a| + +|resourceIdentifier +|string +|False +a| + +|resourceType +|string +|False +a| + +|resourcePublicId +|string +|False +a| + +|accountPublicId +|string +|False +a| + +|agentIds +|array[string] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "agentId": "string", + "resourceIdentifier": "string", + "resourceType": "string", + "resourcePublicId": "string", + "accountPublicId": "string", + "agentIds": [ + "string" + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resourceIdentifier +|string +|True +a| + +|action +|string +|True +a| + +|accountId +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-resource-account-set-resource-name.adoc b/tenancy/post-tenancy-resource-account-set-resource-name.adoc new file mode 100644 index 00000000..261bfaaf --- /dev/null +++ b/tenancy/post-tenancy-resource-account-set-resource-name.adoc @@ -0,0 +1,114 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-resource-account-set-resource-name.html' +summary: 'Set a resource name' +--- + += Set a resource name + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/resource/{resourceIdentifier}/account/{accountId}/set-resource-name`# + + + +Sets the name of a resource. + + +*Token usage:* BlueXP user token. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|resourceIdentifier +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|Authorization +|string +|header +|True +a| +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-resource-account-update.adoc b/tenancy/post-tenancy-resource-account-update.adoc new file mode 100644 index 00000000..2b0db568 --- /dev/null +++ b/tenancy/post-tenancy-resource-account-update.adoc @@ -0,0 +1,157 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-resource-account-update.html' +summary: 'Update properties' +--- + += Update properties + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/resource/{resourceIdentifier}/account/{accountId}/update`# + + + +Updates properties of a specified resource. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|resourceIdentifier +|string +|path +|True +a| + +|accountId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudId +|string +|False +a| + +|metadata +|link:#metadata[metadata] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "cloudId": "string", + "metadata": { + "propertyName": "string", + "propertyValue": "string" + } +} +==== + +== Response + +``` +Status: 200, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#metadata] +[.api-collapsible-fifth-title] +metadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|propertyName +|string +|True +a| + +|propertyValue +|string +|True +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudId +|string +|False +a| + +|metadata +|link:#metadata[metadata] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-resource-add-to-workspace-id.adoc b/tenancy/post-tenancy-resource-add-to-workspace-id.adoc new file mode 100644 index 00000000..96f805e8 --- /dev/null +++ b/tenancy/post-tenancy-resource-add-to-workspace-id.adoc @@ -0,0 +1,141 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-resource-add-to-workspace-id.html' +summary: 'Add a resource to a workspace' +--- + += Add a resource to a workspace + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/resource/{resourceIdentifier}/add-to-workspace/{workspacePublicId}`# + + + +Adds a resource to a specified workspace. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|resourceIdentifier +|string +|path +|True +a|* example: VsaWorkingEnvironment-yQFegzgz + + +|workspacePublicId +|string +|path +|True +a|* example: workspace-APWLzah1 + + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountPublicId +|string +|False +a| + +|resourcePublicId +|string +|False +a| + +|resourceIdentifier +|string +|False +a| + +|resourceType +|string +|False +a| + +|agentId +|string +|False +a| + +|resourceClass +|string +|False +a| + +|cloudId +|string +|False +a| + +|agentIds +|array[string] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountPublicId": "string", + "resourcePublicId": "string", + "resourceIdentifier": "string", + "resourceType": "string", + "agentId": "string", + "resourceClass": "string", + "cloudId": "string", + "agentIds": [ + "string" + ] +} +==== + diff --git a/tenancy/post-tenancy-resource-discover.adoc b/tenancy/post-tenancy-resource-discover.adoc new file mode 100644 index 00000000..58a9b8f6 --- /dev/null +++ b/tenancy/post-tenancy-resource-discover.adoc @@ -0,0 +1,286 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-resource-discover.html' +summary: 'Discover an external resource' +--- + += Discover an external resource + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/resource/discover`# + + + +Discovers an external resource to be added to BlueXP. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workspacePublicId +|string +|True +a| + +|agentId +|string +|True +a| + +|resourceIdentifier +|string +|True +a| + +|name +|string +|False +a| + +|resourceType +|string +|False +a| + +|resourceClass +|string +|False +a| + +|cloudId +|string +|False +a| + +|metadata +|link:#metadata[metadata] +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "workspacePublicId": "workspace-APWLzah1", + "agentId": "string", + "resourceIdentifier": "VsaWorkingEnvironment-yQFegzgz", + "name": "string", + "resourceType": "string", + "resourceClass": "string", + "cloudId": "string", + "metadata": { + "propertyName": "string", + "propertyValue": "string" + } +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountPublicId +|string +|False +a| + +|resourcePublicId +|string +|False +a| + +|resourceIdentifier +|string +|False +a| + +|resourceType +|string +|False +a| + +|agentId +|string +|False +a| + +|resourceClass +|string +|False +a| + +|cloudId +|string +|False +a| + +|metadata +|string +|False +a| + +|agentIds +|array[string] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountPublicId": "string", + "resourcePublicId": "string", + "resourceIdentifier": "string", + "resourceType": "string", + "agentId": "string", + "resourceClass": "string", + "cloudId": "string", + "metadata": "string", + "agentIds": [ + "string" + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#metadata] +[.api-collapsible-fifth-title] +metadata + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|propertyName +|string +|True +a| + +|propertyValue +|string +|True +a| + +|=== + + +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workspacePublicId +|string +|True +a| + +|agentId +|string +|True +a| + +|resourceIdentifier +|string +|True +a| + +|name +|string +|False +a| + +|resourceType +|string +|False +a| + +|resourceClass +|string +|False +a| + +|cloudId +|string +|False +a| + +|metadata +|link:#metadata[metadata] +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-resource-remove-from-agent-id.adoc b/tenancy/post-tenancy-resource-remove-from-agent-id.adoc new file mode 100644 index 00000000..3324f0e8 --- /dev/null +++ b/tenancy/post-tenancy-resource-remove-from-agent-id.adoc @@ -0,0 +1,67 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-resource-remove-from-agent-id.html' +summary: 'Remove a resource from an agent' +--- + += Remove a resource from an agent + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/resource/{resourceIdentifier}/remove-from-agent/{agentId}`# + + + +Removes a resource from a specified agent. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|resourceIdentifier +|string +|path +|True +a| + +|agentId +|string +|path +|True +a| + +|authorization +|string +|header +|True +a| + +|X-User-Token +|string +|header +|False +a| + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/post-tenancy-resource-remove-from-workspace-id.adoc b/tenancy/post-tenancy-resource-remove-from-workspace-id.adoc new file mode 100644 index 00000000..ea6f56a1 --- /dev/null +++ b/tenancy/post-tenancy-resource-remove-from-workspace-id.adoc @@ -0,0 +1,72 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-resource-remove-from-workspace-id.html' +summary: 'Remove a resource from a workspace' +--- + += Remove a resource from a workspace + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/resource/{resourceIdentifier}/remove-from-workspace/{workspacePublicId}`# + + + +Removes a resource from a specified workspace. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|resourceIdentifier +|string +|path +|True +a|* example: VsaWorkingEnvironment-yQFegzgz + + +|workspacePublicId +|string +|path +|True +a|* example: workspace-APWLzah1 + + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-User-Token +|string +|header +|False +a|User JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Response + +``` +Status: 200, Default response +``` + diff --git a/tenancy/post-tenancy-resource-set-cloud-id.adoc b/tenancy/post-tenancy-resource-set-cloud-id.adoc new file mode 100644 index 00000000..d1dc7796 --- /dev/null +++ b/tenancy/post-tenancy-resource-set-cloud-id.adoc @@ -0,0 +1,121 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-resource-set-cloud-id.html' +summary: 'Set a cloud identifier' +--- + += Set a cloud identifier + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/resource/{resourceIdentifier}/set-cloud-id`# + + + +Sets the cloud identifier of a resource. + + +*Token usage:* BlueXP user token. + + + +CAUTION: This operation is deprecated. + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|resourceIdentifier +|string +|path +|True +a| + +|Authorization +|string +|header +|True +a| + +|X-Tenancy-Account-Id +|string +|header +|False +a|accountID to be passed. + + +|X-Service-Request-Id +|string +|header +|False +a| +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudId +|string +|True +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "cloudId": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|cloudId +|string +|True +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/post-tenancy-resource.adoc b/tenancy/post-tenancy-resource.adoc new file mode 100644 index 00000000..230c8c0a --- /dev/null +++ b/tenancy/post-tenancy-resource.adoc @@ -0,0 +1,248 @@ +--- +sidebar: sidebar +api: true +explorer: true +permalink: 'tenancy/post-tenancy-resource.html' +summary: 'Create an external resource' +--- + += Create an external resource + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/tenancy/resource`# + + + +Creates an external resource as a BlueXP resource. resourceType must be passed to the request. + + +*Token usage:* BlueXP user token. + + +== Parameters + +[cols=5*,options=header] +|=== + +|Name +|Type +|In +|Required +|Description + +|authorization +|string +|header +|True +a|Authorization JWT access token + + +|X-Service-Request-Id +|string +|header +|False +a|Request identifier + +|=== + +== Request Body + + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workspacePublicId +|string +|False +a| + +|agentId +|string +|True +a| + +|resourceIdentifier +|string +|False +a| + +|resourceType +|string +|False +a| + +|resourceClass +|string +|False +a| + +|cloudId +|string +|False +a| + +|name +|string +|False +a| + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "workspacePublicId": "workspace-APWLzah1", + "agentId": "string", + "resourceIdentifier": "VsaWorkingEnvironment-yQFegzgz", + "resourceType": "string", + "resourceClass": "string", + "cloudId": "string", + "name": "string" +} +==== + +== Response + +``` +Status: 200, Default response +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accountPublicId +|string +|False +a| + +|resourcePublicId +|string +|False +a| + +|resourceIdentifier +|string +|False +a| + +|resourceType +|string +|False +a| + +|agentId +|string +|False +a| + +|resourceClass +|string +|False +a| + +|name +|string +|False +a| + +|cloudId +|string +|False +a| + +|agentIds +|array[string] +|False +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "accountPublicId": "string", + "resourcePublicId": "string", + "resourceIdentifier": "string", + "resourceType": "string", + "agentId": "string", + "resourceClass": "string", + "name": "string", + "cloudId": "string", + "agentIds": [ + "string" + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#body] +[.api-collapsible-fifth-title] +body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|workspacePublicId +|string +|False +a| + +|agentId +|string +|True +a| + +|resourceIdentifier +|string +|False +a| + +|resourceType +|string +|False +a| + +|resourceClass +|string +|False +a| + +|cloudId +|string +|False +a| + +|name +|string +|False +a| + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancy/resource_overview.adoc b/tenancy/resource_overview.adoc new file mode 100644 index 00000000..c26b52f9 --- /dev/null +++ b/tenancy/resource_overview.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/resource_overview.html' +summary: 'Resource endpoints in the Accounts REST API' +--- + += Resource endpoints in the Accounts REST API + + + ++++
    +++A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces. + +Each resource contains the following information: + +* Public identifier (such as resource-PnA04qmQ) * Resource identifier -- used internally (such as VsaWorkingEnvironment-6iEs02vL) * Resource type (such as S3, AZURE, GCP) * Resource class (such as ON_PREM, VSA, S3) + +The following actions can be performed with the resource endpoints: + +* Discover a resource * Create, update, or delete a resource * List the resources available in an account * Delete a service resource from an account * Associate or disassociate a resource from the workspace * Disassociate a resource from a Connector+++
    +++ + + diff --git a/tenancy/service_account_overview.adoc b/tenancy/service_account_overview.adoc new file mode 100644 index 00000000..a30972c3 --- /dev/null +++ b/tenancy/service_account_overview.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/service_account_overview.html' +summary: 'Service account endpoints in the Accounts REST API' +--- + += Service account endpoints in the Accounts REST API + + + ++++
    +++The service account endpoints represent a general BlueXP service. A service account can be created as an account administrator or delegated more limited authority over one or more workspaces. + +Each service account contains the following information: + +* Public identifier (such as do0uPCFi) * Name * Auth0 identifier (such as HEgEEJbfE0UfBzhmyprOjdZskl3H8KT3) + +The following actions can be performed with the service account endpoints: + +* Create, Read, Update, and Delete (CRUD) operations * Generate the service account secret+++
    +++ + + diff --git a/tenancy/sidebar.yml b/tenancy/sidebar.yml deleted file mode 100644 index ecdd1fb6..00000000 --- a/tenancy/sidebar.yml +++ /dev/null @@ -1,3 +0,0 @@ -section: tenancy -title: Accounts (tenancy) -generate: tenancy \ No newline at end of file diff --git a/tenancy/tenancy-x-doc.json b/tenancy/tenancy-x-doc.json deleted file mode 100644 index 3afb6530..00000000 --- a/tenancy/tenancy-x-doc.json +++ /dev/null @@ -1,546 +0,0 @@ -{ - "overview": "Accounts REST API", - "permalink": "overview.html", - "paths": { - "/tenancy/account/{accountName}": { - "post": { - "x-doc": { - "title": "Create an account", - "category": "Account", - "filename": "post-tenancy-account-id.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}": { - "delete": { - "x-doc": { - "title": "Delete an account", - "category": "Account", - "filename": "delete-tenancy-account-id.html", - "subcategory": null - } - }, - "get": { - "x-doc": { - "title": "Retrieve an account", - "category": "Account", - "filename": "get-tenancy-account-id.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/associate": { - "post": { - "x-doc": { - "title": "Associate a user", - "category": "Account", - "filename": "post-tenancy-account-associate.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/disassociate": { - "post": { - "x-doc": { - "title": "Dissociate a user", - "category": "Account", - "filename": "post-tenancy-account-disassociate.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/users": { - "get": { - "x-doc": { - "title": "Retrieve user data", - "category": "Account", - "filename": "get-tenancy-account-users.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/service-accounts": { - "get": { - "x-doc": { - "title": "Retrieve service account data", - "category": "Account", - "filename": "get-tenancy-account-service-accounts.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/members": { - "get": { - "x-doc": { - "title": "Retrieve user and service account data", - "category": "Account", - "filename": "get-tenancy-account-members.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/permissions-for-user": { - "get": { - "x-doc": { - "title": "Retrieve user role and permissions", - "category": "Account", - "filename": "get-tenancy-account-permissions-for-user.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/leave": { - "post": { - "x-doc": { - "title": "Delete a user", - "category": "Account", - "filename": "post-tenancy-account-leave.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/update-user": { - "patch": { - "x-doc": { - "title": "Enable Cloud Manager notifications", - "category": "Account", - "filename": "patch-tenancy-account-update-user.html", - "subcategory": null - } - } - }, - "/tenancy/account": { - "get": { - "x-doc": { - "title": "Retrieve user accounts", - "category": "Account", - "filename": "get-tenancy-account.html", - "subcategory": null - } - } - }, - "/tenancy/account/{srcAccountId}/dest/account/{dstAccountId}": { - "post": { - "x-doc": { - "title": "Move account data", - "category": "Account", - "filename": "post-tenancy-account-dest-account-.html", - "explorer": false, - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/rename/{newAccountName}": { - "post": { - "x-doc": { - "title": "Rename an account", - "category": "Account", - "filename": "post-tenancy-account-rename-id.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/enable-saas/{saasEnabled}": { - "post": { - "x-doc": { - "title": "Enable SaaS", - "category": "Account", - "filename": "post-tenancy-account-enable-saas-id.html" - } - } - }, - "/tenancy/account/{accountId}/enable-private-preview/{privatePreviewEnabled}": { - "post": { - "x-doc": { - "title": "Enable private preview for SaaS", - "category": "Account", - "filename": "post-tenancy-account-enable-private-preview-id.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/enable-3rd-party-services/{enabled}": { - "post": { - "x-doc": { - "title": "Enable third-party services", - "category": "Account", - "filename": "post-tenancy-account-enable-3rd-party-services-id.html", - "subcategory": null - } - } - }, - "/tenancy/authorize": { - "post": { - "x-doc": { - "title": "Authorize an external resource", - "category": "Authorize", - "filename": "post-tenancy-authorize.html", - "subcategory": null - } - } - }, - "/tenancy/authorize-agent": { - "post": { - "x-doc": { - "title": "Authorize an external agent", - "category": "Authorize", - "filename": "post-tenancy-authorize-agent.html", - "subcategory": null - } - } - }, - "/tenancy/authorize-agent-workspace": { - "post": { - "x-doc": { - "title": "Authorize an agent workspace", - "category": "Authorize", - "filename": "post-tenancy-authorize-agent-workspace.html", - "subcategory": null - } - } - }, - "/tenancy/authorize-user-is-account-admin": { - "post": { - "x-doc": { - "title": "Authorize a user as account admin", - "category": "Authorize", - "filename": "post-tenancy-authorize-user-is-account-admin.html", - "subcategory": null - } - } - }, - "/tenancy/authorize-user-is-in-account": { - "post": { - "x-doc": { - "title": "Authorize a user for an account", - "category": "Authorize", - "filename": "post-tenancy-authorize-user-is-in-account.html", - "subcategory": null - } - } - }, - "/tenancy/authorize-agent-in-account": { - "post": { - "x-doc": { - "title": "Authorize an agent", - "category": "Authorize", - "filename": "post-tenancy-authorize-agent-in-account.html", - "explorer": false, - "subcategory": null - } - } - }, - "/tenancy/resource/discover": { - "post": { - "x-doc": { - "title": "Discover an external resource", - "category": "Resource", - "filename": "post-tenancy-resource-discover.html", - "subcategory": null - } - } - }, - "/tenancy/resource": { - "post": { - "x-doc": { - "title": "Create an external resource", - "category": "Resource", - "filename": "post-tenancy-resource.html", - "subcategory": null - } - }, - "get": { - "x-doc": { - "title": "Retrieve a resource", - "category": "Resource", - "filename": "get-tenancy-resource.html", - "subcategory": null - } - } - }, - "/tenancy/service-resource/{resourceIdentifier}": { - "delete": { - "x-doc": { - "title": "Delete a service resource", - "category": "Resource", - "filename": "delete-tenancy-service-resource-id.html", - "explorer": false, - "subcategory": null - } - } - }, - "/tenancy/resource/{resourceIdentifier}/set-cloud-id": { - "post": { - "x-doc": { - "title": "Set a cloud identifier", - "category": "Resource", - "filename": "post-tenancy-resource-set-cloud-id.html", - "subcategory": null - } - } - }, - "/tenancy/resource/{resourceIdentifier}/account/{accountId}/set-resource-name": { - "post": { - "x-doc": { - "title": "Set a resource name", - "category": "Resource", - "filename": "post-tenancy-resource-account-set-resource-name.html", - "subcategory": null - } - } - }, - "/tenancy/resource/{resourceIdentifier}/add-to-workspace/{workspacePublicId}": { - "post": { - "x-doc": { - "title": "Add a resource to a workspace", - "category": "Resource", - "filename": "post-tenancy-resource-add-to-workspace-id.html", - "subcategory": null - } - } - }, - "/tenancy/resource/{resourceIdentifier}/remove-from-workspace/{workspacePublicId}": { - "post": { - "x-doc": { - "title": "Remove a resource from a workspace", - "category": "Resource", - "filename": "post-tenancy-resource-remove-from-workspace-id.html", - "subcategory": null - } - } - }, - "/tenancy/resource/{resourceIdentifier}/remove-from-agent/{agentId}": { - "post": { - "x-doc": { - "title": "Remove a resource from an agent", - "category": "Resource", - "filename": "post-tenancy-resource-remove-from-agent-id.html", - "subcategory": null - } - } - }, - "/tenancy/resource/{resourceIdentifier}": { - "delete": { - "x-doc": { - "title": "Delete a resource from an account", - "category": "Resource", - "filename": "delete-tenancy-resource-id.html", - "subcategory": null - } - } - }, - "/tenancy/resource/{resourceIdentifier}/account/{accountId}/update": { - "post": { - "x-doc": { - "title": "Update properties", - "category": "Resource", - "filename": "post-tenancy-resource-account-update.html", - "subcategory": null - } - } - }, - "/tenancy/service-resources": { - "delete": { - "x-doc": { - "title": "Delete service resources", - "category": "Resource", - "filename": "delete-tenancy-service-resource-.html", - "explorer": false, - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/workspace/{name}": { - "post": { - "x-doc": { - "title": "Create a workspace", - "category": "Workspace", - "filename": "post-tenancy-account-workspace-id.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/workspace/{workspacePublicId}/add-user/{userPublicId}": { - "post": { - "x-doc": { - "title": "Add a user", - "category": "Workspace", - "filename": "post-tenancy-account-workspace-add-user-id.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountPublicId}/workspace/{workspacePublicId}/remove-user/{userPublicId}": { - "post": { - "x-doc": { - "title": "Remove a user", - "category": "Workspace", - "filename": "post-tenancy-account-workspace-remove-user-id.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/workspace/{workspacePublicId}": { - "delete": { - "x-doc": { - "title": "Delete a workspace", - "category": "Workspace", - "filename": "delete-tenancy-account-workspace-id.html", - "subcategory": null - } - }, - "patch": { - "x-doc": { - "title": "Rename a workspace", - "category": "Workspace", - "filename": "patch-tenancy-account-workspace-id.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/workspace/{workspacePublicId}/add-agent/{agentAuth0Id}": { - "post": { - "x-doc": { - "title": "Add an agent", - "category": "Workspace", - "filename": "post-tenancy-account-workspace-add-agent-id.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/workspace/{workspacePublicId}/remove-agent/{agentAuth0Id}": { - "post": { - "x-doc": { - "title": "Remove an agent", - "category": "Workspace", - "filename": "post-tenancy-account-workspace-remove-agent-id.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/workspace/{workspacePublicId}/agents": { - "get": { - "x-doc": { - "title": "Retrieve agents", - "category": "Workspace", - "filename": "get-tenancy-account-workspace-agents.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/workspace": { - "get": { - "x-doc": { - "title": "Retrieve workspaces", - "category": "Workspace", - "filename": "get-tenancy-account-workspace.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/user/{userId}/workspaces": { - "get": { - "x-doc": { - "title": "Retrieve user account workspaces", - "category": "Workspace", - "filename": "get-tenancy-account-user-workspaces.html", - "explorer": false, - "subcategory": null - } - } - }, - "/tenancy/users/for-action/{accountId}/{action}/{resourceId}": { - "get": { - "x-doc": { - "title": "Retrieve users authorized for single resource", - "category": "User", - "filename": "get-tenancy-users-for-action--id.html", - "explorer": false, - "subcategory": null - } - } - }, - "/tenancy/users/for-action/{accountId}/{action}": { - "get": { - "x-doc": { - "title": "Retrieve users authorized for all resources", - "category": "User", - "filename": "get-tenancy-users-for-action-id.html", - "explorer": false, - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/service-account": { - "post": { - "x-doc": { - "title": "Create a service account", - "category": "Service Account", - "filename": "post-tenancy-account-service-account.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/service-account/{serviceAccountId}": { - "delete": { - "x-doc": { - "title": "Delete a service account", - "category": "Service Account", - "filename": "delete-tenancy-account-service-account-del.html", - "subcategory": null - } - }, - "patch": { - "x-doc": { - "title": "Update details", - "category": "Service Account", - "filename": "patch-tenancy-account-service-account-pat.html", - "subcategory": null - } - } - }, - "/tenancy/account/{accountId}/service-account/{serviceAccountId}/generate-service-account-secret": { - "post": { - "x-doc": { - "title": "Generate a secret", - "category": "Service Account", - "filename": "post-tenancy-account-service-account-generate-service-account-secret.html", - "subcategory": null - } - } - } - }, - "categories": [ - { - "id": "account", - "title": "Account endpoints in the Accounts REST API", - "permalink": "account_overview.html" - }, - { - "id": "workspace", - "title": "Workspace endpoints in the Accounts REST API", - "permalink": "workspace_overview.html" - }, - { - "id": "authorize", - "title": "Authorize endpoints in the Accounts REST API", - "permalink": "authorize_overview.html" - }, - { - "id": "resource", - "title": "Resource endpoints in the Accounts REST API", - "permalink": "resource_overview.html" - }, - { - "id": "service account", - "title": "Service account endpoints in the Accounts REST API", - "permalink": "service_account_overview.html" - }, - { - "id": "user", - "title": "User endpoints in the Accounts REST API", - "permalink": "user_overview.html" - } - ] -} \ No newline at end of file diff --git a/tenancy/tenancy.json b/tenancy/tenancy.json deleted file mode 100644 index 4ccccd45..00000000 --- a/tenancy/tenancy.json +++ /dev/null @@ -1,3422 +0,0 @@ -{ - "swagger":"2.0", - "info":{ - "title":"Tenancy service REST API reference", - "description":"
    Overview\n

    The Tenancy service provides secure and granular role-based access control (RBAC) for the resources in the BlueXP platform when using BlueXP in restricted mode or private mode.

    \nIt consists of several internal major components that operate together to enable and restrict resource access.
    \nThe service operates within the context of a BlueXP account. The identity of the API caller and the account are established through a user or service token.\n\nIf you're using BlueXP in standard mode, you no longer have a BlueXP account. Instead, you have a BlueXP organization that you manage using BlueXP identity and access management (IAM). A separate API is available for BlueXP IAM. If you've been using the tenancy API to manage accounts, the API for BlueXP IAM is backwards compatible with the tenancy API.

    \nView the API for BlueXP IAM

    \nThere are six components defined within the Tenancy service.

    \n
      \n
    • account
      • \n
    • authorize
      • \n
    • resource
      • \n
    • service account
      • \n
    • user
      • \n
    • workspace
      • \n
    \n\n

    Note: Before using the API reference documentation, review the \nGet started section for the BlueXP APIs. For more information about the security tokens and identifiers you'll need when using the API, review the Common workflows and tasks section.

    \n
    \n
    \n
    \nREST implementation\n

    HTTP methods

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    MethodDescription
    POSTCreate an object instance
    GETRetrieve an object instance or collection
    PATCHUpdate an existing object
    DELETERemove an existing object
    \n

    Request headers

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Request HeaderDescription
    AuthorizationRequired. Contains a JWT access token
    X-service-request-idUsed to tag a request with application-specific keys for improved supportability
    X-agent-idContains the BlueXP Connector ID and can be included depending on the call
    X-tenancy-account-idContains the account identifier and can be included depending on the call
    \n

    Query parameters

    \n

    You can use query parameters with endpoints in the following components:

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    ComponentQuery Parameter
    Resourceaccount (required)
    \nresourceType
    \nworkspace
    \nresourceClass
    \nresourceId
    \n

    Response headers

    \n

    This API uses the standard HTTP response headers common with all BlueXP APIs. See REST implementation for more information.

    \n

    HTTP status codes

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    HTTP Status CodeDescription
    200OK: Returned for successful operation completion
    400Bad Request: Returned if the input is malformed and could not be parsed
    401Unauthorized: Returned if user authentication failed or the token has expired
    403Forbidden: Returned for authorization errors depending on the resource and token
    \n
    \n
    \n
    \nError handling\n

    There are three processes involved with error handling and processing.

    \n
      \n
    • The error is logged for supportability
      • \n
    • The error is also returned to the caller for any specific handling
      • \n
    • The database connection is rolled back
      • \n
    \n
    \n
    \n
    \ncURL examples\n

    Retrieve resources for a specified account

    \n

    This example retrieves the resources for a specified account.

    \n
    curl -X GET "https://cloudmanager.cloud.netapp.com/tenancy/resource?account=<account_id>" -H  "accept: application/json" -H  "authorization: <user token>"\n
    \n
    \n
    \n
    \nFrequently asked questions\n

    What is the use case for account migration, where the account configuration data is moved from one account to another?

    \n

    Suppose a company is in stealth mode and doing a proof of concept (PoC) with a BlueXP account. If it’s successful, the company might want to move from the PoC account to a development account. Another migration use case is account consolidation.

    \n

    If the ‘CMNotificationOptIn’ account option is enabled, will all users associated with the account receive the BlueXP event notifications?

    \n

    No. The API endpoint used in this case is "PATCH tenancy/account/{accountId}/update-user". The occm service token is carried in the "authorization" request header and the specific user to receive the notifications is identified with the "x-user-token" header.

    \n

    What are the SaaS enablement and third-part service enablement options for a BlueXP account?

    \n

    SaaS enablement is used to allow an account to have access to the BlueXP portal. Third-party service enablement allows or enables third party services (such as Fluid).

    \n

    What are some examples of actions that can be performed with the Authorize REST endpoint?

    \n

    Actions are defined as permissions. The general definition pattern is <principal_type>:<action>. Two examples include accounts:create and workspace:*.

    \n

    The API endpoint 'authorize-user-is-in-account' only accepts the parameter ‘accountId’. In this case, how does the API determine which user is to be authorized?

    \n

    It checks if the user belongs to the account. The ‘authorization’ header contains the user token identifying the user. One possible use case is account migration, where the application continually polls to determine if all the users are migrated to the destination account.

    \n

    The API endpoint 'authorize-agent-in-account' accepts the ‘x-agent-id’ request header. What does this mean?

    \n

    The ‘authorization’ header contains the user token and the ‘x-agent-id’ header has the BlueXP client identifier.

    \n

    Every BlueXP resource has the data field ‘cloud_id’. What is this field and how is it used?

    \n

    This field is the cloud identifier for the resource. For example, this could be the cloud VM ID.

    \n

    Every resource can be associated with one or more workspaces, which is a 1:N relationship model. Why would a resource be associated with more than one workspace?

    \n

    An account or workspace administrator can manage multiple workspaces. In this case, for example, it’s possible to have one NetApp Cloud Volumes Service resource in multiple workspaces.

    \n

    What is the difference between discovering a resource and creating a resource?

    \n

    Discovery is the process of locating an existing resource and attaching it to the account. Creating a resource, on the other hand, first involves various allocation and provisioning operations and then attaching the resource.

    \n

    What is a service resource? Why is DELETE the only supported operation? Are there other options available when managing a service resource?

    \n

    This question applies to the following REST API call: "DELETE /tenancy/service-resource/{resource-id}". There is no special meaning associated with a service resource. It’s just another way for services to delete resources.

    \n

    There is an API operation ‘remove-resource-from-agent’. Why isn’t there a corresponding ‘add-to-agent’ call?

    \n

    The add operation occurs during resource discovery or creation. From the view of an external BlueXP user, only the Connector can discover and create resources. However, internally there are some resources available without explicitly attaching them to the Connector (such as license and persistence). These resources instead belong to the account.

    \n
    \n

    ", - "version":"2.0.0" - }, - "schemes":[ - "https" - ], - "consumes":[ - "application/json" - ], - "produces":[ - "application/json" - ], - "definitions":{ - "def-0":{ - "title":"Authorization", - "type":"object", - "properties":{ - "authorization":{ - "description":"Authorization JWT access token", - "type":"string" - }, - "X-Service-Request-Id":{ - "description":"Request identifier", - "type":"string" - } - }, - "required":[ - "authorization" - ] - }, - "def-1":{ - "title":"AuthorizationUser", - "type":"object", - "properties":{ - "authorization":{ - "description":"Authorization JWT access token", - "type":"string" - }, - "X-User-Token":{ - "description":"User JWT access token", - "type":"string" - }, - "X-Service-Request-Id":{ - "description":"Request identifier", - "type":"string" - } - }, - "required":[ - "authorization" - ] - } - }, - "securityDefinitions":{ - "Authorization_Token":{ - "type":"apiKey", - "name":"Authorization", - "in":"header" - }, - "User_Token":{ - "type":"apiKey", - "name":"X-User-token", - "in":"header" - } - }, - "tags":[ - { - "name":"Account", - "description":"
    \nOverview\n
    \nThe account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following:\n
      \n
    • Single person
      • \n
    • Group of people
      • \n
    • Internal software service
      • \n
    \n

    A single person or group of people is identified through a user token. A software service is represented with a service token.

    \n

    At a high level, an account is a collection of the following:

    \n
      \n
    • Associated person or group of people or software service
      • \n
    • One or more workspaces
      • \n
    • One or more BlueXP Connectors
      • \n
    \n

    Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

    \n

    The following actions can be performed with the account endpoints:

    \n
      \n
    • Create an account
      • \n
    • Delete an account
      • \n
    • Associate a user (person) to an account
      • \n
    • Disassociate a user from an account
      • \n
    • List the users of an account
      • \n
    • List the services (service accounts) of an account
      • \n
    • List the members (users and services) of an account
      • \n
    • List the roles and permissions of an account
      • \n
    • Leave an account
      • \n
    • Allow a user to enable or disable receiving BlueXP notifications
      • \n
    • List the accounts a user is associated with
      • \n
    • Migrate the configuration data from one account to another account
      • \n
    • Rename an account
      • \n
    • Set miscellaneous account enablement options
      • \n
    \n
    \n
    \n" - }, - { - "name":"Workspace", - "description":"
    \nOverview\n
    \n

    The workspace endpoints provide more granular access control within a given account. An account can have one or more workspaces, although a specific workspace can only be owned by one account.

    \n

    Each workspace is defined through the following configuration information:

    \n
      \n
    • Name as selected by the administrator
      • \n
    • Unique identifier generated by the system at creation
      • \n
    • Identifier of the owning account
      • \n
    • One or more users allowed to operate within the workspace
      • \n
    • One or more Connectors
      • \n
    • One or more resources
      • \n
    \n

    Limiting which users can operate within a workspace, along with the set of Connectors and resources defined for the workspace, provides a natural way to enforce access control. Additional access restrictions can be defined for the Connectors and resources within the workspace.

    \n

    Workspaces enable enhanced access control granularity by isolating resources. For example, company departments or projects can be assigned to different workspaces. This isolation provides a high level of security.

    \n

    The following actions can be performed with the workspace endpoints:

    \n
      \n
    • Create a workspace
      • \n
    • List the workspaces within an account
      • \n
    • Add a user to a workspace
      • \n
    • Remove a user from a workspace
      • \n
    • List the workspaces associated with a user
      • \n
    • Delete a workspace
      • \n
    • Rename a workspace
      • \n
    • Add a Connector to a workspace
      • \n
    • Remove a Connector from a workspace
      • \n
    • List the Connectors associated with a workspace
      • \n
    \n
    \n
    \n" - }, - { - "name":"Authorize", - "description":"
    \nOverview\n
    \n

    The authorization endpoints provide the ability to set various permissions for workspaces, Connectors, and resources that allow them to take specific actions.

    \n

    The following actions can be performed with the authorization endpoints:

    \n
      \n
    • Authorize a resource to take specific actions
      • \n
    • Authorize a Connector
      • \n
    • Authorize a workspace and a Connector in the workspace
      • \n
    • Authorize a user as an account administrator
      • \n
    • Authorize a user in an account
      • \n
    • Authorize an agent in an account
      • \n
    \n
    \n
    \n" - }, - { - "name":"Resource", - "description":"
    \nOverview\n
    \n

    A resource is an object managed by BlueXP. By default, all objects within BlueXP are considered resources. Each resource is owned by an account and a Connector defined within the account. A single resource can be associated with one or more workspaces.

    \n

    Each resource contains the following information:

    \n
      \n
    • Public identifier (such as resource-PnA04qmQ)
      • \n
    • Resource identifier – used internally (such as VsaWorkingEnvironment-6iEs02vL)
      • \n
    • Resource type (such as S3, AZURE, GCP)
      • \n
    • Resource class (such as ON_PREM, VSA, S3)
      • \n
    \n

    The following actions can be performed with the resource endpoints:

    \n
      \n
    • Discover a resource
      • \n
    • Create, update, or delete a resource
      • \n
    • List the resources available in an account
      • \n
    • Delete a service resource from an account
      • \n
    • Associate or disassociate a resource from the workspace
      • \n
    • Disassociate a resource from a Connector
      • \n
    \n
    \n
    \n" - }, - { - "name":"Service Account", - "description":"
    \nOverview\n
    \n

    The service account endpoints represent a general BlueXP service. A service account can be created as an account administrator or delegated more limited authority over one or more workspaces.

    \n

    Each service account contains the following information:

    \n
      \n
    • Public identifier (such as do0uPCFi)
      • \n
    • Name
      • \n
    • Auth0 identifier (such as HEgEEJbfE0UfBzhmyprOjdZskl3H8KT3)
      • \n
    \n

    The following actions can be performed with the service account endpoints:

    \n
      \n
    • Create, Read, Update, and Delete (CRUD) operations
      • \n
    • Generate the service account secret
      • \n
    \n
    \n
    \n" - }, - { - "name":"User", - "description":"
    \nOverview\n
    \n

    The user component represents the end user in the BlueXP platform. Every user is associated with an account and a workspace.

    \n

    Each user is defined through the following configuration information:

    \n
      \n
    • A unique identifier generated by the system at creation
      • \n
    • A public visible identifier
      • \n
    • An authorization (auth0) identifier
      • \n
    \n

    The following actions can be performed with the user endpoints:

    \n
      \n
    • Retrieve users authorized for actions on a particular resource
      • \n
    • Retrieve users authorized for actions across all resources
      • \n
    \n
    \n
    \n" - } - ], - "externalDocs":{ - "url":"https://docs.netapp.com/us-en/cloud-manager-automation/platform/http_details.html", - "description":"Learn more about the BlueXP platform REST APIs." - }, - "paths":{ - "/tenancy/account/{accountName}":{ - "post":{ - "description":"Creates a new account with the specified account name.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":[ - "object", - "null" - ], - "properties":{ - "isSaasDisabled":{ - "description":"Specifies if created account is saas disabled, default false", - "type":"boolean", - "default":false - } - } - } - }, - { - "description":"Account name", - "type":"string", - "pattern":"^[-_.a-zA-Z0-9]{1,40}$", - "required":true, - "in":"path", - "name":"accountName" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Create an account", - "category":"Account", - "filename":"post-tenancy-account-.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"object", - "description":"Successful create account response", - "properties":{ - "accountPublicId":{ - "type":"string" - } - } - }, - "description":"Successful create account response" - } - } - } - }, - "/tenancy/account/{accountId}":{ - "delete":{ - "description":"Deletes the specified account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Delete an account", - "category":"Account", - "filename":"delete-tenancy-account-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - }, - "get":{ - "description":"Retrieves a specific account by an account identifier.", - "tags":[ - "Account" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "responses":{ - "200":{ - "schema":{ - "type":"object", - "properties":{ - "accountPublicId":{ - "type":"string" - }, - "accountName":{ - "type":"string" - }, - "isRestricted":{ - "type":"boolean" - }, - "isPrivatePreviewEnabled":{ - "type":"boolean" - }, - "is3rdPartyServicesEnabled":{ - "type":"boolean" - }, - "accountSerial":{ - "type":"string" - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/associate":{ - "post":{ - "description":"Associates the user to the account by using the user email.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "associatedEmail":{ - "description":"User email to be associated with the account", - "type":"string" - }, - "rolePublicId":{ - "description":"User role name. For example, use Role-1 for account admin or Role-2 for workspace admin.", - "example":"Role-1", - "type":"string" - } - } - } - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Associate a user", - "category":"Account", - "filename":"post-tenancy-account-associate.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"object", - "properties":{ - "userPublicId":{ - "type":"string" - }, - "userClientId":{ - "type":"string" - }, - "userRole":{ - "type":"string" - }, - "cloudManagerNotificationsOptIn":{ - "type":"boolean" - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/disassociate":{ - "post":{ - "description":"Disassociates the user from the specified account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "associatedUserPublicId":{ - "type":"string" - } - } - } - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Disassociate a user", - "category":"Account", - "filename":"post-tenancy-account-disassociate.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/users":{ - "get":{ - "description":"Retrieves the user data of the specified account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Retrieve user data", - "category":"Account", - "filename":"get-tenancy-account-users.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "cloudManagerNotificationsOptIn":{ - "type":"number" - }, - "company":{ - "type":"string" - }, - "email":{ - "type":"string" - }, - "name":{ - "type":"string" - }, - "userPublicId":{ - "type":"string" - }, - "userRole":{ - "type":"string" - }, - "userClientId":{ - "type":"string" - }, - "workspaces":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "userPublicId":{ - "type":"string" - }, - "workspacePublicId":{ - "type":"string" - }, - "workspaceName":{ - "type":"string" - } - } - } - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/service-accounts":{ - "get":{ - "description":"Retrieves the service account data of the specified account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Retrieve service account data", - "category":"Account", - "filename":"get-tenancy-account-service-accounts.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "name":{ - "type":"string" - }, - "serviceAccountPublicId":{ - "type":"string" - }, - "serviceAccountRole":{ - "type":"string" - }, - "serviceAccountClientId":{ - "type":"string" - }, - "workspaces":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "serviceAccountPublicId":{ - "type":"string" - }, - "workspacePublicId":{ - "type":"string" - }, - "workspaceName":{ - "type":"string" - } - } - } - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/members":{ - "get":{ - "description":"Retrieves the user and service account data of the specified account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Retrieve user and service account data", - "category":"Account", - "filename":"get-tenancy-account-members.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "name":{ - "type":"string" - }, - "cloudManagerNotificationsOptIn":{ - "type":"number" - }, - "company":{ - "type":"string" - }, - "email":{ - "type":"string" - }, - "publicId":{ - "type":"string" - }, - "role":{ - "type":"string" - }, - "clientId":{ - "type":"string" - }, - "isServiceAccount":{ - "type":"boolean" - }, - "workspaces":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "publicId":{ - "type":"string" - }, - "workspacePublicId":{ - "type":"string" - }, - "workspaceName":{ - "type":"string" - } - } - } - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/permissions-for-user":{ - "get":{ - "description":"Retrieves the user role and permissions of the specified account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Retrieve user role and permissions", - "category":"Account", - "filename":"get-tenancy-account-permissions-for-user.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"object", - "properties":{ - "role":{ - "type":"string" - }, - "permissions":{ - "type":"array", - "items":{ - "type":"string" - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/leave":{ - "post":{ - "description":"Removes the user from the specified account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Delete a user", - "category":"Account", - "filename":"post-tenancy-account-leave.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/update-user":{ - "patch":{ - "description":"Updates the user cloudManagerNotificationsOptIn property of the specified account.\n The cloudManagerNotificationsOptIn property determines whether the user receives BlueXP notifications.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "cloudManagerNotificationsOptIn":{ - "type":"boolean" - } - }, - "required":[ - "cloudManagerNotificationsOptIn" - ], - "maximum":1, - "minimum":0 - } - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Enable BlueXP notifications", - "category":"Account", - "filename":"patch-tenancy-account-update-user.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/account":{ - "get":{ - "description":"Retrieves all accounts related to the user.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Retrieve user accounts", - "category":"Account", - "filename":"get-tenancy-account.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "accountPublicId":{ - "type":"string" - }, - "accountName":{ - "type":"string" - }, - "isSaas":{ - "type":"boolean" - }, - "isGov":{ - "type":"boolean" - }, - "isPrivatePreviewEnabled":{ - "type":"boolean" - }, - "is3rdPartyServicesEnabled":{ - "type":"boolean" - }, - "accountSerial":{ - "type":"string" - }, - "userRole":{ - "type":"string" - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{srcAccountId}/dest/account/{dstAccountId}":{ - "post":{ - "description":"Moves account data from the source account to the destination account.\n
    Token usage: BlueXP service token with the following scopes: tenancy:support.", - "tags":[ - "Account" - ], - "parameters":[ - { - "description":"Source account ID", - "type":"string", - "required":true, - "in":"path", - "name":"srcAccountId" - }, - { - "description":"Destination account ID", - "type":"string", - "required":true, - "in":"path", - "name":"dstAccountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Move account data", - "category":"Account", - "filename":"post-tenancy-account-dest-account-.html", - "explorer":false - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/rename/{newAccountName}":{ - "post":{ - "description":"Renames the specified account with a specified new name.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "type":"string", - "pattern":"^[-_.a-zA-Z0-9]{1,40}$", - "required":true, - "in":"path", - "name":"newAccountName" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Rename an account", - "category":"Account", - "filename":"post-tenancy-account-rename-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/enable-private-preview/{privatePreviewEnabled}":{ - "post":{ - "description":"Sets the privatePreviewEnabled property of the specified account.\n The privatePreviewEnabled property determines whether private preview of the SaaS interface is enabled.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "type":"boolean", - "maximum":1, - "minimum":0, - "required":true, - "in":"path", - "name":"privatePreviewEnabled" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Enable private preview for SaaS", - "category":"Account", - "filename":"post-tenancy-account-enable-private-preview-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/enable-3rd-party-services/{enabled}":{ - "post":{ - "description":"Sets the third-party enabled property of the specified account.\n The enabled property determines whether third-party services are enabled for the account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Account" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "type":"boolean", - "maximum":1, - "minimum":0, - "required":true, - "in":"path", - "name":"enabled" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Enable third-party services", - "category":"Account", - "filename":"post-tenancy-account-enable-3rd-party-services-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/authorize":{ - "post":{ - "description":"Authorizes an external resource to perform specific actions.\n
    Token usage: BlueXP user token.", - "tags":[ - "Authorize" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "resourceIdentifier":{ - "type":"string" - }, - "action":{ - "type":"string" - }, - "accountId":{ - "type":"string", - "default":null - } - }, - "required":[ - "resourceIdentifier", - "action" - ] - } - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Authorize an external resource", - "category":"Authorize", - "filename":"post-tenancy-authorize.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"object", - "properties":{ - "agentId":{ - "type":"string" - }, - "resourceIdentifier":{ - "type":"string" - }, - "resourceType":{ - "type":"string" - }, - "resourcePublicId":{ - "type":"string" - }, - "accountPublicId":{ - "type":"string" - }, - "agentIds":{ - "type":"array", - "items":{ - "type":"string" - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/authorize-agent":{ - "post":{ - "description":"Authorizes an external agent to perform specific actions.\n
    Token usage: BlueXP user token.", - "tags":[ - "Authorize" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "agentId":{ - "type":"string" - }, - "action":{ - "type":"string" - } - }, - "required":[ - "agentId", - "action" - ] - } - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Authorize an external agent", - "category":"Authorize", - "filename":"post-tenancy-authorize-agent.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/authorize-agent-workspace":{ - "post":{ - "description":"Authorize an agent in a workspace.\n
    Token usage: BlueXP user token.", - "tags":[ - "Authorize" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "agentId":{ - "type":"string" - }, - "workspacePublicId":{ - "type":"string" - }, - "action":{ - "type":"string" - } - }, - "required":[ - "agentId", - "workspacePublicId", - "action" - ] - } - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Authorize an agent workspace", - "category":"Authorize", - "filename":"post-tenancy-authorize-agent-workspace.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/authorize-user-is-account-admin":{ - "post":{ - "description":"Authorizes a user as an account admin.\n
    Token usage: BlueXP user token.", - "tags":[ - "Authorize" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "accountId":{ - "type":"string" - }, - "userId":{ - "type":"string" - }, - "resourceIdentifier":{ - "type":"string" - }, - "agentId":{ - "type":"string" - } - }, - "required":[ - "accountId" - ] - } - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Authorize a user as account admin", - "category":"Authorize", - "filename":"post-tenancy-authorize-user-is-account-admin.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/authorize-user-is-in-account":{ - "post":{ - "description":"Authorizes a user in a specified account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Authorize" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "accountId":{ - "type":"string" - } - }, - "required":[ - "accountId" - ] - } - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Authorize a user for an account", - "category":"Authorize", - "filename":"post-tenancy-authorize-user-is-in-account.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/authorize-agent-in-account":{ - "post":{ - "description":"Authorizes an agent in a specified account.\n
    Token usage: Both a BlueXP user token and service token. Pass the user token in the Authorization request header and the service token in the X-Agent-Token request header.", - "tags":[ - "Authorize" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "accountId":{ - "type":"string" - } - }, - "required":[ - "accountId" - ] - } - }, - { - "in":"header", - "name":"Authorization", - "required":true, - "type":"string" - }, - { - "in":"header", - "name":"X-Agent-Token", - "required":true, - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "type":"string" - } - ], - "x-doc":{ - "title":"Authorize an agent", - "category":"Authorize", - "filename":"post-tenancy-authorize-agent-in-account.html", - "explorer":false - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/resource/discover":{ - "post":{ - "description":"Discovers an external resource to be added to BlueXP.\n
    Token usage: BlueXP user token.", - "tags":[ - "Resource" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "workspacePublicId":{ - "type":"string", - "example":"workspace-APWLzah1" - }, - "agentId":{ - "type":"string" - }, - "resourceIdentifier":{ - "type":"string", - "example":"VsaWorkingEnvironment-yQFegzgz" - }, - "name":{ - "type":"string" - }, - "resourceType":{ - "type":"string" - }, - "resourceClass":{ - "type":"string" - }, - "cloudId":{ - "type":"string" - }, - "metadata":{ - "type":"object", - "properties":{ - "propertyName":{ - "type":"string" - }, - "propertyValue":{ - "type":"string" - } - }, - "required":[ - "propertyName", - "propertyValue" - ] - } - }, - "required":[ - "workspacePublicId", - "agentId", - "resourceIdentifier" - ] - } - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Discover an external resource", - "category":"Resource", - "filename":"post-tenancy-resource-discover.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"object", - "properties":{ - "accountPublicId":{ - "type":"string" - }, - "resourcePublicId":{ - "type":"string" - }, - "resourceIdentifier":{ - "type":"string" - }, - "resourceType":{ - "type":"string" - }, - "agentId":{ - "type":"string" - }, - "resourceClass":{ - "type":"string" - }, - "cloudId":{ - "type":"string" - }, - "metadata":{ - "type":"string" - }, - "agentIds":{ - "type":"array", - "items":{ - "type":"string" - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/resource":{ - "post":{ - "description":"Creates an external resource as a BlueXP resource. resourceType must be passed to the request.\n
    Token usage: BlueXP user token.", - "tags":[ - "Resource" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "workspacePublicId":{ - "type":"string", - "example":"workspace-APWLzah1" - }, - "agentId":{ - "type":"string" - }, - "resourceIdentifier":{ - "type":"string", - "example":"VsaWorkingEnvironment-yQFegzgz" - }, - "resourceType":{ - "type":"string" - }, - "resourceClass":{ - "type":"string" - }, - "cloudId":{ - "type":"string" - }, - "name":{ - "type":"string" - } - }, - "required":[ - "agentId" - ] - } - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Create an external resource", - "category":"Resource", - "filename":"post-tenancy-resource.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"object", - "properties":{ - "accountPublicId":{ - "type":"string" - }, - "resourcePublicId":{ - "type":"string" - }, - "resourceIdentifier":{ - "type":"string" - }, - "resourceType":{ - "type":"string" - }, - "agentId":{ - "type":"string" - }, - "resourceClass":{ - "type":"string" - }, - "name":{ - "type":"string" - }, - "cloudId":{ - "type":"string" - }, - "agentIds":{ - "type":"array", - "items":{ - "type":"string" - } - } - } - }, - "description":"Default Response" - } - } - }, - "get":{ - "description":"Retrieves a resource for an account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Resource" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"query", - "name":"account" - }, - { - "type":"string", - "required":false, - "in":"query", - "name":"resource-type" - }, - { - "type":"string", - "required":false, - "in":"query", - "name":"workspace" - }, - { - "type":"string", - "required":false, - "in":"query", - "name":"resource-class" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Retrieve a resource", - "category":"Resource", - "filename":"get-tenancy-resource.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "resourceIdentifier":{ - "type":"string" - }, - "resourceType":{ - "type":"string" - }, - "agentId":{ - "type":"string" - }, - "resourceClass":{ - "type":"string" - }, - "name":{ - "type":"string" - }, - "metadata":{ - "type":"string" - }, - "workspaceIds":{ - "type":"array", - "items":{ - "type":"string" - } - }, - "agentIds":{ - "type":"array", - "items":{ - "type":"string" - } - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/service-resource/{resourceIdentifier}":{ - "delete":{ - "description":"Deletes a service resource from a specified account.\n
    Token usage: BlueXP service token with the following scopes: tenancy:internal.", - "tags":[ - "Resource" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"resourceIdentifier" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Delete a service resource", - "category":"Resource", - "filename":"delete-tenancy-service-resource-.html", - "explorer":false - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/resource/{resourceIdentifier}/set-cloud-id":{ - "post":{ - "description":"Sets the cloud identifier of a resource.\n
    Token usage: BlueXP user token.", - "tags":[ - "Resource" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "cloudId":{ - "type":"string" - } - }, - "required":[ - "cloudId" - ] - } - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"resourceIdentifier" - }, - { - "in":"header", - "name":"Authorization", - "required":true, - "type":"string" - }, - { - "in":"header", - "name":"X-Tenancy-Account-Id", - "required":false, - "description":"accountID to be passed.", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "type":"string" - } - ], - "deprecated":true, - "x-doc":{ - "title":"Set a cloud identifier", - "category":"Resource", - "filename":"post-tenancy-resource-set-cloud-id.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/resource/{resourceIdentifier}/account/{accountId}/set-resource-name":{ - "post":{ - "description":"Sets the name of a resource.\n
    Token usage: BlueXP user token.", - "tags":[ - "Resource" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "name":{ - "type":"string" - } - }, - "required":[ - "name" - ] - } - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"resourceIdentifier" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"Authorization", - "required":true, - "type":"string" - } - ], - "deprecated":true, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/resource/{resourceIdentifier}/add-to-workspace/{workspacePublicId}":{ - "post":{ - "description":"Adds a resource to a specified workspace.\n
    Token usage: BlueXP user token.", - "tags":[ - "Resource" - ], - "parameters":[ - { - "type":"string", - "example":"VsaWorkingEnvironment-yQFegzgz", - "required":true, - "in":"path", - "name":"resourceIdentifier" - }, - { - "type":"string", - "example":"workspace-APWLzah1", - "required":true, - "in":"path", - "name":"workspacePublicId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Add a resource to a workspace", - "category":"Resource", - "filename":"post-tenancy-resource-add-to-workspace-.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"object", - "properties":{ - "accountPublicId":{ - "type":"string" - }, - "resourcePublicId":{ - "type":"string" - }, - "resourceIdentifier":{ - "type":"string" - }, - "resourceType":{ - "type":"string" - }, - "agentId":{ - "type":"string" - }, - "resourceClass":{ - "type":"string" - }, - "cloudId":{ - "type":"string" - }, - "agentIds":{ - "type":"array", - "items":{ - "type":"string" - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/resource/{resourceIdentifier}/remove-from-workspace/{workspacePublicId}":{ - "post":{ - "description":"Removes a resource from a specified workspace.\n
    Token usage: BlueXP user token.", - "tags":[ - "Resource" - ], - "parameters":[ - { - "type":"string", - "example":"VsaWorkingEnvironment-yQFegzgz", - "required":true, - "in":"path", - "name":"resourceIdentifier" - }, - { - "type":"string", - "example":"workspace-APWLzah1", - "required":true, - "in":"path", - "name":"workspacePublicId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Remove a resource from a workspace", - "category":"Resource", - "filename":"post-tenancy-resource-remove-from-workspace-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/resource/{resourceIdentifier}/remove-from-agent/{agentId}":{ - "post":{ - "description":"Removes a resource from a specified agent.\n
    Token usage: BlueXP user token.", - "tags":[ - "Resource" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"resourceIdentifier" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"agentId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Remove a resource from an agent", - "category":"Resource", - "filename":"post-tenancy-resource-remove-from-agent-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/resource/{resourceIdentifier}":{ - "delete":{ - "description":"Deletes a resource from a specified account. accountId must be passed to the X-Tenancy-Account-Id request header.\n
    Token usage: BlueXP user token.", - "tags":[ - "Resource" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"resourceIdentifier" - }, - { - "in":"header", - "name":"Authorization", - "required":true, - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "type":"string" - }, - { - "in":"header", - "name":"X-Tenancy-Account-Id", - "required":false, - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "type":"string" - } - ], - "x-doc":{ - "title":"Delete a resource from an account", - "category":"Resource", - "filename":"delete-tenancy-resource-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/resource/{resourceIdentifier}/account/{accountId}/update":{ - "post":{ - "description":"Updates properties of a specified resource.\n
    Token usage: BlueXP user token.", - "tags":[ - "Resource" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "cloudId":{ - "type":"string" - }, - "metadata":{ - "type":"object", - "properties":{ - "propertyName":{ - "type":"string" - }, - "propertyValue":{ - "type":"string" - } - }, - "required":[ - "propertyName", - "propertyValue" - ] - } - } - } - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"resourceIdentifier" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Update properties", - "category":"Resource", - "filename":"post-tenancy-resource-account-update.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/service-resources":{ - "delete":{ - "description":"Deletes service resources from a specified account.\n
    Token usage: BlueXP service token with the following scopes: tenancy:internal.", - "tags":[ - "Resource" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "resourceIdentifiers":{ - "type":"array", - "items":{ - "type":"string" - } - } - }, - "required":[ - "resourceIdentifiers" - ] - } - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Delete a service resource", - "category":"Resource", - "filename":"delete-tenancy-service-resource-.html", - "explorer":false - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/workspace/{name}":{ - "post":{ - "description":"Creates a workspace in a specified account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Workspace" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "type":"string", - "pattern":"^[-_.a-zA-Z0-9]{1,40}$", - "required":true, - "in":"path", - "name":"name" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Create a workspace", - "category":"Workspace", - "filename":"post-tenancy-account-workspace-.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"object", - "properties":{ - "workspacePublicId":{ - "type":"string" - }, - "workspaceName":{ - "type":"string" - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/workspace/{workspacePublicId}/add-user/{userPublicId}":{ - "post":{ - "description":"Adds a user to a specified workspace.\n
    Token usage: BlueXP user token.", - "tags":[ - "Workspace" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"workspacePublicId" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"userPublicId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Add a user", - "category":"Workspace", - "filename":"post-tenancy-account-workspace-add-user-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountPublicId}/workspace/{workspacePublicId}/remove-user/{userPublicId}":{ - "post":{ - "description":"Removes a user from a specified workspace.\n
    Token usage: BlueXP user token.", - "tags":[ - "Workspace" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountPublicId" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"workspacePublicId" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"userPublicId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Remove a user", - "category":"Workspace", - "filename":"post-tenancy-account-workspace-remove-user-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/workspace/{workspacePublicId}":{ - "delete":{ - "description":"Deletes a specified workspace.\n
    Token usage: BlueXP user token.", - "tags":[ - "Workspace" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"workspacePublicId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Delete a workspace", - "category":"Workspace", - "filename":"delete-tenancy-account-workspace-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - }, - "patch":{ - "description":"Renames a workspace with a specified new name.\n
    Token usage: BlueXP user token.", - "tags":[ - "Workspace" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "newName":{ - "type":"string", - "minLength":1 - } - }, - "required":[ - "newName" - ] - } - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"workspacePublicId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Rename a workspace", - "category":"Workspace", - "filename":"patch-tenancy-account-workspace-.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"object", - "properties":{ - "workspacePublicId":{ - "type":"string" - }, - "workspaceName":{ - "type":"string" - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/workspace/{workspacePublicId}/add-agent/{agentAuth0Id}":{ - "post":{ - "description":"Adds an agent to a specified workspace.\n
    Token usage: BlueXP user token.", - "tags":[ - "Workspace" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"agentAuth0Id" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"workspacePublicId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Add an agent", - "category":"Workspace", - "filename":"post-tenancy-account-workspace-add-agent-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/workspace/{workspacePublicId}/remove-agent/{agentAuth0Id}":{ - "post":{ - "description":"Removes an agent from a specified workspace.\n
    Token usage: BlueXP user token.", - "tags":[ - "Workspace" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"agentAuth0Id" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"workspacePublicId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Remove an agent", - "category":"Workspace", - "filename":"post-tenancy-account-workspace-remove-agent-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/workspace/{workspacePublicId}/agents":{ - "get":{ - "description":"Retrieves agents associated with a specified workspace.\n
    Token usage: BlueXP user token.", - "tags":[ - "Workspace" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"workspacePublicId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Retrieve agents", - "category":"Workspace", - "filename":"get-tenancy-account-workspace-agents.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "auth0_id":{ - "type":"string" - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/workspace":{ - "get":{ - "description":"Retrieves workspaces associated with a specified account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Workspace" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Retrieve workspaces", - "category":"Workspace", - "filename":"get-tenancy-account-workspace.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "workspacePublicId":{ - "type":"string" - }, - "workspaceName":{ - "type":"string" - }, - "associatedAgents":{ - "type":"array", - "items":{ - "type":"string" - } - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/user/{userId}/workspaces":{ - "get":{ - "description":"Retrieves specified user account workspaces.\n
    Token usage: BlueXP service token with the following scopes: tenancy:external.", - "tags":[ - "Workspace" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"userId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Retrieve user account workspaces", - "category":"Workspace", - "filename":"get-tenancy-account-user-workspaces.html", - "explorer":false - }, - "responses":{ - "200":{ - "schema":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "workspacePublicId":{ - "type":"string" - }, - "workspaceName":{ - "type":"string" - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/users/for-action/{accountId}/{action}/{resourceId}":{ - "get":{ - "description":"Retrieves users authorized for actions on a particular resource.\n
    Token usage: BlueXP service token with the following scopes: tenancy:internal.", - "tags":[ - "User" - ], - "parameters":[ - { - "type":"boolean", - "required":false, - "in":"query", - "name":"enforce_ws" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"action" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"resourceId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Retrieve users authorized for single resource", - "category":"User", - "filename":"get-tenancy-users-for-action--.html", - "explorer":false - }, - "responses":{ - "200":{ - "schema":{ - "type":"object", - "properties":{ - "userIds":{ - "type":"array", - "items":{ - "type":"string" - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/users/for-action/{accountId}/{action}":{ - "get":{ - "description":"Retrieves users authorized for actions across all resources.\n
    Token usage: BlueXP service token with the following scopes: tenancy:internal.", - "tags":[ - "User" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"action" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Retrieve users authorized for all resources", - "category":"User", - "filename":"get-tenancy-users-for-action-.html", - "explorer":false - }, - "responses":{ - "200":{ - "schema":{ - "type":"object", - "properties":{ - "userIds":{ - "type":"array", - "items":{ - "type":"string" - } - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/service-account":{ - "post":{ - "description":"Creates a service account on a specified account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Service Account" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "serviceAccountName":{ - "description":"Service account name", - "type":"string", - "pattern":"^[-_.a-zA-Z0-9]{1,40}$" - }, - "rolePublicId":{ - "description":"Service account role", - "type":"string" - }, - "workspacePublicIds":{ - "description":"Service account workspaces", - "type":"array", - "items":{ - "type":"string" - } - } - }, - "required":[ - "serviceAccountName", - "rolePublicId" - ] - } - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Create a service account", - "category":"Service Account", - "filename":"post-tenancy-account-service-account.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"object", - "properties":{ - "clientId":{ - "type":"string" - }, - "clientSecret":{ - "type":"string" - }, - "publicId":{ - "type":"string" - } - } - }, - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/service-account/{serviceAccountId}":{ - "delete":{ - "description":"Deletes a service account from a specified account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Service Account" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "description":"Service Account Client ID. Do not provide the Service Account Public ID. ", - "type":"string", - "example":"BjwDgGkg28cLKg70pLUwz9rY87Ff5xHK", - "required":true, - "in":"path", - "name":"serviceAccountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Delete a service account", - "category":"Service Account", - "filename":"delete-tenancy-account-service-account-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - }, - "patch":{ - "description":"Updates the service account details of a specified account.\n
    Token usage: BlueXP user token.", - "tags":[ - "Service Account" - ], - "parameters":[ - { - "name":"body", - "in":"body", - "schema":{ - "type":"object", - "properties":{ - "serviceAccountName":{ - "description":"Service account name", - "type":"string", - "pattern":"^[-_.a-zA-Z0-9]{1,40}$" - }, - "rolePublicId":{ - "description":"Service account role", - "type":"string" - }, - "workspacePublicIds":{ - "description":"Service account workspaces", - "type":"array", - "items":{ - "type":"string" - } - } - } - } - }, - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "description":"Service Account Client ID. Do not provide the Service Account Public ID. ", - "type":"string", - "example":"BjwDgGkg28cLKg70pLUwz9rY87Ff5xHK", - "required":true, - "in":"path", - "name":"serviceAccountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Update details", - "category":"Service Account", - "filename":"patch-tenancy-account-service-account-.html" - }, - "responses":{ - "200":{ - "description":"Default Response" - } - } - } - }, - "/tenancy/account/{accountId}/service-account/{serviceAccountId}/generate-service-account-secret":{ - "post":{ - "description":"Generates the service account secret.\n
    Token usage: BlueXP user token.", - "tags":[ - "Service Account" - ], - "parameters":[ - { - "type":"string", - "required":true, - "in":"path", - "name":"accountId" - }, - { - "description":"Service Account Client ID. Do not provide the Service Account Public ID. ", - "type":"string", - "example":"BjwDgGkg28cLKg70pLUwz9rY87Ff5xHK", - "required":true, - "in":"path", - "name":"serviceAccountId" - }, - { - "in":"header", - "name":"authorization", - "required":true, - "description":"Authorization JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-User-Token", - "required":false, - "description":"User JWT access token", - "type":"string" - }, - { - "in":"header", - "name":"X-Service-Request-Id", - "required":false, - "description":"Request identifier", - "type":"string" - } - ], - "x-doc":{ - "title":"Generate a secret", - "category":"Service Account", - "filename":"post-tenancy-account-service-account-generate-service-account-secret.html" - }, - "responses":{ - "200":{ - "schema":{ - "type":"object", - "properties":{ - "clientId":{ - "type":"string" - }, - "clientSecret":{ - "type":"string" - } - } - }, - "description":"Default Response" - } - } - } - } - } -} \ No newline at end of file diff --git a/tenancy/user_overview.adoc b/tenancy/user_overview.adoc new file mode 100644 index 00000000..74af7fa0 --- /dev/null +++ b/tenancy/user_overview.adoc @@ -0,0 +1,23 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/user_overview.html' +summary: 'User endpoints in the Accounts REST API' +--- + += User endpoints in the Accounts REST API + + + ++++
    +++The user component represents the end user in the BlueXP platform. Every user is associated with an account and a workspace. + +Each user is defined through the following configuration information: + +* A unique identifier generated by the system at creation * A public visible identifier * An authorization (auth0) identifier + +The following actions can be performed with the user endpoints: + +* Retrieve users authorized for actions on a particular resource * Retrieve users authorized for actions across all resources+++
    +++ + + diff --git a/tenancy/workspace_overview.adoc b/tenancy/workspace_overview.adoc new file mode 100644 index 00000000..38ba7d4d --- /dev/null +++ b/tenancy/workspace_overview.adoc @@ -0,0 +1,27 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancy/workspace_overview.html' +summary: 'Workspace endpoints in the Accounts REST API' +--- + += Workspace endpoints in the Accounts REST API + + + ++++
    +++The workspace endpoints provide more granular access control within a given account. An account can have one or more workspaces, although a specific workspace can only be owned by one account. + +Each workspace is defined through the following configuration information: + +* Name as selected by the administrator * Unique identifier generated by the system at creation * Identifier of the owning account * One or more users allowed to operate within the workspace * One or more Connectors * One or more resources + +Limiting which users can operate within a workspace, along with the set of Connectors and resources defined for the workspace, provides a natural way to enforce access control. Additional access restrictions can be defined for the Connectors and resources within the workspace. + +Workspaces enable enhanced access control granularity by isolating resources. For example, company departments or projects can be assigned to different workspaces. This isolation provides a high level of security. + +The following actions can be performed with the workspace endpoints: + +* Create a workspace * List the workspaces within an account * Add a user to a workspace * Remove a user from a workspace * List the workspaces associated with a user * Delete a workspace * Rename a workspace * Add a Connector to a workspace * Remove a Connector from a workspace * List the Connectors associated with a workspace+++
    +++ + + diff --git a/tenancyv4/delete-folders-.adoc b/tenancyv4/delete-folders-.adoc new file mode 100644 index 00000000..4c5b608b --- /dev/null +++ b/tenancyv4/delete-folders-.adoc @@ -0,0 +1,339 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-folders-.html' +summary: 'Delete a folder' +--- + += Delete a folder + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/folders/{folder_id}`# + + + +Deletes the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the folder was deleted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-folders-folders-.adoc b/tenancyv4/delete-folders-folders-.adoc new file mode 100644 index 00000000..680f8a44 --- /dev/null +++ b/tenancyv4/delete-folders-folders-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-folders-folders-.html' +summary: 'Remove a child folder from a parent folder' +--- + += Remove a child folder from a parent folder + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/folders/{folder_id}/folders/{childfolder_id}`# + + + +Removes the specified child folder from a parent folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|childfolder_id +|string +|path +|True +a|ID of the child folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the child folder was removed from the parent folder. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-folders-projects-.adoc b/tenancyv4/delete-folders-projects-.adoc new file mode 100644 index 00000000..439db62d --- /dev/null +++ b/tenancyv4/delete-folders-projects-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-folders-projects-.html' +summary: 'Remove a project from a folder' +--- + += Remove a project from a folder + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/folders/{folder_id}/projects/{project_id}`# + + + +Removes a project from the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the project was removed from the folder. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-folders-resources-.adoc b/tenancyv4/delete-folders-resources-.adoc new file mode 100644 index 00000000..dd75c90b --- /dev/null +++ b/tenancyv4/delete-folders-resources-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-folders-resources-.html' +summary: 'Remove a resource from a folder' +--- + += Remove a resource from a folder + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/folders/{folder_id}/resources/{resource_id}`# + + + +Removes a resource from the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the resource was removed from a folder. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-folders-roles-users-.adoc b/tenancyv4/delete-folders-roles-users-.adoc new file mode 100644 index 00000000..89a80e6b --- /dev/null +++ b/tenancyv4/delete-folders-roles-users-.adoc @@ -0,0 +1,357 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-folders-roles-users-.html' +summary: 'Remove a user from a folder' +--- + += Remove a user from a folder + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/folders/{folder_id}/roles/{role_id}/users/{user_id}`# + + + +Removes a user from the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|role_id +|string +|path +|True +a|ID of the role. + +* example: 778f8579-a5b1-48ab-91c5-361acc2ee7fe + + +|=== + +== Response + +``` +Status: 204, Indicates if the user was removed from a folder. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-folders-users-.adoc b/tenancyv4/delete-folders-users-.adoc new file mode 100644 index 00000000..7f671693 --- /dev/null +++ b/tenancyv4/delete-folders-users-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-folders-users-.html' +summary: 'Remove a user from a folder' +--- + += Remove a user from a folder + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/folders/{folder_id}/users/{user_id}`# + + + +Removes a user from the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 204, Indicates if the user was removed from the folder. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-organizations-folders-.adoc b/tenancyv4/delete-organizations-folders-.adoc new file mode 100644 index 00000000..8c516699 --- /dev/null +++ b/tenancyv4/delete-organizations-folders-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-organizations-folders-.html' +summary: 'Remove a folder from an organization' +--- + += Remove a folder from an organization + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/organizations/{organization_id}/folders/{folder_id}`# + + + +Removes a folder from the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the folder was removed from an organization. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-organizations-organizations-.adoc b/tenancyv4/delete-organizations-organizations-.adoc new file mode 100644 index 00000000..4749460d --- /dev/null +++ b/tenancyv4/delete-organizations-organizations-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-organizations-organizations-.html' +summary: 'Remove a child organization from a parent organization' +--- + += Remove a child organization from a parent organization + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/organizations/{organization_id}/organizations/{childorganization_id}`# + + + +Removes the specified child organization from a parent organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|childorganization_id +|string +|path +|True +a|ID of the child organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the child organization was removed from the parent organization. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-organizations-projects-.adoc b/tenancyv4/delete-organizations-projects-.adoc new file mode 100644 index 00000000..d59fedca --- /dev/null +++ b/tenancyv4/delete-organizations-projects-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-organizations-projects-.html' +summary: 'Remove a project from an organization' +--- + += Remove a project from an organization + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/organizations/{organization_id}/projects/{project_id}`# + + + +Removes a project from the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the project was removed from an organization. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-organizations-resourcegroups-.adoc b/tenancyv4/delete-organizations-resourcegroups-.adoc new file mode 100644 index 00000000..1ed3f52a --- /dev/null +++ b/tenancyv4/delete-organizations-resourcegroups-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-organizations-resourcegroups-.html' +summary: 'Remove a resource group from an organization' +--- + += Remove a resource group from an organization + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/organizations/{organization_id}/resourcegroups/{resourcegroup_id}`# + + + +Removes a resource group from the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resourcegroup_id +|string +|path +|True +a|ID of the resource group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the resource group was removed from an organization. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-organizations-resources-.adoc b/tenancyv4/delete-organizations-resources-.adoc new file mode 100644 index 00000000..11ef4ac9 --- /dev/null +++ b/tenancyv4/delete-organizations-resources-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-organizations-resources-.html' +summary: 'Remove a resource from an organization' +--- + += Remove a resource from an organization + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/organizations/{organization_id}/resources/{resource_id}`# + + + +Removes a resource from the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the resource was removed from the organization. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-organizations-roles-users-.adoc b/tenancyv4/delete-organizations-roles-users-.adoc new file mode 100644 index 00000000..46c8fd43 --- /dev/null +++ b/tenancyv4/delete-organizations-roles-users-.adoc @@ -0,0 +1,357 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-organizations-roles-users-.html' +summary: 'Remove a user from an organization' +--- + += Remove a user from an organization + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/organizations/{organization_id}/roles/{role_id}/users/{user_id}`# + + + +Removes a user from the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|role_id +|string +|path +|True +a|ID of the role. + +* example: 778f8579-a5b1-48ab-91c5-361acc2ee7fe + + +|=== + +== Response + +``` +Status: 204, Indicates if the user was removed from the organization. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-organizations-serviceaccounts-.adoc b/tenancyv4/delete-organizations-serviceaccounts-.adoc new file mode 100644 index 00000000..165896dc --- /dev/null +++ b/tenancyv4/delete-organizations-serviceaccounts-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-organizations-serviceaccounts-.html' +summary: 'Delete a service account' +--- + += Delete a service account + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/organizations/{organization_id}/serviceAccounts/{serviceaccount_id}`# + + + +Deletes a service account under an organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|serviceaccount_id +|string +|path +|True +a|ID of the service account. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 204, Indicates if the service account was deleted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-organizations-serviceaccounts-publickeys-.adoc b/tenancyv4/delete-organizations-serviceaccounts-publickeys-.adoc new file mode 100644 index 00000000..4dd42f24 --- /dev/null +++ b/tenancyv4/delete-organizations-serviceaccounts-publickeys-.adoc @@ -0,0 +1,357 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-organizations-serviceaccounts-publickeys-.html' +summary: 'Delete a public key for a service account' +--- + += Delete a public key for a service account + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys/{publickey_id}`# + + + +Deletes a public key for the specified service account. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|serviceaccount_id +|string +|path +|True +a|ID of the service account. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|publickey_id +|string +|path +|True +a|ID of the public key. + +* example: 778f8579-a5b1-48ab-91c5-361acc2ee7fe + + +|=== + +== Response + +``` +Status: 204, Indicates if the public key was deleted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-organizations-usergroups-.adoc b/tenancyv4/delete-organizations-usergroups-.adoc new file mode 100644 index 00000000..90595eac --- /dev/null +++ b/tenancyv4/delete-organizations-usergroups-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-organizations-usergroups-.html' +summary: 'Remove a user group from an organization' +--- + += Remove a user group from an organization + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/organizations/{organization_id}/usergroups/{usergroup_id}`# + + + +Removes a user group from the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|usergroup_id +|string +|path +|True +a|ID of the user group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the user group was removed from the organization. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-organizations-users-.adoc b/tenancyv4/delete-organizations-users-.adoc new file mode 100644 index 00000000..04bf7bea --- /dev/null +++ b/tenancyv4/delete-organizations-users-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-organizations-users-.html' +summary: 'Remove a user from an organization' +--- + += Remove a user from an organization + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/organizations/{organization_id}/users/{user_id}`# + + + +Removes a user from the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 204, Indicates if the user was removed from an organization. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-partnerships-.adoc b/tenancyv4/delete-partnerships-.adoc new file mode 100644 index 00000000..4e5c13d4 --- /dev/null +++ b/tenancyv4/delete-partnerships-.adoc @@ -0,0 +1,339 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-partnerships-.html' +summary: 'Delete a partnership' +--- + += Delete a partnership + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/partnerships/{partnership_id}`# + + + +Deletes the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. A partnership includes a type, a source organization, and a destination organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates that the partnership resource was successfully deleted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-partnerships-grants-.adoc b/tenancyv4/delete-partnerships-grants-.adoc new file mode 100644 index 00000000..2afdff56 --- /dev/null +++ b/tenancyv4/delete-partnerships-grants-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-partnerships-grants-.html' +summary: 'Delete a grant' +--- + += Delete a grant + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/partnerships/{partnership_id}/grants/{grant_id}`# + + + +Deletes the specified grant from a partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership resource. A partnership includes a type and a provider organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|grant_id +|string +|path +|True +a|Grant ID. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates that the grant resource was successfully deleted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-partnerships-grants-resources-.adoc b/tenancyv4/delete-partnerships-grants-resources-.adoc new file mode 100644 index 00000000..ffb5567d --- /dev/null +++ b/tenancyv4/delete-partnerships-grants-resources-.adoc @@ -0,0 +1,357 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-partnerships-grants-resources-.html' +summary: 'Remove a resource from a grant in a partnership' +--- + += Remove a resource from a grant in a partnership + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/partnerships/{partnership_id}/grants/{grant_id}/resources/{resource_id}`# + + + +Removes a resource from the specified grant of a partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|grant_id +|string +|path +|True +a|ID of the grant used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the resource was removed from the specified grant of a specific partnership. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-partnerships-grants-users-.adoc b/tenancyv4/delete-partnerships-grants-users-.adoc new file mode 100644 index 00000000..27cf9929 --- /dev/null +++ b/tenancyv4/delete-partnerships-grants-users-.adoc @@ -0,0 +1,357 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-partnerships-grants-users-.html' +summary: 'Remove a user from a grant in a partnership' +--- + += Remove a user from a grant in a partnership + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/partnerships/{partnership_id}/grants/{grant_id}/users/{user_id}`# + + + +Removes a user from the specified grant in a partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|grant_id +|string +|path +|True +a|ID of the grant used to display users. + +* example: 778f8579-a5b1-48ab-91c5-361acc2ee7fe + + +|=== + +== Response + +``` +Status: 204, Indicates that the user was removed from the specified grant in a specific partnership. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-partnerships-resourceadmins-.adoc b/tenancyv4/delete-partnerships-resourceadmins-.adoc new file mode 100644 index 00000000..5bde992b --- /dev/null +++ b/tenancyv4/delete-partnerships-resourceadmins-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-partnerships-resourceadmins-.html' +summary: 'Remove a user from a partnership ResourceAdmin group' +--- + += Remove a user from a partnership ResourceAdmin group + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/partnerships/{partnership_id}/resourceadmins/{user_id}`# + + + +Removes a user from the ResourceAdmin group in the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 204, Indicates that the user was removed from a partnership ResourceAdmin group. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-partnerships-useradmins-.adoc b/tenancyv4/delete-partnerships-useradmins-.adoc new file mode 100644 index 00000000..0231c06d --- /dev/null +++ b/tenancyv4/delete-partnerships-useradmins-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-partnerships-useradmins-.html' +summary: 'Remove a user from the UserAdmin group in a partnership' +--- + += Remove a user from the UserAdmin group in a partnership + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/partnerships/{partnership_id}/useradmins/{user_id}`# + + + +Removes a user from the UserAdmin group of the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 204, Indicates that the user was removed from a partnership UserAdmin group. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-partnerships-users-.adoc b/tenancyv4/delete-partnerships-users-.adoc new file mode 100644 index 00000000..d4da2598 --- /dev/null +++ b/tenancyv4/delete-partnerships-users-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-partnerships-users-.html' +summary: 'Remove a user from a partnership' +--- + += Remove a user from a partnership + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/partnerships/{partnership_id}/users/{user_id}`# + + + +Removes a user from the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 204, Indicates if the user was removed from a partnership. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-projects-.adoc b/tenancyv4/delete-projects-.adoc new file mode 100644 index 00000000..57f1f349 --- /dev/null +++ b/tenancyv4/delete-projects-.adoc @@ -0,0 +1,339 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-projects-.html' +summary: 'Delete a project' +--- + += Delete a project + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/projects/{project_id}`# + + + +Deletes the specified project. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the project was deleted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-projects-resources-.adoc b/tenancyv4/delete-projects-resources-.adoc new file mode 100644 index 00000000..ae638f1a --- /dev/null +++ b/tenancyv4/delete-projects-resources-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-projects-resources-.html' +summary: 'Remove a resource from a project' +--- + += Remove a resource from a project + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/projects/{project_id}/resources/{resource_id}`# + + + +Removes a resource from the specified project. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the resource was removed from the project. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-projects-roles-users-.adoc b/tenancyv4/delete-projects-roles-users-.adoc new file mode 100644 index 00000000..141488e5 --- /dev/null +++ b/tenancyv4/delete-projects-roles-users-.adoc @@ -0,0 +1,357 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-projects-roles-users-.html' +summary: 'Remove a user from a project' +--- + += Remove a user from a project + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/projects/{project_id}/roles/{role_id}/users/{user_id}`# + + + +Removes a user from the specified project. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|role_id +|string +|path +|True +a|ID of the role. + +* example: 778f8579-a5b1-48ab-91c5-361acc2ee7fe + + +|=== + +== Response + +``` +Status: 204, Indicates if the user was removed from a project. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-projects-users-.adoc b/tenancyv4/delete-projects-users-.adoc new file mode 100644 index 00000000..f83623bc --- /dev/null +++ b/tenancyv4/delete-projects-users-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-projects-users-.html' +summary: 'Remove a user from a project' +--- + += Remove a user from a project + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/projects/{project_id}/users/{user_id}`# + + + +Removes a user from the specified project. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 204, Indicates if the user was removed from a project. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-resourcegroups-.adoc b/tenancyv4/delete-resourcegroups-.adoc new file mode 100644 index 00000000..6bffa983 --- /dev/null +++ b/tenancyv4/delete-resourcegroups-.adoc @@ -0,0 +1,339 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-resourcegroups-.html' +summary: 'Delete a resource group' +--- + += Delete a resource group + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/resourcegroups/{resourcegroup_id}`# + + + +Deletes the specified resource group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resourcegroup_id +|string +|path +|True +a|ID of the resource group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the resource group was deleted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-resourcegroups-resources-.adoc b/tenancyv4/delete-resourcegroups-resources-.adoc new file mode 100644 index 00000000..9bdf0a00 --- /dev/null +++ b/tenancyv4/delete-resourcegroups-resources-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-resourcegroups-resources-.html' +summary: 'Remove a resource from a resource group' +--- + += Remove a resource from a resource group + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/resourcegroups/{resourcegroup_id}/resources/{resource_id}`# + + + +Deletes a resource from the specified resource group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resourcegroup_id +|string +|path +|True +a|ID of the resource group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the resource was removed from a resource group. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-resources-.adoc b/tenancyv4/delete-resources-.adoc new file mode 100644 index 00000000..4cf50f5e --- /dev/null +++ b/tenancyv4/delete-resources-.adoc @@ -0,0 +1,339 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-resources-.html' +summary: 'Delete a resource' +--- + += Delete a resource + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/resources/{resource_id}`# + + + +Deletes the specified resource. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the resource was deleted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-usergroups-.adoc b/tenancyv4/delete-usergroups-.adoc new file mode 100644 index 00000000..19dc0fa2 --- /dev/null +++ b/tenancyv4/delete-usergroups-.adoc @@ -0,0 +1,339 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-usergroups-.html' +summary: 'Delete a user group' +--- + += Delete a user group + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/usergroups/{usergroup_id}`# + + + +Deletes the specified user group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|usergroup_id +|string +|path +|True +a|ID of the user group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the user group was deleted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-usergroups-users-.adoc b/tenancyv4/delete-usergroups-users-.adoc new file mode 100644 index 00000000..04172a21 --- /dev/null +++ b/tenancyv4/delete-usergroups-users-.adoc @@ -0,0 +1,348 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-usergroups-users-.html' +summary: 'Remove a user from a user group' +--- + += Remove a user from a user group + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/usergroups/{usergroup_id}/users/{user_id}`# + + + +Removes a user from the specified user group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|usergroup_id +|string +|path +|True +a|ID of the user group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 204, Indicates if the user was removed from a user group. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/delete-users-.adoc b/tenancyv4/delete-users-.adoc new file mode 100644 index 00000000..8bbc1506 --- /dev/null +++ b/tenancyv4/delete-users-.adoc @@ -0,0 +1,339 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/delete-users-.html' +summary: 'Delete a user' +--- + += Delete a user + +[.api-doc-operation .api-doc-operation-delete]#DELETE# [.api-doc-code-block]#`/users/{user_id}`# + + + +Deletes the specified user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 204, Indicates if the user was deleted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-folders-.adoc b/tenancyv4/get-folders-.adoc new file mode 100644 index 00000000..632d2510 --- /dev/null +++ b/tenancyv4/get-folders-.adoc @@ -0,0 +1,527 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-folders-.html' +summary: 'Retrieve a folder' +--- + += Retrieve a folder + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/folders/{folder_id}`# + + + +Retrieves the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, Returns the stored folder in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp-sales", + "resourceType": "folder", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-folders-folders-.adoc b/tenancyv4/get-folders-folders-.adoc new file mode 100644 index 00000000..9d3b4f41 --- /dev/null +++ b/tenancyv4/get-folders-folders-.adoc @@ -0,0 +1,756 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-folders-folders-.html' +summary: 'Retrieve a child folder under a parent folder' +--- + += Retrieve a child folder under a parent folder + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/folders/{folder_id}/folders/{childfolder_id}`# + + + +Retrieves a child folder under the specified parent folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|childfolder_id +|string +|path +|True +a|ID of the child folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|=== + +== Response + +``` +Status: 200, Returns the stored folder in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp-sales", + "resourceType": "folder", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-folders-folders.adoc b/tenancyv4/get-folders-folders.adoc new file mode 100644 index 00000000..d1dd71f6 --- /dev/null +++ b/tenancyv4/get-folders-folders.adoc @@ -0,0 +1,747 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-folders-folders.html' +summary: 'List all folders under a parent folder' +--- + += List all folders under a parent folder + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/folders/{folder_id}/folders`# + + + +Lists all folders under the specified parent folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all folders under a parent folder. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-folders-projects-.adoc b/tenancyv4/get-folders-projects-.adoc new file mode 100644 index 00000000..cdb35382 --- /dev/null +++ b/tenancyv4/get-folders-projects-.adoc @@ -0,0 +1,739 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-folders-projects-.html' +summary: 'Retrieve a project under a folder' +--- + += Retrieve a project under a folder + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/folders/{folder_id}/projects/{project_id}`# + + + +Retrieves a project under the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 200, Returns the stored project in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp-project-1", + "resourceType": "project", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-folders-projects.adoc b/tenancyv4/get-folders-projects.adoc new file mode 100644 index 00000000..54c6f08a --- /dev/null +++ b/tenancyv4/get-folders-projects.adoc @@ -0,0 +1,756 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-folders-projects.html' +summary: 'List all projects under a folder' +--- + += List all projects under a folder + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/folders/{folder_id}/projects`# + + + +Lists all projects under the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all projects under a parent folder +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-folders-resources-.adoc b/tenancyv4/get-folders-resources-.adoc new file mode 100644 index 00000000..0e0bd6fb --- /dev/null +++ b/tenancyv4/get-folders-resources-.adoc @@ -0,0 +1,560 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-folders-resources-.html' +summary: 'Retrieve a resource under a folder' +--- + += Retrieve a resource under a folder + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/folders/{folder_id}/resources/{resource_id}`# + + + +Retrieves a resource under the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|=== + +== Response + +``` +Status: 200, Returns the stored resource in the JSON response body if it belongs to the folder. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "volume-1", + "rawId": "cluster-1-volume-1", + "resourceType": "volume", + "tags": [ + { + "internal:bxp:folderId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-folders-resources.adoc b/tenancyv4/get-folders-resources.adoc new file mode 100644 index 00000000..2ad012f0 --- /dev/null +++ b/tenancyv4/get-folders-resources.adoc @@ -0,0 +1,656 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-folders-resources.html' +summary: 'List all resources under a folder' +--- + += List all resources under a folder + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/folders/{folder_id}/resources`# + + + +Lists all resources under the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|The ID of the folder that contains the resources. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of resources in a folder. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-folders-users-.adoc b/tenancyv4/get-folders-users-.adoc new file mode 100644 index 00000000..8c7d826a --- /dev/null +++ b/tenancyv4/get-folders-users-.adoc @@ -0,0 +1,682 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-folders-users-.html' +summary: 'Retrieve a user associated with a folder' +--- + += Retrieve a user associated with a folder + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/folders/{folder_id}/users/{user_id}`# + + + +Retrieves a user associated with the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 200, Returns the stored user in the JSON response body if it belongs to the folder. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "Adding user to NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "user-1", + "state": "ACTIVE", + "tags": [ + { + "internal:bxp:folderId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-folders-users.adoc b/tenancyv4/get-folders-users.adoc new file mode 100644 index 00000000..99c9e5d2 --- /dev/null +++ b/tenancyv4/get-folders-users.adoc @@ -0,0 +1,820 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-folders-users.html' +summary: 'List all users for a folder' +--- + += List all users for a folder + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/folders/{folder_id}/users`# + + + +Lists all users associated with the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|Folder ID used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all users for this folder. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|integer +|False +a| + +|items +|array[link:#user_1_0_get_response_body[user_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "count": 1, + "items": [ + { + "aadId": "8cb0fe27-484b-4226-a19b-9d8811f6fb6a", + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "This user is part of NetApp Sales Territory", + "editable": "string", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "string", + "ownerOrganizationId": "string", + "partner": "string", + "serviceAccount": { + "audience": "https://netapp-cloud-account.auth0.com/", + "authenticationMethod": "PRIVATE_KEY_JWT", + "expirationNotificationPeriod": "P30D", + "publicKeys": [ + { + "audience": "https://netapp-cloud-account.auth0.com/", + "expirationTimestamp": "2026-06-24T16:25:08Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "X509_CERTIFICATE", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2025-06-24T16:25:08Z", + "modificationTimestamp": "2025-06-24T16:25:08Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey+json", + "version": "1.0" + } + ] + }, + "state": "ACTIVE", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#user_1_0_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-folders.adoc b/tenancyv4/get-folders.adoc new file mode 100644 index 00000000..808781a7 --- /dev/null +++ b/tenancyv4/get-folders.adoc @@ -0,0 +1,738 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-folders.html' +summary: 'List all folders' +--- + += List all folders + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/folders`# + + + +Lists all folders in the collection. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all folders. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-.adoc b/tenancyv4/get-organizations-.adoc new file mode 100644 index 00000000..f910ba8e --- /dev/null +++ b/tenancyv4/get-organizations-.adoc @@ -0,0 +1,819 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-.html' +summary: 'Retrieve an organization' +--- + += Retrieve an organization + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}`# + + + +Retrieves the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, Returns the stored organization in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp", + "resourceType": "organization", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32, 48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:crmId": "a1a6ddeb-2a15-4907-a801-9b9c3f40a7b7" + }, + { + "internal:bxp:cmatId": "2e007562-f061-4b18-b9bd-16ef3bde524b" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-folders-.adoc b/tenancyv4/get-organizations-folders-.adoc new file mode 100644 index 00000000..3f4331b0 --- /dev/null +++ b/tenancyv4/get-organizations-folders-.adoc @@ -0,0 +1,561 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-folders-.html' +summary: 'Retrieve a folder under an organization' +--- + += Retrieve a folder under an organization + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/folders/{folder_id}`# + + + +Retrieves a folder under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|=== + +== Response + +``` +Status: 200, Returns the stored folders in the JSON response body if they belong to the organization. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp-sales", + "resourceType": "folder", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-folders.adoc b/tenancyv4/get-organizations-folders.adoc new file mode 100644 index 00000000..a72205fb --- /dev/null +++ b/tenancyv4/get-organizations-folders.adoc @@ -0,0 +1,747 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-folders.html' +summary: 'List all folders under an organization' +--- + += List all folders under an organization + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/folders`# + + + +Lists all folders under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all folders under an organization. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-projects-.adoc b/tenancyv4/get-organizations-projects-.adoc new file mode 100644 index 00000000..e08940f5 --- /dev/null +++ b/tenancyv4/get-organizations-projects-.adoc @@ -0,0 +1,756 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-projects-.html' +summary: 'Retrieve a project under an organization' +--- + += Retrieve a project under an organization + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/projects/{project_id}`# + + + +Retrieves a project under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|=== + +== Response + +``` +Status: 200, Returns the stored project in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp-project-1", + "resourceType": "project", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-projects.adoc b/tenancyv4/get-organizations-projects.adoc new file mode 100644 index 00000000..7dc0d0c2 --- /dev/null +++ b/tenancyv4/get-organizations-projects.adoc @@ -0,0 +1,756 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-projects.html' +summary: 'List all projects under an organization' +--- + += List all projects under an organization + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/projects`# + + + +Lists all projects under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all projects under an organization. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-resourcegroups-.adoc b/tenancyv4/get-organizations-resourcegroups-.adoc new file mode 100644 index 00000000..b541f023 --- /dev/null +++ b/tenancyv4/get-organizations-resourcegroups-.adoc @@ -0,0 +1,498 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-resourcegroups-.html' +summary: 'Retrieve a resource group under an organization' +--- + += Retrieve a resource group under an organization + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/resourcegroups/{resourcegroup_id}`# + + + +Retrieves a resource group under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resourcegroup_id +|string +|path +|True +a|ID of the resource group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 200, Returns the stored resource group in the JSON response body if it belongs to the organization. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of this resource group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this resource group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcegroup" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This resourcegroup is part of NetApp sales group", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "AcmeUsers", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "tags": [ + { + "internal:bxp:organizationId": "a411662b-98b7-4137-a726-cd0f9f54a471" + } + ], + "type": "application/vnd.netapp.bxp.resourcegroup", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-resourcegroups.adoc b/tenancyv4/get-organizations-resourcegroups.adoc new file mode 100644 index 00000000..2a323e8d --- /dev/null +++ b/tenancyv4/get-organizations-resourcegroups.adoc @@ -0,0 +1,606 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-resourcegroups.html' +summary: 'List all resource groups under an organization' +--- + += List all resource groups under an organization + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/resourcegroups`# + + + +Lists all resource groups under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all resource groups in an organization. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resourcegroup_1_0_get_response_body[resourcegroup_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "This resourcegroup is part of NetApp sales group", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "StorageAdmin", + "ownerOrganizationId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resourcegroup", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resourcegroup_1_0_get_response_body] +[.api-collapsible-fifth-title] +resourcegroup_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of this resource group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this resource group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcegroup" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-resources-.adoc b/tenancyv4/get-organizations-resources-.adoc new file mode 100644 index 00000000..6c0cd232 --- /dev/null +++ b/tenancyv4/get-organizations-resources-.adoc @@ -0,0 +1,560 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-resources-.html' +summary: 'Retrieve a resource under an organization' +--- + += Retrieve a resource under an organization + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/resources/{resource_id}`# + + + +Retrieves a resource under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|=== + +== Response + +``` +Status: 200, Returns the stored resource in the JSON response body if it belongs to the organization. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "volume-1", + "rawId": "cluster-1-volume-1", + "resourceType": "volume", + "tags": [ + { + "internal:bxp:organizationId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-resources.adoc b/tenancyv4/get-organizations-resources.adoc new file mode 100644 index 00000000..4842d126 --- /dev/null +++ b/tenancyv4/get-organizations-resources.adoc @@ -0,0 +1,656 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-resources.html' +summary: 'List all resources under an organization' +--- + += List all resources under an organization + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/resources`# + + + +Lists all resources under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|Organization ID used to display resources. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of resources under an organization. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-serviceaccounts-.adoc b/tenancyv4/get-organizations-serviceaccounts-.adoc new file mode 100644 index 00000000..972bde21 --- /dev/null +++ b/tenancyv4/get-organizations-serviceaccounts-.adoc @@ -0,0 +1,683 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-serviceaccounts-.html' +summary: 'Retrieve a service account' +--- + += Retrieve a service account + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/serviceAccounts/{serviceaccount_id}`# + + + +Retrieves a service account under an organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|serviceaccount_id +|string +|path +|True +a|ID of the service account. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 200, Returns the stored user in the JSON response body if it belongs to the user group. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "Adding user to NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "user-1", + "state": "ACTIVE", + "tags": [ + { + "internal:bxp:usergroupId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-serviceaccounts-publickeys.adoc b/tenancyv4/get-organizations-serviceaccounts-publickeys.adoc new file mode 100644 index 00000000..41c8799a --- /dev/null +++ b/tenancyv4/get-organizations-serviceaccounts-publickeys.adoc @@ -0,0 +1,274 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-serviceaccounts-publickeys.html' +summary: 'List all the public keys for a service account' +--- + += List all the public keys for a service account + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys`# + + + +Lists all public keys for the specified service account. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|serviceaccount_id +|string +|path +|True +a|ID of the service account. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 200, List of all public keys for the service account. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|items +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|True +a| + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "items": [ + { + "audience": "https://netapp-cloud-account.auth0.com/", + "credentialId": "cred_fh4agpsm4BphW5QZiYhHR8", + "expirationTimestamp": "2026-06-24T16:25:08Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "RSA_KEY", + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey", + "version": "1.0" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-usergroups-.adoc b/tenancyv4/get-organizations-usergroups-.adoc new file mode 100644 index 00000000..6b2a0f62 --- /dev/null +++ b/tenancyv4/get-organizations-usergroups-.adoc @@ -0,0 +1,510 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-usergroups-.html' +summary: 'Retrieve a user group under an organization' +--- + += Retrieve a user group under an organization + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/usergroups/{usergroup_id}`# + + + +Retrieves a user group under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|usergroup_id +|string +|path +|True +a|ID of the user group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 200, Returns the stored user group in the JSON response body if it belongs to the organization. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This tag represents NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "AcmeUsers", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "tags": [ + { + "internal:bxp:organizationId": "36d4cc43-0b0f-4363-b922-eed1d80f8ea6" + } + ], + "type": "application/vnd.netapp.bxp.usergroup", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-usergroups.adoc b/tenancyv4/get-organizations-usergroups.adoc new file mode 100644 index 00000000..04977e9c --- /dev/null +++ b/tenancyv4/get-organizations-usergroups.adoc @@ -0,0 +1,619 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-usergroups.html' +summary: 'List all user groups under an organization' +--- + += List all user groups under an organization + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/usergroups`# + + + +Lists all user groups under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all user groups in the organization. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#usergroup_1_0_get_response_body[usergroup_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "This usergroup is part of NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "StorageAdmin", + "ownerOrganizationId": "string", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.usergroup", + "usergroupType": "SYSTEM", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#usergroup_1_0_get_response_body] +[.api-collapsible-fifth-title] +usergroup_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-users-.adoc b/tenancyv4/get-organizations-users-.adoc new file mode 100644 index 00000000..4d58d292 --- /dev/null +++ b/tenancyv4/get-organizations-users-.adoc @@ -0,0 +1,682 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-users-.html' +summary: 'Retrieve a user under an organization' +--- + += Retrieve a user under an organization + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/users/{user_id}`# + + + +Retrieves a user under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 200, Returns the stored user in the JSON response body if it belongs to the organization. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "Adding user to NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "user-1", + "state": "ACTIVE", + "tags": [ + { + "internal:bxp:organizationId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations-users.adoc b/tenancyv4/get-organizations-users.adoc new file mode 100644 index 00000000..44e0ba6b --- /dev/null +++ b/tenancyv4/get-organizations-users.adoc @@ -0,0 +1,820 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations-users.html' +summary: 'List all users under an organization' +--- + += List all users under an organization + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations/{organization_id}/users`# + + + +Lists all users under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|Organization ID used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all users. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|integer +|False +a| + +|items +|array[link:#user_1_0_get_response_body[user_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "count": 1, + "items": [ + { + "aadId": "8cb0fe27-484b-4226-a19b-9d8811f6fb6a", + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "This user is part of NetApp Sales Territory", + "editable": "string", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "string", + "ownerOrganizationId": "string", + "partner": "string", + "serviceAccount": { + "audience": "https://netapp-cloud-account.auth0.com/", + "authenticationMethod": "PRIVATE_KEY_JWT", + "expirationNotificationPeriod": "P30D", + "publicKeys": [ + { + "audience": "https://netapp-cloud-account.auth0.com/", + "expirationTimestamp": "2026-06-24T16:25:08Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "X509_CERTIFICATE", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2025-06-24T16:25:08Z", + "modificationTimestamp": "2025-06-24T16:25:08Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey+json", + "version": "1.0" + } + ] + }, + "state": "ACTIVE", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#user_1_0_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-organizations.adoc b/tenancyv4/get-organizations.adoc new file mode 100644 index 00000000..605c5d67 --- /dev/null +++ b/tenancyv4/get-organizations.adoc @@ -0,0 +1,738 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-organizations.html' +summary: 'List all organizations' +--- + += List all organizations + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/organizations`# + + + +Lists all organizations. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all organizations. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships-.adoc b/tenancyv4/get-partnerships-.adoc new file mode 100644 index 00000000..04b2bb63 --- /dev/null +++ b/tenancyv4/get-partnerships-.adoc @@ -0,0 +1,742 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships-.html' +summary: 'Retrieve a partnership' +--- + += Retrieve a partnership + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships/{partnership_id}`# + + + +Retrieves information about the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. A partnership includes a type, a source organization, and a destination organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 200, Returns the stored partnership in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|destinationOrganizationId +|string +|False +a|The ID of the destination organization that shares its users. + + +|destinationOrganizationName +|string +|False +a|The name of the destination organization that shares its users. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|initiatedUserEmail +|string +|False +a|The email address of the user who initiated the partnership. + + +|initiatedUserName +|string +|False +a|The name of the user who initiated the partnership. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" +* "false" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing the partnership name (for example: "Partnership between Acme and PopShop", ...). +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|partnershipType +|string +|False +a|Type of partnership. + + +|sourceOrganizationId +|string +|False +a|The ID of the source organization that shares its resources. + + +|sourceOrganizationName +|string +|False +a|The name of the source organization that shares its resources. + + +|state +|string +|True +a|State of this record. +Defined values are: + +*** Minimum length: 1 + +*** Maximum length: 254 + +Possible values are: + +*** SOURCE_INITIATED + +*** DESTINATION_INITIATED + +*** APPROVED + +*** REJECTED + +*** HOLD + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this partnership. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.partnership" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "destinationOrganizationId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "Partnership between Prov and Acme", + "ownerOrganizationId": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "partnershipType": "msp", + "sourceOrganizationId": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "state": "APPROVED", + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships-grants-.adoc b/tenancyv4/get-partnerships-grants-.adoc new file mode 100644 index 00000000..8fc8ae37 --- /dev/null +++ b/tenancyv4/get-partnerships-grants-.adoc @@ -0,0 +1,782 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships-grants-.html' +summary: 'Retrieve a grant' +--- + += Retrieve a grant + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships/{partnership_id}/grants/{grant_id}`# + + + +Retrieves the specified grant and its components from a partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership resource. A partnership includes a type and a provider organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|grant_id +|string +|path +|True +a|Grant ID. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 200, Returns the stored grant resource in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|True +a|JSON string containing the description of the grant. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" +* "false" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing the associated name. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization that owns this resource. + + +|resources +|array[link:#grant_1_0_get_extended_resource_response_body[grant_1.0_get_extended_resource_response_body]] +|False +a| + +|role +|string +|True +a|JSON string containing the associated role ID. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.grant" + + +|users +|array[link:#grant_1_0_get_extended_user_response_body[grant_1.0_get_extended_user_response_body]] +|False +a| + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Associate users to manage Dev pool", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "ScopeAdminGrant", + "role": "9e94cf09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.grant", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#grant_1_0_get_extended_resource_response_body] +[.api-collapsible-fifth-title] +grant_1.0_get_extended_resource_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resourceClass +|string +|False +a|JSON string containing the resource class. + + +|resourceId +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|resourceName +|string +|False +a|JSON string containing the resource name. + + +|resourceType +|string +|False +a|JSON string containing the resource type. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#grant_1_0_get_extended_user_response_body] +[.api-collapsible-fifth-title] +grant_1.0_get_extended_user_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lastLoginDate +|string +|False +a|The date and time when the user last logged in. + + +|userEmail +|string +|False +a|User email address. + + +|userId +|string +|False +a|Globally unique identifier of the user. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|userName +|string +|False +a|JSON string containing the user name. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships-grants-resources-.adoc b/tenancyv4/get-partnerships-grants-resources-.adoc new file mode 100644 index 00000000..507f0de4 --- /dev/null +++ b/tenancyv4/get-partnerships-grants-resources-.adoc @@ -0,0 +1,569 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships-grants-resources-.html' +summary: 'Retrieve a resource from a grant in a partnership' +--- + += Retrieve a resource from a grant in a partnership + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships/{partnership_id}/grants/{grant_id}/resources/{resource_id}`# + + + +Retrieves a resource under the specified grant of a partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|grant_id +|string +|path +|True +a|ID of the grant used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|=== + +== Response + +``` +Status: 200, Returns the stored resource in the JSON response body if it belongs to the specified grant of a specific partnership. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "volume-1", + "rawId": "cluster-1-volume-1", + "resourceType": "volume", + "tags": [ + { + "internal:bxp:folderId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships-grants-resources.adoc b/tenancyv4/get-partnerships-grants-resources.adoc new file mode 100644 index 00000000..9d9e7e37 --- /dev/null +++ b/tenancyv4/get-partnerships-grants-resources.adoc @@ -0,0 +1,665 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships-grants-resources.html' +summary: 'List all resources for a grant in a partnership' +--- + += List all resources for a grant in a partnership + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships/{partnership_id}/grants/{grant_id}/resources`# + + + +Lists all resources under the specified grant of a partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|grant_id +|string +|path +|True +a|ID of the grant used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of resources under the specified grant of a specific partnership. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships-grants-users-.adoc b/tenancyv4/get-partnerships-grants-users-.adoc new file mode 100644 index 00000000..69965a76 --- /dev/null +++ b/tenancyv4/get-partnerships-grants-users-.adoc @@ -0,0 +1,691 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships-grants-users-.html' +summary: 'Retrieve a user with a grant in a partnership' +--- + += Retrieve a user with a grant in a partnership + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships/{partnership_id}/grants/{grant_id}/users/{user_id}`# + + + +Retrieves a user in the specified grant in a partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|grant_id +|string +|path +|True +a|ID of the grant used to display users. + +* example: 778f8579-a5b1-48ab-91c5-361acc2ee7fe + + +|=== + +== Response + +``` +Status: 200, Returns the stored user in the JSON response body if it belongs to the specified grant from a specific partnership. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isServiceAccount": false, + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "user-1", + "state": "ACTIVE", + "tags": [ + { + "internal:bxp:usergroupId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships-grants-users.adoc b/tenancyv4/get-partnerships-grants-users.adoc new file mode 100644 index 00000000..98482d50 --- /dev/null +++ b/tenancyv4/get-partnerships-grants-users.adoc @@ -0,0 +1,829 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships-grants-users.html' +summary: 'List all users for a grant in a partnership' +--- + += List all users for a grant in a partnership + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships/{partnership_id}/grants/{grant_id}/users`# + + + +Lists all users in the specified grant for a partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|grant_id +|string +|path +|True +a|ID of the grant used to display users. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, Lists all users in the specified grant for a specific partnership. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|integer +|False +a| + +|items +|array[link:#user_1_0_get_response_body[user_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "count": 1, + "items": [ + { + "aadId": "8cb0fe27-484b-4226-a19b-9d8811f6fb6a", + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "This user is part of NetApp Sales Territory", + "editable": "string", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "string", + "ownerOrganizationId": "string", + "partner": "string", + "serviceAccount": { + "audience": "https://netapp-cloud-account.auth0.com/", + "authenticationMethod": "PRIVATE_KEY_JWT", + "expirationNotificationPeriod": "P30D", + "publicKeys": [ + { + "audience": "https://netapp-cloud-account.auth0.com/", + "expirationTimestamp": "2026-06-24T16:25:08Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "X509_CERTIFICATE", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2025-06-24T16:25:08Z", + "modificationTimestamp": "2025-06-24T16:25:08Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey+json", + "version": "1.0" + } + ] + }, + "state": "ACTIVE", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#user_1_0_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships-grants.adoc b/tenancyv4/get-partnerships-grants.adoc new file mode 100644 index 00000000..ac96b7b8 --- /dev/null +++ b/tenancyv4/get-partnerships-grants.adoc @@ -0,0 +1,717 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships-grants.html' +summary: 'List all grants for a partnership' +--- + += List all grants for a partnership + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships/{partnership_id}/grants`# + + + +Lists all the grants for the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership resource. A partnership includes a type and a provider organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all grants. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#grant_1_0_get_response_body[grant_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Partner Users managing the Dev pool", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "string", + "ownerOrganizationId": "string", + "resources": [ + { + "resourceClass": "string", + "resourceId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "resourceName": "string", + "resourceType": "string" + } + ], + "role": "string", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.grant", + "users": [ + { + "lastLoginDate": "2026-06-24T16:25:08Z", + "userEmail": "email@acme.com", + "userId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "userName": "string" + } + ], + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#grant_1_0_get_extended_resource_response_body] +[.api-collapsible-fifth-title] +grant_1.0_get_extended_resource_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resourceClass +|string +|False +a|JSON string containing the resource class. + + +|resourceId +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|resourceName +|string +|False +a|JSON string containing the resource name. + + +|resourceType +|string +|False +a|JSON string containing the resource type. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#grant_1_0_get_extended_user_response_body] +[.api-collapsible-fifth-title] +grant_1.0_get_extended_user_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|lastLoginDate +|string +|False +a|The date and time when the user last logged in. + + +|userEmail +|string +|False +a|User email address. + + +|userId +|string +|False +a|Globally unique identifier of the user. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|userName +|string +|False +a|JSON string containing the user name. + + +|=== + + +[#grant_1_0_get_response_body] +[.api-collapsible-fifth-title] +grant_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|True +a|JSON string containing the description of the grant. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" +* "false" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing the associated name. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization that owns this resource. + + +|resources +|array[link:#grant_1_0_get_extended_resource_response_body[grant_1.0_get_extended_resource_response_body]] +|False +a| + +|role +|string +|True +a|JSON string containing the associated role ID. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.grant" + + +|users +|array[link:#grant_1_0_get_extended_user_response_body[grant_1.0_get_extended_user_response_body]] +|False +a| + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships-resourceadmins-.adoc b/tenancyv4/get-partnerships-resourceadmins-.adoc new file mode 100644 index 00000000..e5fdcb76 --- /dev/null +++ b/tenancyv4/get-partnerships-resourceadmins-.adoc @@ -0,0 +1,682 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships-resourceadmins-.html' +summary: 'Retrieve a user in a partnership ResourceAdmin group' +--- + += Retrieve a user in a partnership ResourceAdmin group + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships/{partnership_id}/resourceadmins/{user_id}`# + + + +Retrieves a user in the ResourceAdmin group of the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 200, Returns the stored user in the JSON response body if it belongs to the partnership ResourceAdmin group. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isServiceAccount": false, + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "user-1", + "state": "ACTIVE", + "tags": [ + { + "internal:bxp:usergroupId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships-resourceadmins.adoc b/tenancyv4/get-partnerships-resourceadmins.adoc new file mode 100644 index 00000000..c3de1f0b --- /dev/null +++ b/tenancyv4/get-partnerships-resourceadmins.adoc @@ -0,0 +1,820 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships-resourceadmins.html' +summary: 'List all users for a partnership' +--- + += List all users for a partnership + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships/{partnership_id}/resourceadmins`# + + + +Lists all users with the ResourceAdmin role in the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership used to display users with the ResourceAdmin role. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all users for this partnership with the ResourceAdmin role. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|integer +|False +a| + +|items +|array[link:#user_1_0_get_response_body[user_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "count": 1, + "items": [ + { + "aadId": "8cb0fe27-484b-4226-a19b-9d8811f6fb6a", + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "This user is part of NetApp Sales Territory", + "editable": "string", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "string", + "ownerOrganizationId": "string", + "partner": "string", + "serviceAccount": { + "audience": "https://netapp-cloud-account.auth0.com/", + "authenticationMethod": "PRIVATE_KEY_JWT", + "expirationNotificationPeriod": "P30D", + "publicKeys": [ + { + "audience": "https://netapp-cloud-account.auth0.com/", + "expirationTimestamp": "2026-06-24T16:25:08Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "X509_CERTIFICATE", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2025-06-24T16:25:08Z", + "modificationTimestamp": "2025-06-24T16:25:08Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey+json", + "version": "1.0" + } + ] + }, + "state": "ACTIVE", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#user_1_0_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships-useradmins-.adoc b/tenancyv4/get-partnerships-useradmins-.adoc new file mode 100644 index 00000000..3223cdc2 --- /dev/null +++ b/tenancyv4/get-partnerships-useradmins-.adoc @@ -0,0 +1,682 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships-useradmins-.html' +summary: 'Retrieve a user in the UserAdmin group in a partnership' +--- + += Retrieve a user in the UserAdmin group in a partnership + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships/{partnership_id}/useradmins/{user_id}`# + + + +Retrieves a user in the UserAdmin group in the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 200, Returns the stored user in the JSON response body if it belongs to the partnership UserAdmin group. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isServiceAccount": false, + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "user-1", + "state": "ACTIVE", + "tags": [ + { + "internal:bxp:usergroupId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships-useradmins.adoc b/tenancyv4/get-partnerships-useradmins.adoc new file mode 100644 index 00000000..20d90764 --- /dev/null +++ b/tenancyv4/get-partnerships-useradmins.adoc @@ -0,0 +1,820 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships-useradmins.html' +summary: 'List all users with the UserAdmin role in a partnership' +--- + += List all users with the UserAdmin role in a partnership + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships/{partnership_id}/useradmins`# + + + +Lists all users with the UserAdmin role in the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership used to display users with the UserAdmin role. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all users for this partnership with the UserAdmin role. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|integer +|False +a| + +|items +|array[link:#user_1_0_get_response_body[user_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "count": 1, + "items": [ + { + "aadId": "8cb0fe27-484b-4226-a19b-9d8811f6fb6a", + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "This user is part of NetApp Sales Territory", + "editable": "string", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "string", + "ownerOrganizationId": "string", + "partner": "string", + "serviceAccount": { + "audience": "https://netapp-cloud-account.auth0.com/", + "authenticationMethod": "PRIVATE_KEY_JWT", + "expirationNotificationPeriod": "P30D", + "publicKeys": [ + { + "audience": "https://netapp-cloud-account.auth0.com/", + "expirationTimestamp": "2026-06-24T16:25:08Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "X509_CERTIFICATE", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2025-06-24T16:25:08Z", + "modificationTimestamp": "2025-06-24T16:25:08Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey+json", + "version": "1.0" + } + ] + }, + "state": "ACTIVE", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#user_1_0_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships-users-.adoc b/tenancyv4/get-partnerships-users-.adoc new file mode 100644 index 00000000..31b851b6 --- /dev/null +++ b/tenancyv4/get-partnerships-users-.adoc @@ -0,0 +1,682 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships-users-.html' +summary: 'Retrieve a user in a partnership' +--- + += Retrieve a user in a partnership + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships/{partnership_id}/users/{user_id}`# + + + +Retrieves a user in the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 200, Returns the stored user in the JSON response body if it belongs to the partnership. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isServiceAccount": false, + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "user-1", + "state": "ACTIVE", + "tags": [ + { + "internal:bxp:usergroupId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships-users.adoc b/tenancyv4/get-partnerships-users.adoc new file mode 100644 index 00000000..015f7bba --- /dev/null +++ b/tenancyv4/get-partnerships-users.adoc @@ -0,0 +1,820 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships-users.html' +summary: 'List all users for a partnership' +--- + += List all users for a partnership + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships/{partnership_id}/users`# + + + +Lists all users in the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all users for this partnership. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|integer +|False +a| + +|items +|array[link:#user_1_0_get_response_body[user_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "count": 1, + "items": [ + { + "aadId": "8cb0fe27-484b-4226-a19b-9d8811f6fb6a", + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "This user is part of NetApp Sales Territory", + "editable": "string", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "string", + "ownerOrganizationId": "string", + "partner": "string", + "serviceAccount": { + "audience": "https://netapp-cloud-account.auth0.com/", + "authenticationMethod": "PRIVATE_KEY_JWT", + "expirationNotificationPeriod": "P30D", + "publicKeys": [ + { + "audience": "https://netapp-cloud-account.auth0.com/", + "expirationTimestamp": "2026-06-24T16:25:08Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "X509_CERTIFICATE", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2025-06-24T16:25:08Z", + "modificationTimestamp": "2025-06-24T16:25:08Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey+json", + "version": "1.0" + } + ] + }, + "state": "ACTIVE", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#user_1_0_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnerships.adoc b/tenancyv4/get-partnerships.adoc new file mode 100644 index 00000000..86340e8c --- /dev/null +++ b/tenancyv4/get-partnerships.adoc @@ -0,0 +1,926 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnerships.html' +summary: 'List all partnerships' +--- + += List all partnerships + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnerships`# + + + +Retrieves a list of all partnerships. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of partnerships. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#partnership_1_0_get_response_body[partnership_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "count": 2, + "items": [ + { + "destinationOrganizationId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "Partnership between Prov and Acme", + "ownerOrganizationId": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "partnershipType": "msp", + "sourceOrganizationId": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "state": "APPROVED", + "type": "application/vnd.netapp.bxp.partnership", + "version": "1.0" + }, + { + "destinationOrganizationId": "467a3f38-d4fa-5b62-a391-a69029758d32", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "Partnership between SubProv and Acme", + "ownerOrganizationId": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "partnershipType": "reseller", + "sourceOrganizationId": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "state": "APPROVED", + "type": "application/vnd.netapp.bxp.partnership", + "version": "1.0" + } + ] +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#partnership_1_0_get_response_body] +[.api-collapsible-fifth-title] +partnership_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|destinationOrganizationId +|string +|False +a|The ID of the destination organization that shares its users. + + +|destinationOrganizationName +|string +|False +a|The name of the destination organization that shares its users. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|initiatedUserEmail +|string +|False +a|The email address of the user who initiated the partnership. + + +|initiatedUserName +|string +|False +a|The name of the user who initiated the partnership. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" +* "false" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing the partnership name (for example: "Partnership between Acme and PopShop", ...). +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|partnershipType +|string +|False +a|Type of partnership. + + +|sourceOrganizationId +|string +|False +a|The ID of the source organization that shares its resources. + + +|sourceOrganizationName +|string +|False +a|The name of the source organization that shares its resources. + + +|state +|string +|True +a|State of this record. +Defined values are: + +*** Minimum length: 1 + +*** Maximum length: 254 + +Possible values are: + +*** SOURCE_INITIATED + +*** DESTINATION_INITIATED + +*** APPROVED + +*** REJECTED + +*** HOLD + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this partnership. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.partnership" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnershiptypes-.adoc b/tenancyv4/get-partnershiptypes-.adoc new file mode 100644 index 00000000..b64bc78b --- /dev/null +++ b/tenancyv4/get-partnershiptypes-.adoc @@ -0,0 +1,693 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnershiptypes-.html' +summary: 'Retrieve a partnership type' +--- + += Retrieve a partnership type + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnershiptypes/{partnershiptype_id}`# + + + +Retrieves information about the specified partnership type. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnershiptype_id +|string +|path +|True +a|ID of the partnershipType. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 200, Returns the stored partnershipType in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|allowOrganizationSwitch +|string +|False +a|JSON string indicating if users of this partnership can switch organizations. +Defined values are: + +* true +* false + + +|description +|string +|False +a|JSON string containing the description of the partnershipType Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing the partnershipType name (for example: "reseller", "distributor", ...). +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|roles +|array[string] +|False +a|JSON array of UUIDs. Represents the list of roles (by role ID) that are allowed to be used in this partnership type. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this partnershipType. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.partnershipType" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "allowOrganizationSwitch": true, + "description": "Added new partnershipType", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "reseller", + "roles": [ + "9e94cf09-8036-51e4-b579-bd30cb07b269", + "09876f34-8036-51e4-b579-bd30cb07b465" + ], + "type": "application/vnd.netapp.bxp.partnershiptype", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-partnershiptypes.adoc b/tenancyv4/get-partnershiptypes.adoc new file mode 100644 index 00000000..e96959a1 --- /dev/null +++ b/tenancyv4/get-partnershiptypes.adoc @@ -0,0 +1,610 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-partnershiptypes.html' +summary: 'List all partnership types' +--- + += List all partnership types + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/partnershiptypes`# + + + +Lists all partnership types. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all partnershiptypes +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#partnershiptype_1_0_get_response_body[partnershiptype_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "allowOrganizationSwitch": true, + "description": "Added new partnershipType", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "reseller", + "roles": [ + "string" + ], + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.partnershipType", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#partnershiptype_1_0_get_response_body] +[.api-collapsible-fifth-title] +partnershiptype_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|allowOrganizationSwitch +|string +|False +a|JSON string indicating if users of this partnership can switch organizations. +Defined values are: + +* true +* false + + +|description +|string +|False +a|JSON string containing the description of the partnershipType Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing the partnershipType name (for example: "reseller", "distributor", ...). +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|roles +|array[string] +|False +a|JSON array of UUIDs. Represents the list of roles (by role ID) that are allowed to be used in this partnership type. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this partnershipType. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.partnershipType" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-permissions-.adoc b/tenancyv4/get-permissions-.adoc new file mode 100644 index 00000000..a5f7fcac --- /dev/null +++ b/tenancyv4/get-permissions-.adoc @@ -0,0 +1,679 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-permissions-.html' +summary: 'Retrieve a permission' +--- + += Retrieve a permission + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/permissions/{permission_id}`# + + + +Retrieves the specified permission. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|permission_id +|string +|path +|True +a|ID of the permission. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 200, Returns the stored permission in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the permission. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|rule +|string +|True +a|JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|service_application +|string +|True +a|JSON string containing the serviceApplication associated with this permission. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the permission. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.permission" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added permission which allow user to read in aiq", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "rule": "aiq:system-read", + "serviceApplication": "aiq", + "type": "application/vnd.netapp.bxp.permission", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-permissions.adoc b/tenancyv4/get-permissions.adoc new file mode 100644 index 00000000..2434d1b8 --- /dev/null +++ b/tenancyv4/get-permissions.adoc @@ -0,0 +1,573 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-permissions.html' +summary: 'List all permissions' +--- + += List all permissions + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/permissions`# + + + +Lists all permissions. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all permissions. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[Any of: link:#permission_1_0_get_response_body[permission_1.0_get_response_body], array[]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "items": [ + { + "description": "Added permission which allow user to read in aiq", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "rule": "aiq:system-read", + "serviceApplication": "aiq", + "type": "application/vnd.netapp.bxp.permission", + "version": "1.0" + }, + { + "description": "Added permission which allow user to read in aiq", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "rule": "bxp:organization-read", + "serviceApplication": "bxp", + "type": "application/vnd.netapp.bxp.permission", + "version": "1.0" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#permission_1_0_get_response_body] +[.api-collapsible-fifth-title] +permission_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the permission. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|rule +|string +|True +a|JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|service_application +|string +|True +a|JSON string containing the serviceApplication associated with this permission. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the permission. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.permission" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-projects-.adoc b/tenancyv4/get-projects-.adoc new file mode 100644 index 00000000..985ea11f --- /dev/null +++ b/tenancyv4/get-projects-.adoc @@ -0,0 +1,813 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-projects-.html' +summary: 'Retrieve a project' +--- + += Retrieve a project + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/projects/{project_id}`# + + + +Retrieves the specified project. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, Returns the stored resource in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp-project-1", + "resourceType": "project", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-projects-resources-.adoc b/tenancyv4/get-projects-resources-.adoc new file mode 100644 index 00000000..e19f7afb --- /dev/null +++ b/tenancyv4/get-projects-resources-.adoc @@ -0,0 +1,560 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-projects-resources-.html' +summary: 'Retrieve a resource in a project' +--- + += Retrieve a resource in a project + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/projects/{project_id}/resources/{resource_id}`# + + + +Retrieves a resource in a specified project. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|=== + +== Response + +``` +Status: 200, Returns the stored resource in the JSON response body if it belongs to the project. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "volume-1", + "rawId": "cluster-1-volume-1", + "resourceType": "volume", + "tags": [ + { + "internal:bxp:projectId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-projects-resources.adoc b/tenancyv4/get-projects-resources.adoc new file mode 100644 index 00000000..f9143c2a --- /dev/null +++ b/tenancyv4/get-projects-resources.adoc @@ -0,0 +1,656 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-projects-resources.html' +summary: 'List all resources in a project' +--- + += List all resources in a project + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/projects/{project_id}/resources`# + + + +Lists all resources in the specified project. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|Project ID used to display resources. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of resources in a project. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-projects-users-.adoc b/tenancyv4/get-projects-users-.adoc new file mode 100644 index 00000000..faf4db26 --- /dev/null +++ b/tenancyv4/get-projects-users-.adoc @@ -0,0 +1,682 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-projects-users-.html' +summary: 'Retrieve a user under a project' +--- + += Retrieve a user under a project + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/projects/{project_id}/users/{user_id}`# + + + +Retrieves a user under the specified project. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 200, Returns the stored user in the JSON response body if it belongs to the project. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "Adding user to NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "user-1", + "state": "ACTIVE", + "tags": [ + { + "internal:bxp:projectId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-projects-users.adoc b/tenancyv4/get-projects-users.adoc new file mode 100644 index 00000000..919dd73b --- /dev/null +++ b/tenancyv4/get-projects-users.adoc @@ -0,0 +1,820 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-projects-users.html' +summary: 'List all users for a project' +--- + += List all users for a project + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/projects/{project_id}/users`# + + + +Lists all users in the specified project. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all users for this project. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|integer +|False +a| + +|items +|array[link:#user_1_0_get_response_body[user_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "count": 1, + "items": [ + { + "aadId": "8cb0fe27-484b-4226-a19b-9d8811f6fb6a", + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "This user is part of NetApp Sales Territory", + "editable": "string", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "string", + "ownerOrganizationId": "string", + "partner": "string", + "serviceAccount": { + "audience": "https://netapp-cloud-account.auth0.com/", + "authenticationMethod": "PRIVATE_KEY_JWT", + "expirationNotificationPeriod": "P30D", + "publicKeys": [ + { + "audience": "https://netapp-cloud-account.auth0.com/", + "expirationTimestamp": "2026-06-24T16:25:08Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "X509_CERTIFICATE", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2025-06-24T16:25:08Z", + "modificationTimestamp": "2025-06-24T16:25:08Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey+json", + "version": "1.0" + } + ] + }, + "state": "ACTIVE", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#user_1_0_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-projects.adoc b/tenancyv4/get-projects.adoc new file mode 100644 index 00000000..b819052d --- /dev/null +++ b/tenancyv4/get-projects.adoc @@ -0,0 +1,738 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-projects.html' +summary: 'List all projects' +--- + += List all projects + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/projects`# + + + +Lists all projects. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all projects. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-resourcegroups-.adoc b/tenancyv4/get-resourcegroups-.adoc new file mode 100644 index 00000000..e7b4b9f4 --- /dev/null +++ b/tenancyv4/get-resourcegroups-.adoc @@ -0,0 +1,679 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-resourcegroups-.html' +summary: 'Retrieve a resource group' +--- + += Retrieve a resource group + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/resourcegroups/{resourcegroup_id}`# + + + +Retrieves the specified resource group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resourcegroup_id +|string +|path +|True +a|ID of the resource group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 200, Returns the stored resource group in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of this resource group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this resource group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcegroup" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "description": "This resourcegroup is part of NetApp sales group", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "AcmeSystems", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.resourcegroup", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-resourcegroups-resources-.adoc b/tenancyv4/get-resourcegroups-resources-.adoc new file mode 100644 index 00000000..88bf4bb4 --- /dev/null +++ b/tenancyv4/get-resourcegroups-resources-.adoc @@ -0,0 +1,560 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-resourcegroups-resources-.html' +summary: 'Retrieve a resource in a resource group' +--- + += Retrieve a resource in a resource group + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/resourcegroups/{resourcegroup_id}/resources/{resource_id}`# + + + +Retrieves a resource in the specified resource group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resourcegroup_id +|string +|path +|True +a|ID of the resource group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|=== + +== Response + +``` +Status: 200, Returns the stored resource in the JSON response body if it belongs to the resource group. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "volume-1", + "rawId": "cluster-1-volume-1", + "resourceType": "volume", + "tags": [ + { + "internal:bxp:resourcegroupId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-resourcegroups-resources.adoc b/tenancyv4/get-resourcegroups-resources.adoc new file mode 100644 index 00000000..f50e21f0 --- /dev/null +++ b/tenancyv4/get-resourcegroups-resources.adoc @@ -0,0 +1,656 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-resourcegroups-resources.html' +summary: 'List all resources for a resource group' +--- + += List all resources for a resource group + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/resourcegroups/{resourcegroup_id}/resources`# + + + +Lists all resources associated with a resource group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resourcegroup_id +|string +|path +|True +a|ID of the resource group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all resources. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-resourcegroups.adoc b/tenancyv4/get-resourcegroups.adoc new file mode 100644 index 00000000..3e63df9f --- /dev/null +++ b/tenancyv4/get-resourcegroups.adoc @@ -0,0 +1,597 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-resourcegroups.html' +summary: 'List all resource groups' +--- + += List all resource groups + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/resourcegroups`# + + + +Lists all resource groups. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all resource groups. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resourcegroup_1_0_get_response_body[resourcegroup_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "This resourcegroup is part of NetApp sales group", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "StorageAdmin", + "ownerOrganizationId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resourcegroup", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resourcegroup_1_0_get_response_body] +[.api-collapsible-fifth-title] +resourcegroup_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of this resource group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this resource group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcegroup" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-resources-.adoc b/tenancyv4/get-resources-.adoc new file mode 100644 index 00000000..52328dbc --- /dev/null +++ b/tenancyv4/get-resources-.adoc @@ -0,0 +1,812 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-resources-.html' +summary: 'Retrieve a resource' +--- + += Retrieve a resource + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/resources/{resource_id}`# + + + +Retrieves the specified resource. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, Returns the stored resource in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "volume-1", + "rawId": "cluster-1-volume-1", + "resourceType": "volume", + "tags": [ + { + "internal:bxp:organizationId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-resources-permissions-users-.adoc b/tenancyv4/get-resources-permissions-users-.adoc new file mode 100644 index 00000000..b630528c --- /dev/null +++ b/tenancyv4/get-resources-permissions-users-.adoc @@ -0,0 +1,886 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-resources-permissions-users-.html' +summary: 'Retrieve a user with a permission for a resource' +--- + += Retrieve a user with a permission for a resource + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/resources/{resource_id}/permissions/{permission_id}/users/{user_id}`# + + + +Retrieves a user with a permission for a resource + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|user_id +|string +|path +|True +a|ID of the user or aadId or auth0Id. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 or auth0\|66e41be44594c8505b0dba75 + + +|resource_id +|string +|path +|True +a|ID of the resource or legacyId. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 or account-Adcxyz + + +|permission_id +|string +|path +|True +a|ID of the permission or permission rule. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 or bxp:binding-read + + +|=== + +== Response + +``` +Status: 200, Returns the stored user in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "Adding user to NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "user-1", + "state": "ACTIVE", + "tags": [ + { + "internal:bxp:projectId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-resources-permissions-users.adoc b/tenancyv4/get-resources-permissions-users.adoc new file mode 100644 index 00000000..2c563a01 --- /dev/null +++ b/tenancyv4/get-resources-permissions-users.adoc @@ -0,0 +1,829 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-resources-permissions-users.html' +summary: 'List all users with a specific permission for a resource' +--- + += List all users with a specific permission for a resource + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/resources/{resource_id}/permissions/{permission_id}/users`# + + + +Lists all users with a specific permission for the specified resource. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|permission_id +|string +|path +|True +a|ID of the permission. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of users that have the permission on the resource. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|integer +|False +a| + +|items +|array[link:#user_1_0_get_response_body[user_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "count": 1, + "items": [ + { + "aadId": "8cb0fe27-484b-4226-a19b-9d8811f6fb6a", + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "This user is part of NetApp Sales Territory", + "editable": "string", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "string", + "ownerOrganizationId": "string", + "partner": "string", + "serviceAccount": { + "audience": "https://netapp-cloud-account.auth0.com/", + "authenticationMethod": "PRIVATE_KEY_JWT", + "expirationNotificationPeriod": "P30D", + "publicKeys": [ + { + "audience": "https://netapp-cloud-account.auth0.com/", + "expirationTimestamp": "2026-06-24T16:25:08Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "X509_CERTIFICATE", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2025-06-24T16:25:08Z", + "modificationTimestamp": "2025-06-24T16:25:08Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey+json", + "version": "1.0" + } + ] + }, + "state": "ACTIVE", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#user_1_0_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-resources-permissions.adoc b/tenancyv4/get-resources-permissions.adoc new file mode 100644 index 00000000..8c1bc426 --- /dev/null +++ b/tenancyv4/get-resources-permissions.adoc @@ -0,0 +1,582 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-resources-permissions.html' +summary: 'List all permissions for a resource' +--- + += List all permissions for a resource + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/resources/{resource_id}/permissions`# + + + +Lists all permissions available on the specified resource. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all permissions. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[Any of: link:#permission_1_0_get_response_body[permission_1.0_get_response_body], array[]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "items": [ + { + "description": "Added permission which allow user to read in aiq", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "rule": "aiq:system-read", + "serviceApplication": "aiq", + "type": "application/vnd.netapp.bxp.permission", + "version": "1.0" + }, + { + "description": "Added permission which allow user to read in aiq", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "rule": "bxp:organization-read", + "serviceApplication": "bxp", + "type": "application/vnd.netapp.bxp.permission", + "version": "1.0" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#permission_1_0_get_response_body] +[.api-collapsible-fifth-title] +permission_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the permission. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|rule +|string +|True +a|JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|service_application +|string +|True +a|JSON string containing the serviceApplication associated with this permission. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the permission. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.permission" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-resources-users.adoc b/tenancyv4/get-resources-users.adoc new file mode 100644 index 00000000..23ee64cf --- /dev/null +++ b/tenancyv4/get-resources-users.adoc @@ -0,0 +1,820 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-resources-users.html' +summary: 'List all users with permissions for a resource' +--- + += List all users with permissions for a resource + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/resources/{resource_id}/users`# + + + +Lists all users with permissions for the specified resource. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all users who have any permission on this resource +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|integer +|False +a| + +|items +|array[link:#user_1_0_get_response_body[user_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "count": 1, + "items": [ + { + "aadId": "8cb0fe27-484b-4226-a19b-9d8811f6fb6a", + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "This user is part of NetApp Sales Territory", + "editable": "string", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "string", + "ownerOrganizationId": "string", + "partner": "string", + "serviceAccount": { + "audience": "https://netapp-cloud-account.auth0.com/", + "authenticationMethod": "PRIVATE_KEY_JWT", + "expirationNotificationPeriod": "P30D", + "publicKeys": [ + { + "audience": "https://netapp-cloud-account.auth0.com/", + "expirationTimestamp": "2026-06-24T16:25:08Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "X509_CERTIFICATE", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2025-06-24T16:25:08Z", + "modificationTimestamp": "2025-06-24T16:25:08Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey+json", + "version": "1.0" + } + ] + }, + "state": "ACTIVE", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#user_1_0_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-resources.adoc b/tenancyv4/get-resources.adoc new file mode 100644 index 00000000..a556cf08 --- /dev/null +++ b/tenancyv4/get-resources.adoc @@ -0,0 +1,738 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-resources.html' +summary: 'List all resources' +--- + += List all resources + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/resources`# + + + +Lists all resources. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all resources. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-roles-.adoc b/tenancyv4/get-roles-.adoc new file mode 100644 index 00000000..894ac149 --- /dev/null +++ b/tenancyv4/get-roles-.adoc @@ -0,0 +1,729 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-roles-.html' +summary: 'Retrieve a role' +--- + += Retrieve a role + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/roles/{role_id}`# + + + +Retrieves the specified role. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|role_id +|string +|path +|True +a|ID of the role. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 200, Returns the stored role in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|category +|string +|False +a|Specifies the classification of the role. + +* enum: ["IAM", "ONTAP-MEDIATOR", "SNAPCENTER"] +* example: IAM + + +|description +|string +|False +a|JSON string containing the description of the role. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isAgentRole +|string +|False +a|Specifies if the role can be used for a Agent. +Defined values are: + +* "true" + + +|isServiceAccountRole +|string +|False +a|Specifies if the role can be used for a Service Account. +Defined values are: + +* "true" + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|isUserRole +|string +|False +a|Specifies if the role can be used for a User. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the role. +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|roleInternalName +|string +|False +a|JSON string containing a internal name for the role used by UI to validate role name changes. Value will be same as internalName in private field +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|roles +|array[string] +|False +a|Array containing the UUIDs of child roles. Each UUID in the array represents a role that is a child of the aggregate (parent) role. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs). + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.role" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This role have alpha & beta permissions for NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "AstraStorageAdmin", + "roles": [ + "33475e47-e975-48db-936d-73c53d96450b", + "04779339-9192-462c-88ee-8df050ef06c8" + ], + "type": "application/vnd.netapp.bxp.role", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-roles-permissions-.adoc b/tenancyv4/get-roles-permissions-.adoc new file mode 100644 index 00000000..28699f33 --- /dev/null +++ b/tenancyv4/get-roles-permissions-.adoc @@ -0,0 +1,693 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-roles-permissions-.html' +summary: 'Retrieve a permission for a role' +--- + += Retrieve a permission for a role + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/roles/{role_id}/permissions/{permission_id}`# + + + +Retrieves a permission for the specified role. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|permission_id +|string +|path +|True +a|ID of the permission. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|role_id +|string +|path +|True +a|ID of the role. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 200, Returns the stored permission in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the permission. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|rule +|string +|True +a|JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|service_application +|string +|True +a|JSON string containing the serviceApplication associated with this permission. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the permission. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.permission" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added permission which allow user to read in aiq", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "rule": "aiq:system-read", + "serviceApplication": "aiq", + "tags": [ + { + "internal:bxp:roleId": "be845a62-652a-45b9-bb17-6e64ff19fcfc" + } + ], + "type": "application/vnd.netapp.bxp.permission", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-roles-permissions.adoc b/tenancyv4/get-roles-permissions.adoc new file mode 100644 index 00000000..bb6f07cf --- /dev/null +++ b/tenancyv4/get-roles-permissions.adoc @@ -0,0 +1,592 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-roles-permissions.html' +summary: 'List all permissions for a role' +--- + += List all permissions for a role + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/roles/{role_id}/permissions`# + + + +Lists all permissions for the specified role. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|role_id +|string +|path +|True +a|ID of the role. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all permissions. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[Any of: link:#permission_1_0_get_response_body[permission_1.0_get_response_body], array[]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "items": [ + { + "description": "Added permission which allow user to read in aiq", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "rule": "aiq:system-read", + "serviceApplication": "aiq", + "tags": [ + { + "internal:bxp:roleId": "9d84cf09-8036-51e4-b579-bd30cb07b269" + } + ], + "type": "application/vnd.netapp.bxp.permission", + "version": "1.0" + }, + { + "description": "Added permission which allow user to read in aiq", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "rule": "bxp:organization-read", + "serviceApplication": "bxp", + "tags": [ + { + "internal:bxp:roleId": "9d84cf09-8036-51e4-b579-bd30cb07b269" + } + ], + "type": "application/vnd.netapp.bxp.permission", + "version": "1.0" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#permission_1_0_get_response_body] +[.api-collapsible-fifth-title] +permission_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the permission. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|rule +|string +|True +a|JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|service_application +|string +|True +a|JSON string containing the serviceApplication associated with this permission. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the permission. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.permission" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-roles.adoc b/tenancyv4/get-roles.adoc new file mode 100644 index 00000000..b68c1030 --- /dev/null +++ b/tenancyv4/get-roles.adoc @@ -0,0 +1,652 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-roles.html' +summary: 'List all roles' +--- + += List all roles + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/roles`# + + + +Lists all roles. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all roles. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#role_1_0_get_response_body[role_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "category": "IAM", + "description": "This role have alpha & beta permissions for NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isAgentRole": "true", + "isServiceAccountRole": "true", + "isSystem": "true", + "isUserRole": "true", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "StorageAdmin", + "roleInternalName": "ORGANIZATION_ADMIN", + "roles": [ + "33475e47-e975-48db-936d-73c53d96450b", + "04779339-9192-462c-88ee-8df050ef06c8" + ], + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.role", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#role_1_0_get_response_body] +[.api-collapsible-fifth-title] +role_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|category +|string +|False +a|Specifies the classification of the role. + +* enum: ["IAM", "ONTAP-MEDIATOR", "SNAPCENTER"] +* example: IAM + + +|description +|string +|False +a|JSON string containing the description of the role. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isAgentRole +|string +|False +a|Specifies if the role can be used for a Agent. +Defined values are: + +* "true" + + +|isServiceAccountRole +|string +|False +a|Specifies if the role can be used for a Service Account. +Defined values are: + +* "true" + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|isUserRole +|string +|False +a|Specifies if the role can be used for a User. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the role. +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|roleInternalName +|string +|False +a|JSON string containing a internal name for the role used by UI to validate role name changes. Value will be same as internalName in private field +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|roles +|array[string] +|False +a|Array containing the UUIDs of child roles. Each UUID in the array represents a role that is a child of the aggregate (parent) role. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs). + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.role" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-usergroups-.adoc b/tenancyv4/get-usergroups-.adoc new file mode 100644 index 00000000..3835db79 --- /dev/null +++ b/tenancyv4/get-usergroups-.adoc @@ -0,0 +1,691 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-usergroups-.html' +summary: 'Retrieve a user group' +--- + += Retrieve a user group + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/usergroups/{usergroup_id}`# + + + +Retrieves the specified user group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|usergroup_id +|string +|path +|True +a|ID of the user group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 200, Returns the stored user group in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This tag represents NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "AcmeUsers", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.usergroup", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-usergroups-users-.adoc b/tenancyv4/get-usergroups-users-.adoc new file mode 100644 index 00000000..bef161c2 --- /dev/null +++ b/tenancyv4/get-usergroups-users-.adoc @@ -0,0 +1,683 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-usergroups-users-.html' +summary: 'Retrieve a user in a user group' +--- + += Retrieve a user in a user group + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/usergroups/{usergroup_id}/users/{user_id}`# + + + +Retrieves a user in the specified user group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|usergroup_id +|string +|path +|True +a|ID of the user group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 200, Returns the stored user in the JSON response body if it belongs to the user group. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "Adding user to NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isServiceAccount": false, + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "user-1", + "state": "ACTIVE", + "tags": [ + { + "internal:bxp:usergroupId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-usergroups-users.adoc b/tenancyv4/get-usergroups-users.adoc new file mode 100644 index 00000000..7ad3b953 --- /dev/null +++ b/tenancyv4/get-usergroups-users.adoc @@ -0,0 +1,820 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-usergroups-users.html' +summary: 'List all users for a user group' +--- + += List all users for a user group + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/usergroups/{usergroup_id}/users`# + + + +Lists all users for the specified user group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|usergroup_id +|string +|path +|True +a|ID of the user group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all users. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|integer +|False +a| + +|items +|array[link:#user_1_0_get_response_body[user_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "count": 1, + "items": [ + { + "aadId": "8cb0fe27-484b-4226-a19b-9d8811f6fb6a", + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "This user is part of NetApp Sales Territory", + "editable": "string", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "string", + "ownerOrganizationId": "string", + "partner": "string", + "serviceAccount": { + "audience": "https://netapp-cloud-account.auth0.com/", + "authenticationMethod": "PRIVATE_KEY_JWT", + "expirationNotificationPeriod": "P30D", + "publicKeys": [ + { + "audience": "https://netapp-cloud-account.auth0.com/", + "expirationTimestamp": "2026-06-24T16:25:08Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "X509_CERTIFICATE", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2025-06-24T16:25:08Z", + "modificationTimestamp": "2025-06-24T16:25:08Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey+json", + "version": "1.0" + } + ] + }, + "state": "ACTIVE", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#user_1_0_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-usergroups.adoc b/tenancyv4/get-usergroups.adoc new file mode 100644 index 00000000..a4c634f7 --- /dev/null +++ b/tenancyv4/get-usergroups.adoc @@ -0,0 +1,610 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-usergroups.html' +summary: 'List all user groups' +--- + += List all user groups + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/usergroups`# + + + +Lists all user groups in the collection. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all user groups. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#usergroup_1_0_get_response_body[usergroup_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "This usergroup is part of NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "StorageAdmin", + "ownerOrganizationId": "string", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.usergroup", + "usergroupType": "SYSTEM", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#usergroup_1_0_get_response_body] +[.api-collapsible-fifth-title] +usergroup_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-users-.adoc b/tenancyv4/get-users-.adoc new file mode 100644 index 00000000..1cfb21e6 --- /dev/null +++ b/tenancyv4/get-users-.adoc @@ -0,0 +1,895 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-users-.html' +summary: 'Retrieve a user' +--- + += Retrieve a user + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/users/{user_id}`# + + + +Retrieves the specified user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 200, Returns the stored user in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "Adding user to NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isServiceAccount": true, + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "user-1", + "serviceAccount": { + "audience": "https://netapp-cloud-account.auth0.com/", + "authenticationMethod": "PRIVATE_KEY_JWT", + "expirationNotificationPeriod": "P7D", + "publicKeys": { + "items": [ + { + "audience": "https://netapp-cloud-account.auth0.com/", + "credentialId": "cred_fh4agpsm4BphW5QZiYhHR8", + "expirationTimestamp": "2024-10-01T12:00:00Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "RSA_KEY", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662ZZ", + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey+json", + "version": "1.0" + } + ] + } + }, + "state": "ACTIVE", + "tags": [ + { + "internal:bxp:organizationId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-users-partnerorganizations.adoc b/tenancyv4/get-users-partnerorganizations.adoc new file mode 100644 index 00000000..eaffe082 --- /dev/null +++ b/tenancyv4/get-users-partnerorganizations.adoc @@ -0,0 +1,656 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-users-partnerorganizations.html' +summary: 'List all partnership organizations for the specified user' +--- + += List all partnership organizations for the specified user + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/users/{user_id}/partnerOrganizations`# + + + +Lists all partnership organizations for the specified user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of partnership organizations for the specified user. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-users-permissions-resources-.adoc b/tenancyv4/get-users-permissions-resources-.adoc new file mode 100644 index 00000000..1dd71109 --- /dev/null +++ b/tenancyv4/get-users-permissions-resources-.adoc @@ -0,0 +1,764 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-users-permissions-resources-.html' +summary: 'Retrieve a resource for a user with a permission' +--- + += Retrieve a resource for a user with a permission + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/users/{user_id}/permissions/{permission_id}/resources/{resource_id}`# + + + +Retrieves a resource for which a user has given permission + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|user_id +|string +|path +|True +a|ID of the user or aadId or auth0Id. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 or auth0\|66e41be44594c8505b0dba75 + + +|permission_id +|string +|path +|True +a|ID of the permission or permission rule. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 or bxp:binding-read + + +|resource_id +|string +|path +|True +a|ID of the resource or legacyId. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 or account-Adcxyz + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|=== + +== Response + +``` +Status: 200, Returns the stored resource in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "volume-1", + "rawId": "cluster-1-volume-1", + "resourceType": "volume", + "tags": [ + { + "internal:bxp:organizationId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-users-permissions-resources.adoc b/tenancyv4/get-users-permissions-resources.adoc new file mode 100644 index 00000000..990e54a2 --- /dev/null +++ b/tenancyv4/get-users-permissions-resources.adoc @@ -0,0 +1,665 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-users-permissions-resources.html' +summary: 'List all resources for a user with a permission' +--- + += List all resources for a user with a permission + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/users/{user_id}/permissions/{permission_id}/resources`# + + + +Lists all resources for a user with a specified permission. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|permission_id +|string +|path +|True +a|ID of the permission. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of resources the user has the permission on. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-users-permissions.adoc b/tenancyv4/get-users-permissions.adoc new file mode 100644 index 00000000..bdce2de3 --- /dev/null +++ b/tenancyv4/get-users-permissions.adoc @@ -0,0 +1,582 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-users-permissions.html' +summary: 'List all permissions for a user' +--- + += List all permissions for a user + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/users/{user_id}/permissions`# + + + +Lists all permissions for the specified user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all permissions. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[Any of: link:#permission_1_0_get_response_body[permission_1.0_get_response_body], array[]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "items": [ + { + "description": "Added permission which allow user to read in aiq", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "rule": "aiq:system-read", + "serviceApplication": "aiq", + "type": "application/vnd.netapp.bxp.permission", + "version": "1.0" + }, + { + "description": "Added permission which allow user to read in aiq", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "rule": "bxp:organization-read", + "serviceApplication": "bxp", + "type": "application/vnd.netapp.bxp.permission", + "version": "1.0" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#permission_1_0_get_response_body] +[.api-collapsible-fifth-title] +permission_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the permission. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|rule +|string +|True +a|JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|service_application +|string +|True +a|JSON string containing the serviceApplication associated with this permission. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the permission. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.permission" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-users-resources-.adoc b/tenancyv4/get-users-resources-.adoc new file mode 100644 index 00000000..bb89d62e --- /dev/null +++ b/tenancyv4/get-users-resources-.adoc @@ -0,0 +1,755 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-users-resources-.html' +summary: 'Check if a user has permission for a resource' +--- + += Check if a user has permission for a resource + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/users/{user_id}/resources/{resource_id}`# + + + +Checks if a user has permission for a specified resource. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|=== + +== Response + +``` +Status: 200, Returns the stored resource in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "volume-1", + "rawId": "cluster-1-volume-1", + "resourceType": "volume", + "tags": [ + { + "internal:bxp:organizationId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-users-resources-permissions-.adoc b/tenancyv4/get-users-resources-permissions-.adoc new file mode 100644 index 00000000..9c4038d8 --- /dev/null +++ b/tenancyv4/get-users-resources-permissions-.adoc @@ -0,0 +1,697 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-users-resources-permissions-.html' +summary: 'Retrieve a permission on a resource for a user' +--- + += Retrieve a permission on a resource for a user + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/users/{user_id}/resources/{resource_id}/permissions/{permission_id}`# + + + +Retrieves a permission on a resource for the specified user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|permission_id +|string +|path +|True +a|ID of the permission. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Response + +``` +Status: 200, Returns the stored permission in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the permission. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|rule +|string +|True +a|JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|service_application +|string +|True +a|JSON string containing the serviceApplication associated with this permission. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the permission. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.permission" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added permission which allow user to read in aiq", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "rule": "aiq:system-read", + "serviceApplication": "aiq", + "type": "application/vnd.netapp.bxp.permission", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-users-resources-permissions.adoc b/tenancyv4/get-users-resources-permissions.adoc new file mode 100644 index 00000000..98d1b97c --- /dev/null +++ b/tenancyv4/get-users-resources-permissions.adoc @@ -0,0 +1,591 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-users-resources-permissions.html' +summary: 'List all permissions a user has for a resource' +--- + += List all permissions a user has for a resource + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/users/{user_id}/resources/{resource_id}/permissions`# + + + +Lists all permissions a user has for the specified resource. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all permissions. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[Any of: link:#permission_1_0_get_response_body[permission_1.0_get_response_body], array[]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "items": [ + { + "description": "Added permission which allow user to read in aiq", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "rule": "aiq:system-read", + "serviceApplication": "aiq", + "type": "application/vnd.netapp.bxp.permission", + "version": "1.0" + }, + { + "description": "Added permission which allow user to read in aiq", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedby": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "rule": "bxp:organization-read", + "serviceApplication": "bxp", + "type": "application/vnd.netapp.bxp.permission", + "version": "1.0" + } + ] +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#permission_1_0_get_response_body] +[.api-collapsible-fifth-title] +permission_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the permission. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|rule +|string +|True +a|JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|service_application +|string +|True +a|JSON string containing the serviceApplication associated with this permission. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the permission. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.permission" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-users-resources.adoc b/tenancyv4/get-users-resources.adoc new file mode 100644 index 00000000..a520f1c1 --- /dev/null +++ b/tenancyv4/get-users-resources.adoc @@ -0,0 +1,656 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-users-resources.html' +summary: 'List all resources for a user' +--- + += List all resources for a user + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/users/{user_id}/resources`# + + + +Lists all resources for the specified user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of resources accessible to this user. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#resource_1_0_get_response_body[resource_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "description": "Added a new resource of ResourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "clusterA", + "ownerOrganizationId": "string", + "parentId": "string", + "rawId": "string", + "resourceClass": "string", + "resourceType": "string", + "state": "reconciling", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#resource_1_0_get_response_body] +[.api-collapsible-fifth-title] +resource_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-users-roles.adoc b/tenancyv4/get-users-roles.adoc new file mode 100644 index 00000000..12051d99 --- /dev/null +++ b/tenancyv4/get-users-roles.adoc @@ -0,0 +1,652 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-users-roles.html' +summary: 'List all the roles for a user' +--- + += List all the roles for a user + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/users/{user_id}/roles`# + + + +Lists all roles for the specified user. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all roles +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|int +|False +a| + +|items +|array[link:#role_1_0_get_response_body[role_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "items": [ + { + "category": "IAM", + "description": "This role have alpha & beta permissions for NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isAgentRole": "true", + "isServiceAccountRole": "true", + "isSystem": "true", + "isUserRole": "true", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "StorageAdmin", + "roleInternalName": "ORGANIZATION_ADMIN", + "roles": [ + "33475e47-e975-48db-936d-73c53d96450b", + "04779339-9192-462c-88ee-8df050ef06c8" + ], + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.role", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#role_1_0_get_response_body] +[.api-collapsible-fifth-title] +role_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|category +|string +|False +a|Specifies the classification of the role. + +* enum: ["IAM", "ONTAP-MEDIATOR", "SNAPCENTER"] +* example: IAM + + +|description +|string +|False +a|JSON string containing the description of the role. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isAgentRole +|string +|False +a|Specifies if the role can be used for a Agent. +Defined values are: + +* "true" + + +|isServiceAccountRole +|string +|False +a|Specifies if the role can be used for a Service Account. +Defined values are: + +* "true" + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|isUserRole +|string +|False +a|Specifies if the role can be used for a User. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the role. +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|roleInternalName +|string +|False +a|JSON string containing a internal name for the role used by UI to validate role name changes. Value will be same as internalName in private field +Defined values are: + +* Minimum length: 1 +* Maximum length: 63 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|roles +|array[string] +|False +a|Array containing the UUIDs of child roles. Each UUID in the array represents a role that is a child of the aggregate (parent) role. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs). + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.role" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/get-users.adoc b/tenancyv4/get-users.adoc new file mode 100644 index 00000000..62dc2421 --- /dev/null +++ b/tenancyv4/get-users.adoc @@ -0,0 +1,811 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/get-users.html' +summary: 'List all users' +--- + += List all users + +[.api-doc-operation .api-doc-operation-get]#GET# [.api-doc-code-block]#`/users`# + + + +Lists all users in the collection. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|skip +|string +|query +|False +a|Specifies the number of resources to skip when listing a collection. + +URL examples: "skip=1" + +OpenAPI examples: "1" + + +|include +|string +|query +|False +a|Specifies which fields should be returned when listing a collection. + +URL examples: "include=id", "include=id,name" + +OpenAPI examples: "id" + + +|limit +|string +|query +|False +a|Specifies the maximum number of resources to return when listing a collection. + +URL examples: "limit=2" + +OpenAPI examples: "2" + + +|orderBy +|string +|query +|False +a|Indicates the sort order of resources when listing a collection. + +URL examples: "orderBy=name", "orderBy=name%20desc" + +OpenAPI examples: "name desc" + + +|count +|string +|query +|False +a|Indicates if the total number of resources should be returned in the response object. + +URL examples: "count=true" + +OpenAPI examples: "true" + + +|continue +|string +|query +|False +a|Indicates the token to resume from when listing a collection. + +URL examples: "continue=[Continue Token from Collection Metadata]" + +OpenAPI examples: "[Continue Token from Collection Metadata]" + + +|=== + +== Response + +``` +Status: 200, List of all users. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|continue +|string +|False +a| + +|count +|integer +|False +a| + +|items +|array[link:#user_1_0_get_response_body[user_1.0_get_response_body]] +|True +a| + +|metadata +|link:#type_bxp_metadata_list[type_bxp_metadata_list] +|False +a|Metadata associated with a list of resources. + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "continue": "string", + "count": 1, + "items": [ + { + "aadId": "8cb0fe27-484b-4226-a19b-9d8811f6fb6a", + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "This user is part of NetApp Sales Territory", + "editable": "string", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isSystem": "true", + "legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "links": [ + { + "hints": { + "allow": [ + "string" + ], + "permissions": [ + "string" + ], + "status": "string" + }, + "href": "string", + "rel": "string", + "title": "string", + "type": "string" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + }, + "name": "string", + "ownerOrganizationId": "string", + "partner": "string", + "serviceAccount": { + "audience": "https://netapp-cloud-account.auth0.com/", + "authenticationMethod": "PRIVATE_KEY_JWT", + "expirationNotificationPeriod": "P30D", + "publicKeys": [ + { + "audience": "https://netapp-cloud-account.auth0.com/", + "expirationTimestamp": "2026-06-24T16:25:08Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "X509_CERTIFICATE", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2025-06-24T16:25:08Z", + "modificationTimestamp": "2025-06-24T16:25:08Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey+json", + "version": "1.0" + } + ] + }, + "state": "ACTIVE", + "tags": [ + "object" + ], + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" + } + ], + "metadata": { + "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [ + { + "name": "string", + "value": "string" + } + ], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32" + } +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#user_1_0_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|editable +|string +|False +a|partner organization is editable or not. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|partner +|string +|False +a|partner organization name. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#type_bxp_metadata_list] +[.api-collapsible-fifth-title] +type_bxp_metadata_list + +Metadata associated with a list of resources. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|count +|number +|False +a| + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/hierarchy_overview.adoc b/tenancyv4/hierarchy_overview.adoc new file mode 100644 index 00000000..2e360802 --- /dev/null +++ b/tenancyv4/hierarchy_overview.adoc @@ -0,0 +1,22 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/hierarchy_overview.html' +summary: 'Hierarchy endpoints in the identity and access management REST API for the NetApp Console' +--- + += Hierarchy endpoints in the identity and access management REST API for the NetApp Console + + + +The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. + +A Hierarchy is composed of multiple elements: + +* The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp. +* Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on. +* Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources. +* Resources are associated with one or more folders or projects. + + diff --git a/tenancyv4/overview.adoc b/tenancyv4/overview.adoc new file mode 100644 index 00000000..e1bbaf2a --- /dev/null +++ b/tenancyv4/overview.adoc @@ -0,0 +1,128 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/overview.html' +summary: 'Identity and access management REST API' +--- + += Identity and access management REST API + + + +The NetApp Console identity and access management (IAM) service provides a centralized point for managing customer and partner information. +IAM endpoints enable you to manage and control access to the Console resources. + +If you're using the Console in standard mode, you no longer have a NetApp Console account. Instead, you have an organization in the Console that you manage using IAM. + +The following six components are defined within the IAM service. + +* hierarchy +* permission +* partnership +* resource and resourcegroup +* role +* user and usergroup + +IAM uses predefined roles that include sets of permissions which are required to manage and view data. You can have multiple roles within the same organization or set of resources. +You should verify that you have the appropriate permissions when using IAM API endpoints. With the appropriate permissions, you can manage an organization hierarchy modeled as folders (subdivisions of an organization using criteria such as department or region) and projects (a workspace in the Console). After organizing your resources into folders and projects, you can grant granular access to resources by providing organization members with permissions to specific folders and projects. + +The actions available through the IAM REST API are a superset of what's available through the web UI. + +**Note**: Before using the API reference documentation, review the https://docs.netapp.com/us-en/cloud-manager-automation/platform/overview.html[Get started] section for the Console APIs. For more information about the security tokens and identifiers you'll need when using the API, review the https://docs.netapp.com/us-en/cloud-manager-automation/platform/get_identifiers.html[Common workflows and tasks] section. + +''' + +== REST implementation + +=== HTTP methods + +|=== +| Method | Description + +| `POST` +| Create an object instance + +| `GET` +| Retrieve an object instance or collection + +| `PATCH` +| Update specific fields of an existing resource instance based on the supplied input values + +| `PUT` +| Update an existing resource instance based on the supplied input values + +| `DELETE` +| Remove an existing object +|=== + +=== Request headers + +|=== +| Request Header | Description + +| `Authorization` +| Required. Contains a JWT access token +|=== + +=== Query parameters + +You can use query parameters with endpoints in the following components: + +|=== +| Component | Query Parameter + +| Hierarchy +| filter, skip, include, orderBy, limit, count, continue, metadata, links + +| Permission +| filter, skip, include, orderBy, limit, count, continue, metadata, links + +| Resource and resourcegroup +| filter, skip, include, orderBy, limit, count, continue, metadata, links + +| Role +| filter, skip, include, orderBy, limit, count, continue, metadata, links + +| User and usergroup +| filter, skip, include, orderBy, limit, count, continue, metadata, links +|=== + +=== Response headers + +This API uses the standard HTTP response headers common with all APIs in the Console. See https://docs.netapp.com/us-en/cloud-manager-automation/platform/http_details.html[REST implementation] for more information. + +=== HTTP status codes + +|=== +| HTTP Status Code | Description + +| `200` +| OK: Returned for successful operation completion + +| `201` +| The resource was successfully created. + +| `204` +| The operation was completed successfully and the server did not send a response message. + +| `400` +| Bad Request: Returned if the input is malformed and could not be parsed + +| `401` +| Unauthorized: Returned if user authentication failed or the token has expired + +| `403` +| Forbidden: Returned for authorization errors depending on the resource and token +|=== + +''' + +== Error handling + +The following processes are involved with error handling and processing. + +* The error is logged for supportability +* The error is also returned to the caller for any specific handling + + diff --git a/tenancyv4/partnership_overview.adoc b/tenancyv4/partnership_overview.adoc new file mode 100644 index 00000000..7a816d94 --- /dev/null +++ b/tenancyv4/partnership_overview.adoc @@ -0,0 +1,25 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/partnership_overview.html' +summary: 'Partnership endpoints in the identity and access management REST API for the NetApp Console' +--- + += Partnership endpoints in the identity and access management REST API for the NetApp Console + + + +The partnership endpoints enable collaboration between two organizations in the NetApp Console. + +A partnership represents an organization sharing resources (the source organization) with users of a different organization (the destination organization). Partnership allows the source organization to grant permissions to users from the destination organization, enabling them to manage one or more organization's resources. Grants define the access (set of permissions) that a user from the destination organization has on a resource from the source organization. + +A partnership has multiple grants. A grant is defined by: + +* A list of users from the destination organization +* A list of resources from the source organization +* A role applicable between these two groups which is referenced in the partnershipType. + +The partnership type defines the possible roles that can be applied between users and resources. The current supported partnership types are Self-Service. + + diff --git a/tenancyv4/patch-folders-.adoc b/tenancyv4/patch-folders-.adoc new file mode 100644 index 00000000..fd0f8d68 --- /dev/null +++ b/tenancyv4/patch-folders-.adoc @@ -0,0 +1,632 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-folders-.html' +summary: 'Update a folder partially' +--- + += Update a folder partially + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/folders/{folder_id}`# + + + +Updates the specified folder with partial information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|False +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|False +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "netapp-sales", + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the folder was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/patch-folders-projects-.adoc b/tenancyv4/patch-folders-projects-.adoc new file mode 100644 index 00000000..c8161a14 --- /dev/null +++ b/tenancyv4/patch-folders-projects-.adoc @@ -0,0 +1,658 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-folders-projects-.html' +summary: 'Update a project under a folder partially' +--- + += Update a project under a folder partially + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/folders/{folder_id}/projects/{project_id}`# + + + +Updates a project under the specified folder with partial information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|filter +|string +|query +|False +a|Specifies which fields should be matched in order to return a resource when listing a collection. + +Supported operators: + +* eq - Equality +* lt/gt - Less than/greater than +* lte/gte - Less than or equal to/greater than or equal to + +URL example: "filter=field%20eq%20%27value%27" + +OpenAPI examples: "field eq 'value'" + + +|=== + +== Request Body + +Replaces the specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|False +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|False +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "netapp-project-1", + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the project was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/patch-organizations-.adoc b/tenancyv4/patch-organizations-.adoc new file mode 100644 index 00000000..1724742b --- /dev/null +++ b/tenancyv4/patch-organizations-.adoc @@ -0,0 +1,435 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-organizations-.html' +summary: 'Update an organization partially' +--- + += Update an organization partially + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/organizations/{organization_id}`# + + + +Updates the specified organization with partial information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +With content-type "application/vnd.netapp.bxp.resource+json", replaces the specified attributes in the request body with the values provided. +With content-type "application/vnd.netapp.bxp.organization+json", allow changing specific settings for this organization. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|safeMode +|string +|True +a|Used to patch an organization to safeMode. Specify as true or false to set organization to safeMode or not. + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "safeMode": true +} +==== + +== Response + +``` +Status: 204, Indicates if the organization was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/patch-organizations-folders-.adoc b/tenancyv4/patch-organizations-folders-.adoc new file mode 100644 index 00000000..9ba13942 --- /dev/null +++ b/tenancyv4/patch-organizations-folders-.adoc @@ -0,0 +1,641 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-organizations-folders-.html' +summary: 'Update a folder under an organization partially' +--- + += Update a folder under an organization partially + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/organizations/{organization_id}/folders/{folder_id}`# + + + +Updates a folder under the specified organization with partial information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|False +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|False +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "netapp-sales", + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the folder was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/patch-organizations-projects-.adoc b/tenancyv4/patch-organizations-projects-.adoc new file mode 100644 index 00000000..8dc913aa --- /dev/null +++ b/tenancyv4/patch-organizations-projects-.adoc @@ -0,0 +1,641 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-organizations-projects-.html' +summary: 'Update a project under an organization partially' +--- + += Update a project under an organization partially + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/organizations/{organization_id}/projects/{project_id}`# + + + +Updates a project under the specified organization with partial information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|False +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|False +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "netapp-project-1", + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the project was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/patch-organizations-serviceaccounts-.adoc b/tenancyv4/patch-organizations-serviceaccounts-.adoc new file mode 100644 index 00000000..8da2376e --- /dev/null +++ b/tenancyv4/patch-organizations-serviceaccounts-.adoc @@ -0,0 +1,662 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-organizations-serviceaccounts-.html' +summary: 'Update a service account partially' +--- + += Update a service account partially + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/organizations/{organization_id}/serviceAccounts/{serviceaccount_id}`# + + + +Updates a service account under an organization with partial information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|serviceaccount_id +|string +|path +|True +a|ID of the service account. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Request Body + +Replaces the specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID + + +|auth0Id +|string +|False +a|User auth0 ID + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|password +|string +|False +a|User password in plain text. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod property is only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|stateDesired +|string +|False +a|Expected state of the user. +Defined values are: + +_**_ "CREATE" + +_**_ "UPDATE" + +_**_ "LOGIN_USER" + +_**_ "REFRESH_USER" + +_**_ "LOGOUT_USER" + +_**_ "AIDP_LOGIN" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "service-account-1", + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the service account was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod property is only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/patch-organizations-serviceaccounts-publickeys-.adoc b/tenancyv4/patch-organizations-serviceaccounts-publickeys-.adoc new file mode 100644 index 00000000..65ab64f9 --- /dev/null +++ b/tenancyv4/patch-organizations-serviceaccounts-publickeys-.adoc @@ -0,0 +1,121 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-organizations-serviceaccounts-publickeys-.html' +summary: 'Partially update a public key for a service account' +--- + += Partially update a public key for a service account + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys/{publickey_id}`# + + + +Updates a public key for the specified service account with partial information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|serviceaccount_id +|string +|path +|True +a|ID of the service account. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|publickey_id +|string +|path +|True +a|ID of the public key. + +* example: 778f8579-a5b1-48ab-91c5-361acc2ee7fe + + +|=== + +== Request Body + +Replaces the specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. This is only applicable when the public key is an RSA key. + + +|stateDesired +|string +|False +a|Expected state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "stateDesired": "DISABLED", + "type": "application/vnd.netapp.bxp.publickey", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the public key was updated. +``` + diff --git a/tenancyv4/patch-organizations-users-.adoc b/tenancyv4/patch-organizations-users-.adoc new file mode 100644 index 00000000..42223b66 --- /dev/null +++ b/tenancyv4/patch-organizations-users-.adoc @@ -0,0 +1,382 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-organizations-users-.html' +summary: 'Modify a user' +--- + += Modify a user + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/organizations/{organization_id}/users/{user_id}`# + + + +Allow role(s) elevation or downscope for the specified user/organization + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Request Body + +Replaces the specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|elevatedStateDesired +|string +|True +a|Indicate when a user wants to elevate or downscope his role(s) +Defined values are: + +* ELEVATED +* DOWNSCOPED + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "elevatedStateDesired": "ELEVATED" +} +==== + +== Response + +``` +Status: 204, Indicates if the user was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/patch-partnerships-.adoc b/tenancyv4/patch-partnerships-.adoc new file mode 100644 index 00000000..f23dce0a --- /dev/null +++ b/tenancyv4/patch-partnerships-.adoc @@ -0,0 +1,468 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-partnerships-.html' +summary: 'Update a partnership partially' +--- + += Update a partnership partially + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/partnerships/{partnership_id}`# + + + +Updates the specified partnership with partial information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. A partnership includes a type, a source organization, and a destination organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|stateDesired +|string +|True +a|The state to which you want to move the resource. +Defined values are: + +*** Minimum length: 1 + +*** Maximum length: 254 + +Possible values are: + +*** APPROVED + +*** REJECTED + +*** HOLD + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.partnership" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "stateDesired": "APPROVED", + "type": "application/vnd.netapp.bxp.partnership", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the partnershipType resource was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/patch-projects-.adoc b/tenancyv4/patch-projects-.adoc new file mode 100644 index 00000000..a92eb3dc --- /dev/null +++ b/tenancyv4/patch-projects-.adoc @@ -0,0 +1,632 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-projects-.html' +summary: 'Update a project partially' +--- + += Update a project partially + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/projects/{project_id}`# + + + +Updates the specified project with partial information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|False +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|False +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "netapp-project-1", + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the project was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/patch-resourcegroups-.adoc b/tenancyv4/patch-resourcegroups-.adoc new file mode 100644 index 00000000..be3ccf2f --- /dev/null +++ b/tenancyv4/patch-resourcegroups-.adoc @@ -0,0 +1,584 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-resourcegroups-.html' +summary: 'Update a resource group' +--- + += Update a resource group + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/resourcegroups/{resourcegroup_id}`# + + + +Updates a resource group with partial information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resourcegroup_id +|string +|path +|True +a|ID of the resource group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the resource specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of this resource group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|JSON string containing a name for the resource group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this resource group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcegroup" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "AcmeSystemsEurope", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.resourcegroup", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the resource group was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/patch-resources-.adoc b/tenancyv4/patch-resources-.adoc new file mode 100644 index 00000000..ed619369 --- /dev/null +++ b/tenancyv4/patch-resources-.adoc @@ -0,0 +1,635 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-resources-.html' +summary: 'Update a resource' +--- + += Update a resource + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/resources/{resource_id}`# + + + +Updates the specified resource with partial information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|False +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|False +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "volume-1", + "rawId": "cluster-1-volume-1", + "resourceType": "volume", + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the resource was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/patch-usergroups-.adoc b/tenancyv4/patch-usergroups-.adoc new file mode 100644 index 00000000..817b7c11 --- /dev/null +++ b/tenancyv4/patch-usergroups-.adoc @@ -0,0 +1,597 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-usergroups-.html' +summary: 'Update a user group partially' +--- + += Update a user group partially + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/usergroups/{usergroup_id}`# + + + +Updates the specified user group with partial information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|usergroup_id +|string +|path +|True +a|ID of the user group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the resource specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This tag represents NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "AcmeSystemsEurope", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.usergroup", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the user group was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/patch-users-.adoc b/tenancyv4/patch-users-.adoc new file mode 100644 index 00000000..5ece373d --- /dev/null +++ b/tenancyv4/patch-users-.adoc @@ -0,0 +1,661 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/patch-users-.html' +summary: 'Update a user partially' +--- + += Update a user partially + +[.api-doc-operation .api-doc-operation-patch]#PATCH# [.api-doc-code-block]#`/users/{user_id}`# + + + +Updates the specified user with partial information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the specified attributes in the request body with the values provided. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID + + +|auth0Id +|string +|False +a|User auth0 ID + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|password +|string +|False +a|User password in plain text. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod property is only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|stateDesired +|string +|False +a|Expected state of the user. +Defined values are: + +_**_ "CREATE" + +_**_ "UPDATE" + +_**_ "LOGIN_USER" + +_**_ "REFRESH_USER" + +_**_ "LOGOUT_USER" + +_**_ "AIDP_LOGIN" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Adding user to NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "user-1", + "password": "********", + "stateDesired": "UPDATE", + "tags": [ + { + "internal:bxp:organizationId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the user was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod property is only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/permission_overview.adoc b/tenancyv4/permission_overview.adoc new file mode 100644 index 00000000..dc2ce5fc --- /dev/null +++ b/tenancyv4/permission_overview.adoc @@ -0,0 +1,17 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/permission_overview.html' +summary: 'Permission endpoints in the identity and access management REST API for the NetApp Console' +--- + += Permission endpoints in the identity and access management REST API for the NetApp Console + + + +The permission endpoints provide access to an internal collection of available permissions in NetApp Console identity and access management (IAM). Permissions are defined as a low-level string of characters that a user or service account can use to determine authorization. + +A user can have permissions for the resources in the entire organization or in specific folders and projects. Permissions prevent or allow a user to perform specific actions at a specific level of the resource hierarchy. + + diff --git a/tenancyv4/post-folders-folders.adoc b/tenancyv4/post-folders-folders.adoc new file mode 100644 index 00000000..cde8b300 --- /dev/null +++ b/tenancyv4/post-folders-folders.adoc @@ -0,0 +1,898 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-folders-folders.html' +summary: 'Create a child folder under a parent folder' +--- + += Create a child folder under a parent folder + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/folders/{folder_id}/folders`# + + + +Creates a new folder under the specified parent folder. + + +== Request Body + +Indicates the desired values for the folder to be created under a parent folder. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "netapp-sales", + "ownerOrganizationId": "bc806791-5fbb-4c08-9111-90722412c6e3", + "parentId": "777a3f38-d4fa-5b62-a391-a69029758d32", + "resourceClass": "hierarchy", + "resourceType": "folder", + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created folder in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp-sales", + "resourceType": "folder", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-folders-projects.adoc b/tenancyv4/post-folders-projects.adoc new file mode 100644 index 00000000..2119a7a6 --- /dev/null +++ b/tenancyv4/post-folders-projects.adoc @@ -0,0 +1,924 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-folders-projects.html' +summary: 'Create a new project under a folder' +--- + += Create a new project under a folder + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/folders/{folder_id}/projects`# + + + +Creates a project under the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the desired values for the project to be created under a folder. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "netapp-project-1", + "resourceType": "project", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created project in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp-project-1", + "resourceType": "project", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-folders-resources.adoc b/tenancyv4/post-folders-resources.adoc new file mode 100644 index 00000000..9639c07e --- /dev/null +++ b/tenancyv4/post-folders-resources.adoc @@ -0,0 +1,457 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-folders-resources.html' +summary: 'Add resources to a folder' +--- + += Add resources to a folder + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/folders/{folder_id}/resources`# + + + +Adds resources to the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|The ID of the folder that contains the resources. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the resources to add to the folder. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resources +|array[string] +|True +a|JSON array of resource UUIDs. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcebulk" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "resources": [ + "a94ac68f-ea20-47aa-add8-8d41be0d8466", + "b04ac68f-da27-578a-cee8-9e45bq0d8466" + ], + "type": "application/vnd.netapp.bxp.resourcebulk", + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the resources request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-folders-roles-usergroups.adoc b/tenancyv4/post-folders-roles-usergroups.adoc new file mode 100644 index 00000000..bdad4f9a --- /dev/null +++ b/tenancyv4/post-folders-roles-usergroups.adoc @@ -0,0 +1,848 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-folders-roles-usergroups.html' +summary: 'Create a new user group in a folder' +--- + += Create a new user group in a folder + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/folders/{folder_id}/roles/{role_id}/usergroups`# + + + +Creates a new user group. + + +== Request Body + +Indicates the desired values for the user group to be created. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This tag represents NetApp Sales Territory", + "name": "fed-pepsico-com-samlp_admin", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.usergroup", + "usergroupType": "USERGROUP", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created user group in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This tag represents NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "fed-pepsico-com-samlp_admin", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.usergroup", + "usergroupType": "USERGROUP", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-folders-users.adoc b/tenancyv4/post-folders-users.adoc new file mode 100644 index 00000000..ec57fbbc --- /dev/null +++ b/tenancyv4/post-folders-users.adoc @@ -0,0 +1,457 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-folders-users.html' +summary: 'Add users to a folder' +--- + += Add users to a folder + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/folders/{folder_id}/users`# + + + +Adds users to the specified folder. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|Folder ID used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the users to be added. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.userbulk" + + +|users +|array[string] +|False +a|JSON array of user UUIDs. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "type": "application/vnd.netapp.bxp.userbulk", + "users": [ + "a94ac68f-ea20-47aa-add8-8d41be0d8466", + "b04ac68f-da27-578a-cee8-9e45bq0d8466" + ], + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the users request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-folders.adoc b/tenancyv4/post-folders.adoc new file mode 100644 index 00000000..23329d74 --- /dev/null +++ b/tenancyv4/post-folders.adoc @@ -0,0 +1,898 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-folders.html' +summary: 'Create a new folder' +--- + += Create a new folder + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/folders`# + + + +Creates a new folder. + + +== Request Body + +Indicates the desired values for the folder that is to be created. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "netapp-sales", + "ownerOrganizationId": "bc806791-5fbb-4c08-9111-90722412c6e3", + "parentId": "777a3f38-d4fa-5b62-a391-a69029758d32", + "resourceClass": "hierarchy", + "resourceType": "folder", + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the new folder in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp-sales", + "resourceType": "folder", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-organizations-folders.adoc b/tenancyv4/post-organizations-folders.adoc new file mode 100644 index 00000000..36b49f34 --- /dev/null +++ b/tenancyv4/post-organizations-folders.adoc @@ -0,0 +1,898 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-organizations-folders.html' +summary: 'Create a new folder under an organization' +--- + += Create a new folder under an organization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/organizations/{organization_id}/folders`# + + + +Creates a new folder under the specified organization. + + +== Request Body + +Indicates the desired values for the folder to be created under an organization. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "netapp-sales", + "ownerOrganizationId": "bc806791-5fbb-4c08-9111-90722412c6e3", + "parentId": "777a3f38-d4fa-5b62-a391-a69029758d32", + "resourceClass": "hierarchy", + "resourceType": "folder", + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created folder in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp-sales", + "resourceType": "folder", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-organizations-projects.adoc b/tenancyv4/post-organizations-projects.adoc new file mode 100644 index 00000000..e0f880cf --- /dev/null +++ b/tenancyv4/post-organizations-projects.adoc @@ -0,0 +1,924 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-organizations-projects.html' +summary: 'Create a new project under an organization' +--- + += Create a new project under an organization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/organizations/{organization_id}/projects`# + + + +Creates a new project under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the desired values for the project to be created under an organization. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "netapp-project-1", + "resourceType": "project", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created project in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp-project-1", + "resourceType": "project", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-organizations-resourcegroups.adoc b/tenancyv4/post-organizations-resourcegroups.adoc new file mode 100644 index 00000000..8d950792 --- /dev/null +++ b/tenancyv4/post-organizations-resourcegroups.adoc @@ -0,0 +1,495 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-organizations-resourcegroups.html' +summary: 'Add resource groups to an organization' +--- + += Add resource groups to an organization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/organizations/{organization_id}/resourcegroups`# + + + +Adds resource groups to the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the resource groups to be added. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resourcegroups +|array[link:#resourcegroups[resourcegroups]] +|True +a| + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcegroupbulk" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "resourcegroups": [ + { + "id": "a94ac68f-ea20-47aa-add8-8d41be0d8466", + "name": "StorageAdmin" + }, + { + "name": "StorageAdmin" + } + ], + "type": "application/vnd.netapp.bxp.resourcegroupbulk", + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates that the resourcegroup request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#resourcegroups] +[.api-collapsible-fifth-title] +resourcegroups + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|name +|string +|False +a|JSON string containing a name for the resource group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-organizations-resources.adoc b/tenancyv4/post-organizations-resources.adoc new file mode 100644 index 00000000..518e4da8 --- /dev/null +++ b/tenancyv4/post-organizations-resources.adoc @@ -0,0 +1,457 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-organizations-resources.html' +summary: 'Add resources to an organization' +--- + += Add resources to an organization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/organizations/{organization_id}/resources`# + + + +Adds resources to the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|Organization ID used to display resources. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the resources to add to the folder. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resources +|array[string] +|True +a|JSON array of resource UUIDs. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcebulk" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "resources": [ + "a94ac68f-ea20-47aa-add8-8d41be0d8466", + "b04ac68f-da27-578a-cee8-9e45bq0d8466" + ], + "type": "application/vnd.netapp.bxp.resourcebulk", + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the resources request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-organizations-roles-usergroups.adoc b/tenancyv4/post-organizations-roles-usergroups.adoc new file mode 100644 index 00000000..3107388b --- /dev/null +++ b/tenancyv4/post-organizations-roles-usergroups.adoc @@ -0,0 +1,848 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-organizations-roles-usergroups.html' +summary: 'Create a new user group in an organization' +--- + += Create a new user group in an organization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/organizations/{organization_id}/roles/{role_id}/usergroups`# + + + +Creates a new user group. + + +== Request Body + +Indicates the desired values for the user group to be created. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This tag represents NetApp Sales Territory", + "name": "fed-pepsico-com-samlp_admin", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.usergroup", + "usergroupType": "USERGROUP", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created user group in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This tag represents NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "fed-pepsico-com-samlp_admin", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.usergroup", + "usergroupType": "USERGROUP", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-organizations-roles-users.adoc b/tenancyv4/post-organizations-roles-users.adoc new file mode 100644 index 00000000..184356bf --- /dev/null +++ b/tenancyv4/post-organizations-roles-users.adoc @@ -0,0 +1,500 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-organizations-roles-users.html' +summary: 'Associate users in an organization with a role' +--- + += Associate users in an organization with a role + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/organizations/{organization_id}/roles/{role_id}/users`# + + + +Associates users with a role under the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a| + +|role_id +|string +|path +|True +a| + +|=== + +== Request Body + +Indicates the desired values to associate multiple users with a specific role under an organization. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.userbulk" + + +|users +|array[link:#users[users]] +|False +a|JSON array of users. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "type": "application/vnd.netapp.bxp.userbulk", + "users": [ + { + "aadId": "a94ac68f-ea20-47aa-add8-8d41be0d8466", + "userId": "e837c373-2ec4-47a8-b016-ba430ebce321" + }, + { + "auth0Id": "auth0|5a09551d0d9ef535b823bd3f", + "userId": "f837c373-2ec4-47a8-b016-ba430ebce321" + } + ], + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the users request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#users] +[.api-collapsible-fifth-title] +users + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a| + +|auth0Id +|string +|False +a| + +|emailId +|string +|False +a| + +|userId +|string +|False +a| + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-organizations-serviceaccounts-clientsecret.adoc b/tenancyv4/post-organizations-serviceaccounts-clientsecret.adoc new file mode 100644 index 00000000..ed51a592 --- /dev/null +++ b/tenancyv4/post-organizations-serviceaccounts-clientsecret.adoc @@ -0,0 +1,931 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-organizations-serviceaccounts-clientsecret.html' +summary: 'Create a new client secret for a service account' +--- + += Create a new client secret for a service account + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/organizations/{organization_id}/serviceAccounts/{serviceaccount_id}/clientSecret`# + + + +Creates a new client secret for the specified service account. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|serviceaccount_id +|string +|path +|True +a|ID of the service account. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Response + +``` +Status: 200, Indicates if the service account was updated. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0ClientSecret +|string +|False +a|Auth0 Client Secret. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0ClientSecret'": "5z3av5A-fk3JXStnPIn_3klyPrVlDXP0r5aYyuE7Ex_m_hcaN4WxGP1mr_ocq6wL", + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "service-account-1", + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-organizations-serviceaccounts-publickeys.adoc b/tenancyv4/post-organizations-serviceaccounts-publickeys.adoc new file mode 100644 index 00000000..fb83eecc --- /dev/null +++ b/tenancyv4/post-organizations-serviceaccounts-publickeys.adoc @@ -0,0 +1,646 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-organizations-serviceaccounts-publickeys.html' +summary: 'Create a public key for a service account' +--- + += Create a public key for a service account + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys`# + + + +Creates a public key for the specified service account. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|serviceaccount_id +|string +|path +|True +a|ID of the service account. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Request Body + +Indicates the desired values for the public key to be created. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. This is only applicable when an RSA key is provided for the public key. When a certificate is provided, the value is set to the certificate's expiration timestamp. + + +|publicKey +|string +|True +a|Public X.509 certificate or RSA key in PEM format converted to a string with escaped new line characters (`\n`). + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "expirationTimestamp": "2026-06-24T16:25:08Z", + "publicKey": "-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0B...\\n-----END PUBLIC KEY-----\\n", + "type": "application/vnd.netapp.bxp.publickey", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns information about the newly created public key in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|True +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|expirationTimestamp +|string +|True +a|The date and time when the public key expires. + + +|fingerprint +|string +|True +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|True +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|state +|string +|True +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "audience": "https://netapp-cloud-account.auth0.com/", + "expirationTimestamp": "2026-06-24T16:25:08Z", + "fingerprint": "33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8", + "id": "4336388b-2992-43af-81de-ba9284b7dc36", + "keyType": "RSA_KEY", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2025-06-24T16:25:08Z", + "modificationTimestamp": "2025-06-24T16:25:08Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "state": "ENABLED", + "type": "application/vnd.netapp.bxp.publickey+json", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-organizations-serviceaccounts.adoc b/tenancyv4/post-organizations-serviceaccounts.adoc new file mode 100644 index 00000000..e44228bf --- /dev/null +++ b/tenancyv4/post-organizations-serviceaccounts.adoc @@ -0,0 +1,1100 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-organizations-serviceaccounts.html' +summary: 'Create a new service account' +--- + += Create a new service account + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/organizations/{organization_id}/serviceAccounts`# + + + +Creates a service account under an organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the desired values for the service account to be created. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|email +|string +|False +a|User email address. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|password +|string +|False +a|User password in plain text. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod, expirationTimestamp, and publicKey properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|stateDesired +|string +|False +a|Expected state of the user. +Defined values are: + +_**_ "CREATE" + +_**_ "UPDATE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "service-account-1", + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created service account in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0ClientSecret +|string +|False +a|Auth0 Client Secret. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0ClientSecret": "Ka6heC13VEq5oWSw5s1Ms_iY2vd8EzIfYKPN8mqtJaLLkyuMDLhOCy0SO3x8onr2", + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "service-account-1", + "type": "application/vnd.netapp.bxp.user+json", + "userType": "serviceAccount", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod, expirationTimestamp, and publicKey properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|authenticationMethod +|string +|True +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. This is only applicable when an RSA key is provided for the public key. When a certificate is provided, the value is set to the certificate's expiration timestamp. + + +|publicKey +|string +|False +a|Public X.509 certificate or RSA key in PEM format converted to a string with escaped new line characters (`\n`). + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-organizations-usergroups.adoc b/tenancyv4/post-organizations-usergroups.adoc new file mode 100644 index 00000000..bbafaecb --- /dev/null +++ b/tenancyv4/post-organizations-usergroups.adoc @@ -0,0 +1,494 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-organizations-usergroups.html' +summary: 'Add user groups to an organization' +--- + += Add user groups to an organization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/organizations/{organization_id}/usergroups`# + + + +Adds user groups to the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the user groups to be added. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroupbulk" + + +|usergroups +|array[link:#usergroups[usergroups]] +|True +a| + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "type": "application/vnd.netapp.bxp.usergroupbulk", + "usergroups": [ + { + "id": "a94ac68f-ea20-47aa-add8-8d41be0d8466" + }, + { + "name": "StorageAdmin" + } + ], + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the usergroups request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#usergroups] +[.api-collapsible-fifth-title] +usergroups + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|name +|string +|False +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-organizations-users.adoc b/tenancyv4/post-organizations-users.adoc new file mode 100644 index 00000000..439691ed --- /dev/null +++ b/tenancyv4/post-organizations-users.adoc @@ -0,0 +1,457 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-organizations-users.html' +summary: 'Add users to an organization' +--- + += Add users to an organization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/organizations/{organization_id}/users`# + + + +Adds users to the specified organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|Organization ID used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the users to be added. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.userbulk" + + +|users +|array[string] +|False +a|JSON array of user UUIDs. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "type": "application/vnd.netapp.bxp.userbulk", + "users": [ + "a94ac68f-ea20-47aa-add8-8d41be0d8466", + "b04ac68f-da27-578a-cee8-9e45bq0d8466" + ], + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the users request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-organizations.adoc b/tenancyv4/post-organizations.adoc new file mode 100644 index 00000000..86dfdc53 --- /dev/null +++ b/tenancyv4/post-organizations.adoc @@ -0,0 +1,912 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-organizations.html' +summary: 'Create a new organization' +--- + += Create a new organization + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/organizations`# + + + +Creates a new organization. + + +== Request Body + +Indicates the desired values for the organization to be created. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "netapp", + "resourceType": "organization", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:crmId": "a1a6ddeb-2a15-4907-a801-9b9c3f40a7b7" + }, + { + "internal:bxp:cmatId": "2e007562-f061-4b18-b9bd-16ef3bde524b" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created organization in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp", + "resourceType": "organization", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:crmId": "a1a6ddeb-2a15-4907-a801-9b9c3f40a7b7" + }, + { + "internal:bxp:cmatId": "2e007562-f061-4b18-b9bd-16ef3bde524b" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-partnerships-grants-resources.adoc b/tenancyv4/post-partnerships-grants-resources.adoc new file mode 100644 index 00000000..51453673 --- /dev/null +++ b/tenancyv4/post-partnerships-grants-resources.adoc @@ -0,0 +1,466 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-partnerships-grants-resources.html' +summary: 'Add resources to a grant in a partnership' +--- + += Add resources to a grant in a partnership + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/partnerships/{partnership_id}/grants/{grant_id}/resources`# + + + +Adds resources to the specified grant of a partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|grant_id +|string +|path +|True +a|ID of the grant used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the resources to add to the specified grant of a specific partnership. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resources +|array[string] +|True +a|JSON array of resource UUIDs. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcebulk" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "resources": [ + "a94ac68f-ea20-47aa-add8-8d41be0d8466", + "b04ac68f-da27-578a-cee8-9e45bq0d8466" + ], + "type": "application/vnd.netapp.bxp.resourcebulk", + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the resources request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-partnerships-grants-users.adoc b/tenancyv4/post-partnerships-grants-users.adoc new file mode 100644 index 00000000..fa254c78 --- /dev/null +++ b/tenancyv4/post-partnerships-grants-users.adoc @@ -0,0 +1,508 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-partnerships-grants-users.html' +summary: 'Add users to a grant in a partnership' +--- + += Add users to a grant in a partnership + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/partnerships/{partnership_id}/grants/{grant_id}/users`# + + + +Adds users to the specified grant in a partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|grant_id +|string +|path +|True +a|ID of the grant used to display users. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Request Body + +Indicates the users to be added. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.userbulk" + + +|users +|array[link:#users[users]] +|False +a|JSON array of users. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Adding users to the ClusterManagement grant of Wipro partnership", + "type": "application/vnd.netapp.bxp.userbulk", + "users": [ + { + "aadId": "a94ac68f-ea20-47aa-add8-8d41be0d8466" + }, + { + "userId": "f837c373-2ec4-47a8-b016-ba430ebce321" + }, + { + "emailId": "test@netapp.com" + } + ], + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the users request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#users] +[.api-collapsible-fifth-title] +users + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a| + +|auth0Id +|string +|False +a| + +|emailId +|string +|False +a| + +|userId +|string +|False +a| + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-partnerships-grants.adoc b/tenancyv4/post-partnerships-grants.adoc new file mode 100644 index 00000000..181ede1f --- /dev/null +++ b/tenancyv4/post-partnerships-grants.adoc @@ -0,0 +1,909 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-partnerships-grants.html' +summary: 'Create a new grant' +--- + += Create a new grant + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/partnerships/{partnership_id}/grants`# + + + +Creates a new grant in the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership resource. A partnership includes a type and a provider organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the desired values for the grant resource to be created. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the grant. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" +* "false" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the grant. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization that owns the resource. + + +|resources +|array[string] +|False +a|JSON array of resource UUIDs. + + +|role +|string +|True +a|JSON string containing the associated role ID. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.grant + + +|userGroupId +|string +|False +a|JSON string containing the UserGroupId. If the userGroupId is specified there should be no users specified in this API request body. + + +|users +|array[link:#users[users]] +|False +a|JSON array of users. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Associate users to manage Prod pool", + "name": "ScopeAdminGrant", + "resources": [ + "a94ac68f-ea20-47aa-add8-8d41be0d8466", + "b04ac68f-da27-578a-cee8-9e45bq0d8466" + ], + "role": "9e94cf09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.grant", + "users": [ + { + "userId": "e837c373-2ec4-47a8-b016-ba430ebce321" + }, + { + "auth0Id": "auth0|5a09551d0d9ef535b823bd3f" + }, + { + "emailId": "test@netapp.com" + } + ], + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created grant resource in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the grant. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" +* "false" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing the associated name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|role +|string +|True +a|JSON string containing the associated role ID. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.grant" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Associate users to manage Dev pool", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "role": "9e94cf09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.grant", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#users] +[.api-collapsible-fifth-title] +users + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a| + +|auth0Id +|string +|False +a| + +|emailId +|string +|False +a| + +|userId +|string +|False +a| + +|=== + + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-partnerships-resourceadmins.adoc b/tenancyv4/post-partnerships-resourceadmins.adoc new file mode 100644 index 00000000..9cdca84d --- /dev/null +++ b/tenancyv4/post-partnerships-resourceadmins.adoc @@ -0,0 +1,499 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-partnerships-resourceadmins.html' +summary: 'Add users with the ResourceAdmin role to a partnership' +--- + += Add users with the ResourceAdmin role to a partnership + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/partnerships/{partnership_id}/resourceadmins`# + + + +Adds users to the ResourceAdmin role in the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership used to display users with the ResourceAdmin role. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the users to be added. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.userbulk" + + +|users +|array[link:#users[users]] +|False +a|JSON array of users. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Adding user to the partnership ResourceAdmin with Acme", + "type": "application/vnd.netapp.bxp.userbulk", + "users": [ + { + "userId": "e837c373-2ec4-47a8-b016-ba430ebce321" + }, + { + "auth0Id": "auth0|5a09551d0d9ef535b823bd3f" + }, + { + "emailId": "test@netapp.com" + } + ], + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the users request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#users] +[.api-collapsible-fifth-title] +users + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a| + +|auth0Id +|string +|False +a| + +|emailId +|string +|False +a| + +|userId +|string +|False +a| + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-partnerships-useradmins.adoc b/tenancyv4/post-partnerships-useradmins.adoc new file mode 100644 index 00000000..e2fd8b48 --- /dev/null +++ b/tenancyv4/post-partnerships-useradmins.adoc @@ -0,0 +1,499 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-partnerships-useradmins.html' +summary: 'Add users to the UserAdmin role in a partnership' +--- + += Add users to the UserAdmin role in a partnership + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/partnerships/{partnership_id}/useradmins`# + + + +Adds users with the UserAdmin role to the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership used to display users with the UserAdmin role. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the users to be added. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.userbulk" + + +|users +|array[link:#users[users]] +|False +a|JSON array of users. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Adding user to the partnership UserAdmin with Acme", + "type": "application/vnd.netapp.bxp.userbulk", + "users": [ + { + "userId": "e837c373-2ec4-47a8-b016-ba430ebce321" + }, + { + "auth0Id": "auth0|5a09551d0d9ef535b823bd3f" + }, + { + "emailId": "test@netapp.com" + } + ], + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the users request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#users] +[.api-collapsible-fifth-title] +users + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a| + +|auth0Id +|string +|False +a| + +|emailId +|string +|False +a| + +|userId +|string +|False +a| + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-partnerships-users.adoc b/tenancyv4/post-partnerships-users.adoc new file mode 100644 index 00000000..5f8eb30d --- /dev/null +++ b/tenancyv4/post-partnerships-users.adoc @@ -0,0 +1,499 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-partnerships-users.html' +summary: 'Add users to a partnership' +--- + += Add users to a partnership + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/partnerships/{partnership_id}/users`# + + + +Adds users to the specified partnership. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|partnership_id +|string +|path +|True +a|ID of the partnership used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the users to be added. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.userbulk" + + +|users +|array[link:#users[users]] +|False +a|JSON array of users. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Adding user to the partnership with Acme", + "type": "application/vnd.netapp.bxp.userbulk", + "users": [ + { + "userId": "e837c373-2ec4-47a8-b016-ba430ebce321" + }, + { + "auth0Id": "auth0|5a09551d0d9ef535b823bd3f" + }, + { + "emailId": "test@netapp.com" + } + ], + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the users request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#users] +[.api-collapsible-fifth-title] +users + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a| + +|auth0Id +|string +|False +a| + +|emailId +|string +|False +a| + +|userId +|string +|False +a| + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-partnerships.adoc b/tenancyv4/post-partnerships.adoc new file mode 100644 index 00000000..d642c153 --- /dev/null +++ b/tenancyv4/post-partnerships.adoc @@ -0,0 +1,859 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-partnerships.html' +summary: 'Create a new partnership' +--- + += Create a new partnership + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/partnerships`# + + + +Creates a new partnership. + + +== Request Body + +Indicates the desired values for the partnership to be created. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|destinationOrganizationId +|string +|True +a|The ID of the destination organization that shares its users. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" +* "false" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing the partnership name (for example: "Partnership between Acme and PopShop", ...). +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|partnershipType +|string +|True +a|Type of partnership. + + +|sourceOrganizationId +|string +|True +a|The ID of the source organization that shares its resources. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this partnership. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.partnership" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "destinationOrganizationId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "Partnership between Prov and Acme", + "ownerOrganizationId": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "partnershipType": "msp", + "sourceOrganizationId": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.partnership", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created partnership resource in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|destinationOrganizationId +|string +|False +a|The ID of the destination organization that shares its users. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" +* "false" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing the partnership name (for example: "Partnership between Acme and PopShop", ...). +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|partnershipType +|string +|False +a|Type of partnership. + + +|sourceOrganizationId +|string +|False +a|The ID of the source organization that shares its resources. + + +|state +|string +|True +a|State of this record. +Defined values are: + +*** Minimum length: 1 + +*** Maximum length: 254 + +Possible values are: + +*** SOURCE_INITIATED + +*** DESTINATION_INITIATED + +*** APPROVED + +*** REJECTED + +*** HOLD + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this partnership. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.partnership" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "destinationOrganizationId": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "Partnership between Prov and Acme", + "ownerOrganizationId": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "partnershipType": "msp", + "sourceOrganizationId": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.partnership", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-projects-resources.adoc b/tenancyv4/post-projects-resources.adoc new file mode 100644 index 00000000..c6dac8eb --- /dev/null +++ b/tenancyv4/post-projects-resources.adoc @@ -0,0 +1,458 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-projects-resources.html' +summary: 'Add resources to a project' +--- + += Add resources to a project + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/projects/{project_id}/resources`# + + + +Adds resources to the specified project. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|Project ID used to display resources. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the resources to add to the project. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resources +|array[string] +|True +a|JSON array of resource UUIDs. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcebulk" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "resources": [ + "a94ac68f-ea20-47aa-add8-8d41be0d8466", + "b04ac68f-da27-578a-cee8-9e45bq0d8466" + ], + "type": "application/vnd.netapp.bxp.resourcebulk", + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the resources request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-projects-roles-usergroups.adoc b/tenancyv4/post-projects-roles-usergroups.adoc new file mode 100644 index 00000000..6f03d1e9 --- /dev/null +++ b/tenancyv4/post-projects-roles-usergroups.adoc @@ -0,0 +1,848 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-projects-roles-usergroups.html' +summary: 'Create a new user group in a project' +--- + += Create a new user group in a project + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/projects/{project_id}/roles/{role_id}/usergroups`# + + + +Creates a new user group. + + +== Request Body + +Indicates the desired values for the user group to be created. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This tag represents NetApp Sales Territory", + "name": "fed-pepsico-com-samlp_admin", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.usergroup", + "usergroupType": "USERGROUP", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created user group in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This tag represents NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "fed-pepsico-com-samlp_admin", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.usergroup", + "usergroupType": "USERGROUP", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-projects-users.adoc b/tenancyv4/post-projects-users.adoc new file mode 100644 index 00000000..99a618c8 --- /dev/null +++ b/tenancyv4/post-projects-users.adoc @@ -0,0 +1,458 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-projects-users.html' +summary: 'Add users to a project' +--- + += Add users to a project + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/projects/{project_id}/users`# + + + +Adds users to the specified project. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project used to display users. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the users to be added. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.userbulk" + + +|users +|array[string] +|False +a|JSON array of user UUIDs. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Adding user to NetApp Sales Territory", + "type": "application/vnd.netapp.bxp.userbulk", + "users": [ + "a94ac68f-ea20-47aa-add8-8d41be0d8466", + "b04ac68f-da27-578a-cee8-9e45bq0d8466" + ], + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the users request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-projects.adoc b/tenancyv4/post-projects.adoc new file mode 100644 index 00000000..bb3f67ea --- /dev/null +++ b/tenancyv4/post-projects.adoc @@ -0,0 +1,903 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-projects.html' +summary: 'Create a new project' +--- + += Create a new project + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/projects`# + + + +Creates a new project. + + +== Request Body + +Indicates the desired values for the project to be created. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "netapp-project-1", + "resourceType": "project", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created project in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "netapp-project-1", + "resourceType": "project", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-resourcegroups-resources.adoc b/tenancyv4/post-resourcegroups-resources.adoc new file mode 100644 index 00000000..27acf4de --- /dev/null +++ b/tenancyv4/post-resourcegroups-resources.adoc @@ -0,0 +1,458 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-resourcegroups-resources.html' +summary: 'Add resources to a resource group' +--- + += Add resources to a resource group + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/resourcegroups/{resourcegroup_id}/resources`# + + + +Adds resources to the specified resource group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resourcegroup_id +|string +|path +|True +a|ID of the resource group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the resources to add to the folder. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|resources +|array[string] +|True +a|JSON array of resource UUIDs. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcebulk" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "resources": [ + "a94ac68f-ea20-47aa-add8-8d41be0d8466", + "b04ac68f-da27-578a-cee8-9e45bq0d8466" + ], + "type": "application/vnd.netapp.bxp.resourcebulk", + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the resources request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-resourcegroups.adoc b/tenancyv4/post-resourcegroups.adoc new file mode 100644 index 00000000..acec8264 --- /dev/null +++ b/tenancyv4/post-resourcegroups.adoc @@ -0,0 +1,811 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-resourcegroups.html' +summary: 'Create a new resource group' +--- + += Create a new resource group + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/resourcegroups`# + + + +Creates a new resource group. + + +== Request Body + +Indicates the desired values for the resource group to be created. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of this resource group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this resource group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcegroup" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "name": "AcmeSystems", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.resourcegroup", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created resource group in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of this resource group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this resource group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcegroup" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "AcmeSystems", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.resourcegroup", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-resources.adoc b/tenancyv4/post-resources.adoc new file mode 100644 index 00000000..a7e080f3 --- /dev/null +++ b/tenancyv4/post-resources.adoc @@ -0,0 +1,901 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-resources.html' +summary: 'Create a new resource' +--- + += Create a new resource + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/resources`# + + + +Creates a new resource. + + +== Request Body + +Indicates the desired values for the resource to be created. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "name": "volume-1", + "rawId": "cluster-1-volume-1", + "resourceType": "volume", + "tags": [ + { + "internal:bxp:organizationId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created resource in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "volume-1", + "rawId": "cluster-1-volume-1", + "resourceType": "volume", + "tags": [ + { + "internal:bxp:organizationId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-usergroups-users.adoc b/tenancyv4/post-usergroups-users.adoc new file mode 100644 index 00000000..1a2f6682 --- /dev/null +++ b/tenancyv4/post-usergroups-users.adoc @@ -0,0 +1,457 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-usergroups-users.html' +summary: 'Add users to a user group' +--- + += Add users to a user group + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/usergroups/{usergroup_id}/users`# + + + +Adds users to the specified user group. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|usergroup_id +|string +|path +|True +a|ID of the user group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Indicates the users to be added. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.userbulk" + + +|users +|array[string] +|False +a|JSON array of user UUIDs. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "type": "application/vnd.netapp.bxp.userbulk", + "users": [ + "a94ac68f-ea20-47aa-add8-8d41be0d8466", + "b04ac68f-da27-578a-cee8-9e45bq0d8466" + ], + "version": "1.0" +} +==== + +== Response + +``` +Status: 202, Indicates the users request was accepted. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-usergroups.adoc b/tenancyv4/post-usergroups.adoc new file mode 100644 index 00000000..f04ad77e --- /dev/null +++ b/tenancyv4/post-usergroups.adoc @@ -0,0 +1,846 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-usergroups.html' +summary: 'Create a new user group' +--- + += Create a new user group + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/usergroups`# + + + +Creates a new user group. + + +== Request Body + +Indicates the desired values for the user group to be created. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This tag represents NetApp Sales Territory", + "name": "AcmeUsers", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.usergroup", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created user group in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|True +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This tag represents NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "Acme Users", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.usergroup", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/post-users.adoc b/tenancyv4/post-users.adoc new file mode 100644 index 00000000..b425adb3 --- /dev/null +++ b/tenancyv4/post-users.adoc @@ -0,0 +1,1087 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/post-users.html' +summary: 'Create a new user' +--- + += Create a new user + +[.api-doc-operation .api-doc-operation-post]#POST# [.api-doc-code-block]#`/users`# + + + +Indicates the desired values for the user to be created. + + +== Request Body + +Creates a new user. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|email +|string +|False +a|User email address. + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|password +|string +|False +a|User password in plain text. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod, expirationTimestamp, and publicKey properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|stateDesired +|string +|False +a|Expected state of the user. +Defined values are: + +_**_ "CREATE" + +_**_ "UPDATE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "Adding user to NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "user-1", + "password": "********", + "stateDesired": "CREATE", + "tags": [ + { + "internal:bxp:organizationId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Response + +``` +Status: 201, Returns the newly created user in the JSON response body. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0ClientSecret +|string +|False +a|Auth0 Client Secret. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "Acme Co", + "state": "ACTIVE", + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod, expirationTimestamp, and publicKey properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|authenticationMethod +|string +|True +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. This is only applicable when an RSA key is provided for the public key. When a certificate is provided, the value is set to the certificate's expiration timestamp. + + +|publicKey +|string +|False +a|Public X.509 certificate or RSA key in PEM format converted to a string with escaped new line characters (`\n`). + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/put-folders-.adoc b/tenancyv4/put-folders-.adoc new file mode 100644 index 00000000..813fdab8 --- /dev/null +++ b/tenancyv4/put-folders-.adoc @@ -0,0 +1,641 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/put-folders-.html' +summary: 'Update a folder' +--- + += Update a folder + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/folders/{folder_id}`# + + + +Replaces the specified folder with new information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the entire stored folder with the supplied JSON request body while preserving the key values that are not user-modifiable. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "netapp-sales", + "resourceType": "folder", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the folder was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/put-folders-projects-.adoc b/tenancyv4/put-folders-projects-.adoc new file mode 100644 index 00000000..848516ee --- /dev/null +++ b/tenancyv4/put-folders-projects-.adoc @@ -0,0 +1,650 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/put-folders-projects-.html' +summary: 'Modify a project under a folder' +--- + += Modify a project under a folder + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/folders/{folder_id}/projects/{project_id}`# + + + +Replaces a project in the specified folder with new information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the entire stored project with the supplied JSON request body while preserving the key values that are not user-modifiable. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "netapp-project-1", + "resourceType": "project", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the project was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/put-organizations-.adoc b/tenancyv4/put-organizations-.adoc new file mode 100644 index 00000000..6b65731c --- /dev/null +++ b/tenancyv4/put-organizations-.adoc @@ -0,0 +1,647 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/put-organizations-.html' +summary: 'Modify an organization' +--- + += Modify an organization + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/organizations/{organization_id}`# + + + +Replaces the specified organization with new information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the entire stored organization resource with the supplied JSON request body while preserving the key values that are not user-modifiable. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "netapp", + "resourceType": "organization", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:crmId": "a1a6ddeb-2a15-4907-a801-9b9c3f40a7b7" + }, + { + "internal:bxp:cmatId": "2e007562-f061-4b18-b9bd-16ef3bde524b" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the organization was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/put-organizations-folders-.adoc b/tenancyv4/put-organizations-folders-.adoc new file mode 100644 index 00000000..02e790a4 --- /dev/null +++ b/tenancyv4/put-organizations-folders-.adoc @@ -0,0 +1,650 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/put-organizations-folders-.html' +summary: 'Update a folder under an organization' +--- + += Update a folder under an organization + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/organizations/{organization_id}/folders/{folder_id}`# + + + +Replaces a folder under the specified organization with new information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|folder_id +|string +|path +|True +a|ID of the folder. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the entire stored folder with the supplied JSON request body while preserving the key values that are not user-modifiable. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "netapp-sales", + "resourceType": "folder", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the folder was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/put-organizations-projects-.adoc b/tenancyv4/put-organizations-projects-.adoc new file mode 100644 index 00000000..37fa0a08 --- /dev/null +++ b/tenancyv4/put-organizations-projects-.adoc @@ -0,0 +1,650 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/put-organizations-projects-.html' +summary: 'Modify a project under an organization' +--- + += Modify a project under an organization + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/organizations/{organization_id}/projects/{project_id}`# + + + +Replaces a project under the specified organization with new information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the entire stored project with the supplied JSON request body while preserving the key values that are not user-modifiable. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "netapp-project-1", + "resourceType": "project", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the project was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/put-organizations-serviceaccounts-.adoc b/tenancyv4/put-organizations-serviceaccounts-.adoc new file mode 100644 index 00000000..68ac8b80 --- /dev/null +++ b/tenancyv4/put-organizations-serviceaccounts-.adoc @@ -0,0 +1,1112 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/put-organizations-serviceaccounts-.html' +summary: 'Modify a service account' +--- + += Modify a service account + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/organizations/{organization_id}/serviceAccounts/{serviceaccount_id}`# + + + +Updates a service account under an organization. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|organization_id +|string +|path +|True +a|ID of the organization. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|serviceaccount_id +|string +|path +|True +a|ID of the service account. + +* example: 118df263-44d0-4154-8daa-ff61cb471557 + + +|=== + +== Request Body + +Replaces the entire stored service account with the supplied JSON request body while preserving the key values that are not user-modifiable. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|password +|string +|False +a|User password in plain text. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod, expirationTimestamp, and publicKey properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|stateDesired +|string +|False +a|Expected state of the user. +Defined values are: + +***** "CREATE" + +***** "UPDATE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "service-account-1", + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Response + +``` +Status: 200, Indicates if the service account was updated. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0ClientSecret +|string +|False +a|Auth0 Client Secret. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "service-account-1", + "type": "application/vnd.netapp.bxp.user", + "userType": "serviceAccount", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod, expirationTimestamp, and publicKey properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|authenticationMethod +|string +|True +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. This is only applicable when an RSA key is provided for the public key. When a certificate is provided, the value is set to the certificate's expiration timestamp. + + +|publicKey +|string +|False +a|Public X.509 certificate or RSA key in PEM format converted to a string with escaped new line characters (`\n`). + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/put-projects-.adoc b/tenancyv4/put-projects-.adoc new file mode 100644 index 00000000..086ecd3c --- /dev/null +++ b/tenancyv4/put-projects-.adoc @@ -0,0 +1,641 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/put-projects-.html' +summary: 'Modify a project' +--- + += Modify a project + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/projects/{project_id}`# + + + +Replaces the specified project with new information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|project_id +|string +|path +|True +a|ID of the project. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the entire stored project with the supplied JSON request body while preserving the key values that are not user-modifiable. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "name": "netapp-project-1", + "resourceType": "project", + "tags": [ + { + "internal:bxp:parentId": "777a3f38-d4fa-5b62-a391-a69029758d32" + }, + { + "internal:bxp:ancestors": "666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the project was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/put-resourcegroups-.adoc b/tenancyv4/put-resourcegroups-.adoc new file mode 100644 index 00000000..b4494c5d --- /dev/null +++ b/tenancyv4/put-resourcegroups-.adoc @@ -0,0 +1,591 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/put-resourcegroups-.html' +summary: 'Modify a resource group' +--- + += Modify a resource group + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/resourcegroups/{resourcegroup_id}`# + + + +Replaces the specified resource group with new information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resourcegroup_id +|string +|path +|True +a|ID of the resource group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the entire stored resource with the supplied JSON request body while preserving the key values that are not user-modifiable. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of this resource group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|JSON string containing a name for the resourcegroup. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for this resource group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resourcegroup" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "AcmeSystemsUSA", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.resourcegroup", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the resource group was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/put-resources-.adoc b/tenancyv4/put-resources-.adoc new file mode 100644 index 00000000..cabddda5 --- /dev/null +++ b/tenancyv4/put-resources-.adoc @@ -0,0 +1,647 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/put-resources-.html' +summary: 'Modify a resource' +--- + += Modify a resource + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/resources/{resource_id}`# + + + +Replaces the specified resource with new information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|resource_id +|string +|path +|True +a|ID of the resource. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the entire stored resource with the supplied JSON request body while preserving the key values that are not user-modifiable. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 254 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|True +a|JSON string containing a name for the resource. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|parentId +|string +|False +a|JSON string containing the ID of the hierarchy. + + +|rawId +|string +|False +a|JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. + +* maxLength: 400 +* minLength: 1 + + +|resourceClass +|string +|True +a|JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. + + +|resourceType +|string +|True +a|JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. + + +|state +|string +|False +a|Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process +or available, which indicates the resources is currently available. +Defined values are: + +* "reconciling" +* "available" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the resource. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.resource" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "Added a resource of resourceType volume", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "volume-1", + "rawId": "cluster-1-volume-1", + "resourceType": "volume", + "tags": [ + { + "internal:bxp:organizationId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.resource", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the resource was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/put-usergroups-.adoc b/tenancyv4/put-usergroups-.adoc new file mode 100644 index 00000000..15b34d8a --- /dev/null +++ b/tenancyv4/put-usergroups-.adoc @@ -0,0 +1,604 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/put-usergroups-.html' +summary: 'Modify a user group' +--- + += Modify a user group + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/usergroups/{usergroup_id}`# + + + +Replaces the specified user group with new information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|usergroup_id +|string +|path +|True +a|ID of the user group. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the entire stored resource with the supplied JSON request body while preserving the key values that are not user-modifiable. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|description +|string +|False +a|JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|JSON string containing a name for the user group. +Defined values are: + +* Minimum length: 1 +* Maximum length: 300 +* This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|ownerOrganizationId +|string +|False +a|JSON string containing the ID of the organization. + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user group. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.usergroup" + + +|usergroupType +|string +|False +a|Specifies type of userGroup. +Defined values are: + +* SYSTEM +* FEDERATED +* USERGROUP +Defaults to SYSTEM + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "description": "This tag represents NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "AcmeSystemsUSA", + "ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269", + "type": "application/vnd.netapp.bxp.usergroup", + "version": "1.0" +} +==== + +== Response + +``` +Status: 204, Indicates if the user group was updated. +``` + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/put-users-.adoc b/tenancyv4/put-users-.adoc new file mode 100644 index 00000000..7e78084b --- /dev/null +++ b/tenancyv4/put-users-.adoc @@ -0,0 +1,1126 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/put-users-.html' +summary: 'Modify a user' +--- + += Modify a user + +[.api-doc-operation .api-doc-operation-put]#PUT# [.api-doc-code-block]#`/users/{user_id}`# + + + +Replaces the specified user with new information. + + +== Parameters + +[cols=5*,options=header] +|=== +|Name +|Type +|In +|Required +|Description + +|user_id +|string +|path +|True +a|ID of the user. + +* example: 666a3f38-d4fa-5b62-a391-a69029758d32 + + +|=== + +== Request Body + +Replaces the entire stored resource with the supplied JSON request body while preserving the key values that are not user-modifiable. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|False +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|password +|string +|False +a|User password in plain text. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod, expirationTimestamp, and publicKey properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|stateDesired +|string +|False +a|Expected state of the user. +Defined values are: + +***** "CREATE" + +***** "UPDATE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example request +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "Adding user to NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "isServiceAccount": false, + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "user-1", + "password": "********", + "stateDesired": "UPDATE", + "tags": [ + { + "internal:bxp:organizationId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Response + +``` +Status: 200, Indicates if the user was updated. +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|aadId +|string +|False +a|User AAD ID. + + +|auth0ClientSecret +|string +|False +a|Auth0 Client Secret. + + +|auth0Id +|string +|False +a|User auth0 ID. + + +|description +|string +|False +a|JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. + + +|id +|string +|True +a|Globally unique identifier of the resource. +Defined values are: + +* Conforms to the UUIDv4 Schema + + +|isSystem +|string +|False +a|Specifies if an object is system generated. +Defined values are: + +* "true" + + +|legacyId +|string +|False +a|Unique identifier as understood by the previous version of this service. + + +|links +|array[link:#type_bxp_link[type_bxp_link]] +|False +a| + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|name +|string +|False +a|User name. + + +|ownerOrganizationId +|string +|True +a|JSON string containing the ID of the organization. + + +|serviceAccount +|link:#serviceAccount[serviceAccount] +|False +a|Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +|state +|string +|False +a|Current state of the user. +Defined values are: + +_**_ "ACTIVE" + +_**_ "INACTIVE" + + +|tags +|array[link:#tags[tags]] +|False +a|JSON array of tags (name/value pairs) representing metadata for the user. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.user" + + +|userType +|string +|False +a|Type of user. + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +.Example response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "auth0Id": "waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM", + "description": "Adding user to NetApp Sales Territory", + "id": "666a3f38-d4fa-5b62-a391-a69029758d32", + "metadata": { + "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269", + "creationTimestamp": "2022-10-06T20:58:16.305662Z", + "labels": [], + "modificationTimestamp": "2022-10-06T20:58:16.305662Z", + "modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269" + }, + "name": "user-1", + "state": "ACTIVE", + "tags": [ + { + "internal:bxp:folderId": "777a3f38-d4fa-5b62-a391-a69029758d32" + } + ], + "type": "application/vnd.netapp.bxp.user", + "version": "1.0" +} +==== + +== Error + +``` +Status: 400, Bad request +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The supplied query parameters are invalid.", + "status": "400", + "title": "Invalid query parameters", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 401, Unauthorized +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request is missing the required bearer token.", + "status": "401", + "title": "Missing bearer token", + "type": "https://bluexp.netapp.io/problems/1" +} +==== + +== Error + +``` +Status: 403, Forbidden +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The requested operation isn't permitted.", + "status": "403", + "title": "Operation not permitted", + "type": "https://bluexp.netapp.io/problems/11" +} +==== + +== Error + +``` +Status: 404, Not found +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The collection specified in the request URI wasn't found.", + "status": "404", + "title": "Collection not found", + "type": "https://bluexp.netapp.io/problems/2" +} +==== + +== Error + +``` +Status: 409, Conflict +``` + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|correlationId +|string +|False +a|Internal UUID representing the request or trace ID related. + + +|detail +|string +|False +a|Details about the problem. + + +|invalidParams +|array[link:#invalidParams[invalidParams]] +|False +a|List of invalid parameters. + + +|status +|string +|True +a|HTTP error code related to the problem. + + +|title +|string +|True +a|Title description of the problem. + + +|type +|string +|True +a|Content-type of the object. + + +|=== + + +.Example error response +[%collapsible%closed] +==== +[source,json,subs=+macros] +{ + "detail": "The request body JSON contains a field that conflicts with an idempotent value.", + "status": "409", + "title": "JSON resource conflict", + "type": "https://bluexp.netapp.io/problems/10" +} +==== + +== Definitions + +[.api-def-first-level] +.See Definitions +[%collapsible%closed] +//Start collapsible Definitions block +==== +[#type_bxp_label] +[.api-collapsible-fifth-title] +type_bxp_label + +Name/value pair. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the label. + + +|value +|string +|True +a|Value of the label. + + +|=== + + +[#type_bxp_metadata] +[.api-collapsible-fifth-title] +type_bxp_metadata + +Metadata associated with the resource. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|createdBy +|string +|False +a|UUID of the user who created the resource. + + +|creationTimestamp +|string +|False +a|Resource creation date. + + +|labels +|array[link:#type_bxp_label[type_bxp_label]] +|False +a|Array of name/value pairs representing additional information for the resource. + + +|modificationTimestamp +|string +|False +a|Resource modification date. + + +|modifiedBy +|string +|False +a|UUID of the user who modified the resource. + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod, expirationTimestamp, and publicKey properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|authenticationMethod +|string +|True +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. This is only applicable when an RSA key is provided for the public key. When a certificate is provided, the value is set to the certificate's expiration timestamp. + + +|publicKey +|string +|False +a|Public X.509 certificate or RSA key in PEM format converted to a string with escaped new line characters (`\n`). + + +|=== + + +[#tags] +[.api-collapsible-fifth-title] +tags +Hash mapping strings to string + +[#accept-post] +[.api-collapsible-fifth-title] +accept-post + +Provides details about which media types are accepted when creating a resource. + + + +[#accept-put] +[.api-collapsible-fifth-title] +accept-put + +Indicates details about what media types are accepted when updating a resource. + + + +[#hints] +[.api-collapsible-fifth-title] +hints + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|accept-post +|link:#accept-post[accept-post] +|False +a|Provides details about which media types are accepted when creating a resource. + + +|accept-put +|link:#accept-put[accept-put] +|False +a|Indicates details about what media types are accepted when updating a resource. + + +|allow +|array[string] +|False +a|An array of methods that can be used to interact with the link target. + +Defined values for collections: + +"POST" - Indicates if new resources can be created in the collection. +Defined values for resources: + +"PUT" - Indicates if the resource can be modified +"DELETE" - Indicates if the resource can be deleted + + +|permissions +|array[string] +|False +a|List of the permissions required to use the link. + + +|status +|string +|False +a|Indicates if the target of the link is deprecated. + +Defined values are: + +"deprecated" + + +|=== + + +[#targetSchema] +[.api-collapsible-fifth-title] +targetSchema + +Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + + +[#type_bxp_link] +[.api-collapsible-fifth-title] +type_bxp_link + +Link relationship + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|hints +|link:#hints[hints] +|False +a| + +|href +|string +|True +a|String describing a relative URI. + + +|rel +|string +|True +a|The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. + + +|targetSchema +|link:#targetSchema[targetSchema] +|False +a|Link to a JSON schema that can be used to validate the target of the link (response body). + +The preferred format is a $ref link to an external schema. + +This field is optional and should only be included when there is a known schema for the target of the href. + +See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. + + +|title +|string +|False +a|Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). + +Minimum length: 0 +Maximum length: 1023 + + +|type +|string +|False +a|The media type of the target of the href. + +This field is optional and should be included when there is a known media type for the target of the href. + +See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. + + +|=== + + +[#user_1_0_public_key_get_response_body] +[.api-collapsible-fifth-title] +user_1.0_public_key_get_response_body + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|credentialId +|string +|False +a|The Auth0 credential ID associated with the public key. + + +|expirationTimestamp +|string +|False +a|The date and time when the public key expires. + + +|fingerprint +|string +|False +a|The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. + + +|id +|string +|True +a|Globally unique identifier of the resource conforming to the UUIDv4 schema. + + +|keyType +|string +|False +a|Type of the public key. +Defined values are: + +* "X509_CERTIFICATE" - The public key is an X.509 certificate. +* "RSA_KEY" - The public key is an RSA key. + + +|metadata +|link:#type_bxp_metadata[type_bxp_metadata] +|False +a|Metadata associated with the resource. + + +|state +|string +|False +a|The state of the public key. Defined values are: + +* "ENABLED" - The public key is enabled. +* "DISABLED" - The public key is disabled. + + +|type +|string +|True +a|Media type of the resource. +Defined values are: + +* "application/vnd.netapp.bxp.publickey" + + +|version +|string +|True +a|Version of the resource. +Defined values are: + +* "1.0" + + +|=== + + +[#serviceAccount] +[.api-collapsible-fifth-title] +serviceAccount + +Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. + + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|audience +|string +|False +a|The value that must be included in the 'audience' claim of the private key JWT token. + + +|authenticationMethod +|string +|False +a|Authentication method used by the service account. +Defined values are: + +* "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. +* "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. + + +|expirationNotificationPeriod +|string +|False +a|The time period when expiration notifications are generated. Defined values are: + +* "P7D" - Notifications are sent daily 7 days before expiration. +* "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. + + +|publicKeys +|array[link:#user_1_0_public_key_get_response_body[user_1.0_public_key_get_response_body]] +|False +a|List of public keys associated with the service account. + + +|=== + + +[#invalidParams] +[.api-collapsible-fifth-title] +invalidParams + +[cols=4*,options=header] +|=== +|Name +|Type +|Required +|Description + +|name +|string +|True +a|Name of the invalid parameter. + + +|reason +|string +|True +a|Reason why the parameter is invalid. + + +|=== + + +//end collapsible .Definitions block +==== diff --git a/tenancyv4/resource_and_resourcegroup_overview.adoc b/tenancyv4/resource_and_resourcegroup_overview.adoc new file mode 100644 index 00000000..84034d4d --- /dev/null +++ b/tenancyv4/resource_and_resourcegroup_overview.adoc @@ -0,0 +1,21 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/resource_and_resourcegroup_overview.html' +summary: 'Resource and resourcegroup endpoints in the identity and access management REST API for the NetApp Console' +--- + += Resource and resourcegroup endpoints in the identity and access management REST API for the NetApp Console + + + +The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. + +ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. + +A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. + +A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. + + diff --git a/tenancyv4/role_overview.adoc b/tenancyv4/role_overview.adoc new file mode 100644 index 00000000..2cd81f37 --- /dev/null +++ b/tenancyv4/role_overview.adoc @@ -0,0 +1,19 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/role_overview.html' +summary: 'Role endpoints in the identity and access management REST API for the NetApp Console' +--- + += Role endpoints in the identity and access management REST API for the NetApp Console + + + +The role endpoints enable you to create and view roles, which are sets of permissions. + +In NetApp Console identity and access management (IAM), you don't assign permissions directly to users in an organization. Instead, you assign each user a role. A role contains a set of permissions that enables a user to perform specific actions at a specific level of the resource hierarchy. Roles can represent actions or features, or the access level that user has for a particular service. + +IAM supports several predefined roles that you can assign to the users in your organization. Custom roles are not supported. + + diff --git a/tenancyv4/sidebar.yml b/tenancyv4/sidebar.yml deleted file mode 100644 index 8eb08616..00000000 --- a/tenancyv4/sidebar.yml +++ /dev/null @@ -1,3 +0,0 @@ -section: tenancyv4 -title: Identity and access management -generate: tenancyv4 \ No newline at end of file diff --git a/tenancyv4/tenancyv4-x-doc.yml b/tenancyv4/tenancyv4-x-doc.yml deleted file mode 100644 index fbdfe5e7..00000000 --- a/tenancyv4/tenancyv4-x-doc.yml +++ /dev/null @@ -1,2004 +0,0 @@ ---- -overview: Identity and access management REST API -permalink: overview.html -paths: - "/bindings": - get: - x-doc: - title: List all bindings - category: Binding - filename: get-bindings.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new binding - category: Binding - filename: post-bindings.html - subcategory: - explorer: false - explorer: false - "/bindings/{binding_id}": - delete: - x-doc: - title: Delete a binding - category: Binding - filename: delete-bindings-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a binding - category: Binding - filename: get-bindings-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a binding partially - category: Binding - filename: patch-bindings-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify a binding - category: Binding - filename: put-bindings-.html - subcategory: - explorer: false - explorer: false - "/folders": - get: - x-doc: - title: List all folders - category: Hierarchy - filename: get-folders.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new folder - category: Hierarchy - filename: post-folders.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}": - delete: - x-doc: - title: Delete a folder - category: Hierarchy - filename: delete-folders-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a folder - category: Hierarchy - filename: get-folders-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a folder partially - category: Hierarchy - filename: patch-folders-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Update a folder - category: Hierarchy - filename: put-folders-.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/folders": - get: - x-doc: - title: List all folders under a parent folder - category: Hierarchy - filename: get-folders-folders.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a child folder under a parent folder - category: Hierarchy - filename: post-folders-folders.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/folders/{childfolder_id}": - delete: - x-doc: - title: Remove a child folder from a parent folder - category: Hierarchy - filename: delete-folders-folders-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a child folder under a parent folder - category: Hierarchy - filename: get-folders-folders-.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/projects": - get: - x-doc: - title: List all projects under a folder - category: Hierarchy - filename: get-folders-projects.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new project under a folder - category: Hierarchy - filename: post-folders-projects.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/projects/{project_id}": - delete: - x-doc: - title: Remove a project from a folder - category: Hierarchy - filename: delete-folders-projects-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a project under a folder - category: Hierarchy - filename: get-folders-projects-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a project under a folder partially - category: Hierarchy - filename: patch-folders-projects-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify a project under a folder - category: Hierarchy - filename: put-folders-projects-.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/resourcegroups": - get: - x-doc: - title: List all resource groups in the folder - category: Resource and resourcegroup - filename: get-folders-resourcegroups.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add resource groups to a folder - category: Resource and resourcegroup - filename: post-folders-resourcegroups.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/resourcegroups/{resourcegroup_id}": - delete: - x-doc: - title: Remove a resource group from a folder - category: Resource and resourcegroup - filename: delete-folders-resourcegroups-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a resource group in a folder - category: Resource and resourcegroup - filename: get-folders-resourcegroups-.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/resources": - get: - x-doc: - title: List all resources under a folder - category: Resource and resourcegroup - filename: get-folders-resources.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add resources to a folder - category: Resource and resourcegroup - filename: post-folders-resources.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/resources/{resource_id}": - delete: - x-doc: - title: Remove a resource from a folder - category: Resource and resourcegroup - filename: delete-folders-resources-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a resource under a folder - category: Resource and resourcegroup - filename: get-folders-resources-.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/usergroups": - get: - x-doc: - title: List all user groups in a folder - category: User and usergroup - filename: get-folders-usergroups.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add user groups to a folder - category: User and usergroup - filename: post-folders-usergroups.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/usergroups/{usergroup_id}": - delete: - x-doc: - title: Remove a user group from a folder - category: User and usergroup - filename: delete-folders-usergroups-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a user group in a folder - category: User and usergroup - filename: get-folders-usergroups-.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/users": - get: - x-doc: - title: List all users for a folder - category: User and usergroup - filename: get-folders-users.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add users to a folder - category: User and usergroup - filename: post-folders-users.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/users/{user_id}": - delete: - x-doc: - title: Remove a user from a folder - category: User and usergroup - filename: delete-folders-users-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a user associated with a folder - category: User and usergroup - filename: get-folders-users-.html - subcategory: - explorer: false - explorer: false - "/organizations": - get: - x-doc: - title: List all organizations - category: Hierarchy - filename: get-organizations.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new organization - category: Hierarchy - filename: post-organizations.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}": - delete: - x-doc: - title: Delete an organization - category: Hierarchy - filename: delete-organizations-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve an organization - category: Hierarchy - filename: get-organizations-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update an organization partially - category: Hierarchy - filename: patch-organizations-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify an organization - category: Hierarchy - filename: put-organizations-.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/folders": - get: - x-doc: - title: List all folders under an organization - category: Hierarchy - filename: get-organizations-folders.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new folder under an organization - category: Hierarchy - filename: post-organizations-folders.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/folders/{folder_id}": - delete: - x-doc: - title: Remove a folder from an organization - category: Hierarchy - filename: delete-organizations-folders-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a folder under an organization - category: Hierarchy - filename: get-organizations-folders-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a folder under an organization partially - category: Hierarchy - filename: patch-organizations-folders-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Update a folder under an organization - category: Hierarchy - filename: put-organizations-folders-.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/partnership-with": - get: - x-doc: - title: List all partner organizations - category: Partnership - filename: get-organizations-partnership-with.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/partnerships": - get: - x-doc: - title: List all the partnership resources belonging to an organization - category: Partnership - filename: get-organizations-partnerships.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/partnerships/{partnership_id}": - delete: - x-doc: - title: Remove a partnership resource from the organization partnerships list - category: Partnership - filename: delete-organizations-partnerships-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a partnership resource from an organization - category: Partnership - filename: get-organizations-partnerships-.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/projects": - get: - x-doc: - title: List all projects under an organization - category: Hierarchy - filename: get-organizations-projects.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new project under an organization - category: Hierarchy - filename: post-organizations-projects.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/projects/{project_id}": - delete: - x-doc: - title: Remove a project from an organization - category: Hierarchy - filename: delete-organizations-projects-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a project under an organization - category: Hierarchy - filename: get-organizations-projects-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a project under an organization partially - category: Hierarchy - filename: patch-organizations-projects-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify a project under an organization - category: Hierarchy - filename: put-organizations-projects-.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/resourcegroups": - get: - x-doc: - title: List all resource groups under an organization - category: Resource and resourcegroup - filename: get-organizations-resourcegroups.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add resource groups to an organization - category: Resource and resourcegroup - filename: post-organizations-resourcegroups.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/resourcegroups/{resourcegroup_id}": - delete: - x-doc: - title: Remove a resource group from an organization - category: Resource and resourcegroup - filename: delete-organizations-resourcegroups-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a resource group under an organization - category: Resource and resourcegroup - filename: get-organizations-resourcegroups-.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/resources": - get: - x-doc: - title: List all resources under an organization - category: Resource and resourcegroup - filename: get-organizations-resources.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add resources to an organization - category: Resource and resourcegroup - filename: post-organizations-resources.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/resources/{resource_id}": - delete: - x-doc: - title: Remove a resource from an organization - category: Resource and resourcegroup - filename: delete-organizations-resources-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a resource under an organization - category: Resource and resourcegroup - filename: get-organizations-resources-.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/roles/{role_id}/users": - post: - x-doc: - title: Associate users in an organization with a role - category: User and usergroup - filename: post-organizations-roles-users.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/serviceAccounts": - get: - x-doc: - title: List all users - category: User and usergroup - filename: get-organizations-serviceaccounts.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new service account - category: User and usergroup - filename: post-organizations-serviceaccounts.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/serviceAccounts/{serviceaccount_id}": - delete: - x-doc: - title: Delete a service account - category: User and usergroup - filename: delete-organizations-serviceaccounts-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a service account - category: User and usergroup - filename: get-organizations-serviceaccounts-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a service account partially - category: User and usergroup - filename: patch-organizations-serviceaccounts-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify a service account - category: User and usergroup - filename: put-organizations-serviceaccounts-.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/serviceAccounts/{serviceaccount_id}/clientSecret": - post: - x-doc: - title: Create a new client secret for a service account - category: User and usergroup - filename: post-organizations-serviceaccounts-clientsecret.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/usergroups": - get: - x-doc: - title: List all user groups under an organization - category: User and usergroup - filename: get-organizations-usergroups.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add user groups to an organization - category: User and usergroup - filename: post-organizations-usergroups.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/usergroups/{usergroup_id}": - delete: - x-doc: - title: Remove a user group from an organization - category: User and usergroup - filename: delete-organizations-usergroups-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a user group under an organization - category: User and usergroup - filename: get-organizations-usergroups-.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/users": - get: - x-doc: - title: List all users under an organization - category: User and usergroup - filename: get-organizations-users.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add users to an organization - category: User and usergroup - filename: post-organizations-users.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/users/{user_id}": - delete: - x-doc: - title: Remove a user from an organization - category: User and usergroup - filename: delete-organizations-users-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a user under an organization - category: User and usergroup - filename: get-organizations-users-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Modify a user - category: User and Usergroup - filename: patch-organizations-users-.html - subcategory: - explorer: false - "/partnerships": - get: - x-doc: - title: List all partnerships - category: Partnership - filename: get-partnerships.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new partnership - category: Partnership - filename: post-partnerships.html - subcategory: - explorer: false - explorer: false - "/partnerships/{partnership_id}": - delete: - x-doc: - title: Delete a partnership - category: Partnership - filename: delete-partnerships-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a partnership - category: Partnership - filename: get-partnerships-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a partnership partially - category: Partnership - filename: patch-partnerships-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify a partnership - category: Partnership - filename: put-partnerships-.html - subcategory: - explorer: false - explorer: false - "/partnershiptypes": - get: - x-doc: - title: List all partnership types - category: Resource and resourcegroup - filename: get-partnershiptypes.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new partnership type - category: Resource and resourcegroup - filename: post-partnershiptypes.html - subcategory: - explorer: false - explorer: false - "/partnershiptypes/{partnershiptype_id}": - delete: - x-doc: - title: Delete a partnership type - category: Resource and resourcegroup - filename: delete-partnershiptypes-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a partnership type - category: Resource and resourcegroup - filename: get-partnershiptypes-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a partnership type partially - category: Resource and resourcegroup - filename: patch-partnershiptypes-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Update a partnership type - category: Resource and resourcegroup - filename: put-partnershiptypes-.html - subcategory: - explorer: false - explorer: false - "/permissions": - get: - x-doc: - title: List all permissions - category: Permission - filename: get-permissions.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new permission - category: Permission - filename: post-permissions.html - subcategory: - explorer: false - explorer: false - "/permissions/{permission_id}": - delete: - x-doc: - title: Delete a permission - category: Permission - filename: delete-permissions-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a permission - category: Permission - filename: get-permissions-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a permission partially - category: Permission - filename: patch-permissions-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify a permission - category: Permission - filename: put-permissions-.html - subcategory: - explorer: false - explorer: false - "/permissions/{permission_id}/bindings": - get: - x-doc: - title: List all bindings for a permission - category: Binding - filename: get-permissions-bindings.html - subcategory: - explorer: false - explorer: false - "/projects": - get: - x-doc: - title: List all projects - category: Hierarchy - filename: get-projects.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new project - category: Hierarchy - filename: post-projects.html - subcategory: - explorer: false - explorer: false - "/projects/{project_id}": - delete: - x-doc: - title: Delete a project - category: Hierarchy - filename: delete-projects-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a project - category: Hierarchy - filename: get-projects-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a project partially - category: Hierarchy - filename: patch-projects-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify a project - category: Hierarchy - filename: put-projects-.html - subcategory: - explorer: false - explorer: false - "/projects/{project_id}/resourcegroups": - get: - x-doc: - title: List all resource groups under a project - category: Resource and resourcegroup - filename: get-projects-resourcegroups.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add resource groups to a project - category: Resource and resourcegroup - filename: post-projects-resourcegroups.html - subcategory: - explorer: false - explorer: false - "/projects/{project_id}/resourcegroups/{resourcegroup_id}": - delete: - x-doc: - title: Remove a resource group from a project - category: Resource and resourcegroup - filename: delete-projects-resourcegroups-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a resource group under a project - category: Resource and resourcegroup - filename: get-projects-resourcegroups-.html - subcategory: - explorer: false - explorer: false - "/projects/{project_id}/resources": - get: - x-doc: - title: List all resources in a project - category: Resource and resourcegroup - filename: get-projects-resources.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add resources to a project - category: Resource and resourcegroup - filename: post-projects-resources.html - subcategory: - explorer: false - explorer: false - "/projects/{project_id}/resources/{resource_id}": - delete: - x-doc: - title: Remove a resource from a project - category: Resource and resourcegroup - filename: delete-projects-resources-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a resource in a project - category: Resource and resourcegroup - filename: get-projects-resources-.html - subcategory: - explorer: false - explorer: false - "/projects/{project_id}/usergroups": - get: - x-doc: - title: List all user groups in the project - category: User and usergroup - filename: get-projects-usergroups.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add user groups to a project - category: User and usergroup - filename: post-projects-usergroups.html - subcategory: - explorer: false - explorer: false - "/projects/{project_id}/usergroups/{usergroup_id}": - delete: - x-doc: - title: Remove a user group from a project - category: User and usergroup - filename: delete-projects-usergroups-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a user group under a project - category: User and usergroup - filename: get-projects-usergroups-.html - subcategory: - explorer: false - explorer: false - "/projects/{project_id}/users": - get: - x-doc: - title: List all users for a project - category: User and usergroup - filename: get-projects-users.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add users to a project - category: User and usergroup - filename: post-projects-users.html - subcategory: - explorer: false - explorer: false - "/projects/{project_id}/users/{user_id}": - delete: - x-doc: - title: Remove a user from a project - category: User and usergroup - filename: delete-projects-users-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a user under a project - category: User and usergroup - filename: get-projects-users-.html - subcategory: - explorer: false - explorer: false - "/resourcegroups": - get: - x-doc: - title: List all resource groups - category: Resource and resourcegroup - filename: get-resourcegroups.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new resource group - category: Resource and resourcegroup - filename: post-resourcegroups.html - subcategory: - explorer: false - explorer: false - "/resourcegroups/{resourcegroup_id}": - delete: - x-doc: - title: Delete a resource group - category: Resource and resourcegroup - filename: delete-resourcegroups-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a resource group - category: Resource and resourcegroup - filename: get-resourcegroups-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a resource group - category: Resource and resourcegroup - filename: patch-resourcegroups-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify a resource group - category: Resource and resourcegroup - filename: put-resourcegroups-.html - subcategory: - explorer: false - explorer: false - "/resourcegroups/{resourcegroup_id}/bindings": - get: - x-doc: - title: List all bindings for a resource group - category: Binding - filename: get-resourcegroups-bindings.html - subcategory: - explorer: false - explorer: false - "/resourcegroups/{resourcegroup_id}/resources": - get: - x-doc: - title: List all resources for a resource group - category: Resource and resourcegroup - filename: get-resourcegroups-resources.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add resources to a resource group - category: Resource and resourcegroup - filename: post-resourcegroups-resources.html - subcategory: - explorer: false - explorer: false - "/resourcegroups/{resourcegroup_id}/resources/{resource_id}": - delete: - x-doc: - title: Remove a resource from a resource group - category: Resource and resourcegroup - filename: delete-resourcegroups-resources-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a resource in a resource group - category: Resource and resourcegroup - filename: get-resourcegroups-resources-.html - subcategory: - explorer: false - explorer: false - "/resources": - get: - x-doc: - title: List all resources - category: Resource and resourcegroup - filename: get-resources.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new resource - category: Resource and resourcegroup - filename: post-resources.html - subcategory: - explorer: false - explorer: false - "/resources/{resource_id}": - delete: - x-doc: - title: Delete a resource - category: Resource and resourcegroup - filename: delete-resources-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a resource - category: Resource and resourcegroup - filename: get-resources-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a resource - category: Resource and resourcegroup - filename: patch-resources-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify a resource - category: Resource and resourcegroup - filename: put-resources-.html - subcategory: - explorer: false - explorer: false - "/resources/{resource_id}/bindings": - get: - x-doc: - title: List all bindings for a resource - category: Binding - filename: get-resources-bindings.html - subcategory: - explorer: false - explorer: false - "/resources/{resource_id}/permissions": - get: - x-doc: - title: List all permissions for a resource - category: Permission - filename: get-resources-permissions.html - subcategory: - explorer: false - explorer: false - "/resources/{resource_id}/users": - get: - x-doc: - title: List all users with permissions for a resource - category: User and usergroup - filename: get-resources-users.html - subcategory: - explorer: false - explorer: false - "/resources/{resource_id}/permissions/{permission_id}/users": - get: - x-doc: - title: List all users with a specific permission for a resource - category: User and usergroup - filename: get-resources-permissions-users.html - subcategory: - explorer: false - explorer: false - "/resourcetypes": - get: - x-doc: - title: List all resource types - category: Resource and resourcegroup - filename: get-resourcetypes.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new resource type - category: Resource and resourcegroup - filename: post-resourcetypes.html - subcategory: - explorer: false - explorer: false - "/resourcetypes/{resourcetype_id}": - get: - x-doc: - title: Retrieve a resource type - category: Resource and resourcegroup - filename: get-resourcetypes-.html - subcategory: - explorer: false - explorer: false - "/roles": - get: - x-doc: - title: List all roles - category: Role - filename: get-roles.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new role - category: Role - filename: post-roles.html - subcategory: - explorer: false - explorer: false - "/roles/{role_id}": - delete: - x-doc: - title: Delete a role - category: Role - filename: delete-roles-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a role - category: Role - filename: get-roles-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a role resource partially - category: Role - filename: patch-roles-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify a role resource - category: Role - filename: put-roles-.html - subcategory: - explorer: false - explorer: false - "/roles/{role_id}/bindings": - get: - x-doc: - title: List all bindings for a role - category: Binding - filename: get-roles-bindings.html - subcategory: - explorer: false - explorer: false - "/roles/{role_id}/permissions": - get: - x-doc: - title: List all permissions for a role - category: Permission - filename: get-roles-permissions.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add a list of permissions to a role - category: Permission - filename: post-roles-permissions.html - subcategory: - explorer: false - explorer: false - "/roles/{role_id}/permissions/{permission_id}": - delete: - x-doc: - title: Delete a permission for a role - category: Permission - filename: delete-roles-permissions-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a permission for a role - category: Permission - filename: get-roles-permissions-.html - subcategory: - explorer: false - explorer: false - "/tags": - get: - x-doc: - title: List all the tag resources - category: Tag - filename: get-tags.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new tag resource - category: Tag - filename: post-tags.html - subcategory: - explorer: false - explorer: false - "/tags/{tag_id}": - delete: - x-doc: - title: Delete a tag resource - category: Tag - filename: delete-tags-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a tag resource - category: Tag - filename: get-tags-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a tag resource partially - category: Tag - filename: patch-tags-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify a tag resource - category: Tag - filename: put-tags-.html - subcategory: - explorer: false - explorer: false - "/usergroups": - get: - x-doc: - title: List all user groups - category: User and usergroup - filename: get-usergroups.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new user group - category: User and usergroup - filename: post-usergroups.html - subcategory: - explorer: false - explorer: false - "/usergroups/{usergroup_id}": - delete: - x-doc: - title: Delete a user group - category: User and usergroup - filename: delete-usergroups-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a user group - category: User and usergroup - filename: get-usergroups-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a user group partially - category: User and usergroup - filename: patch-usergroups-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify a user group - category: User and usergroup - filename: put-usergroups-.html - subcategory: - explorer: false - explorer: false - "/usergroups/{usergroup_id}/bindings": - get: - x-doc: - title: List all bindings for a user group - category: Binding - filename: get-usergroups-bindings.html - subcategory: - explorer: false - explorer: false - "/usergroups/{usergroup_id}/users": - get: - x-doc: - title: List all users for a user group - category: User and usergroup - filename: get-usergroups-users.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Add users to a user group - category: User and usergroup - filename: post-usergroups-users.html - subcategory: - explorer: false - explorer: false - "/usergroups/{usergroup_id}/users/{user_id}": - delete: - x-doc: - title: Remove a user from a user group - category: User and usergroup - filename: delete-usergroups-users-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a user in a user group - category: User and usergroup - filename: get-usergroups-users-.html - subcategory: - explorer: false - explorer: false - "/users": - get: - x-doc: - title: List all users - category: User and usergroup - filename: get-users.html - subcategory: - explorer: false - explorer: false - post: - x-doc: - title: Create a new user - category: User and usergroup - filename: post-users.html - subcategory: - explorer: false - explorer: false - "/users/{user_id}": - delete: - x-doc: - title: Delete a user - category: User and usergroup - filename: delete-users-.html - subcategory: - explorer: false - explorer: false - get: - x-doc: - title: Retrieve a user - category: User and usergroup - filename: get-users-.html - subcategory: - explorer: false - explorer: false - patch: - x-doc: - title: Update a user partially - category: User and usergroup - filename: patch-users-.html - subcategory: - explorer: false - explorer: false - put: - x-doc: - title: Modify a user - category: User and usergroup - filename: put-users-.html - subcategory: - explorer: false - explorer: false - "/users/{user_id}/bindings": - get: - x-doc: - title: List all bindings for a user - category: Binding - filename: get-users-bindings.html - subcategory: - explorer: false - explorer: false - "/users/{user_id}/permissions": - get: - x-doc: - title: List all permissions for a user - category: Permission - filename: get-users-permissions.html - subcategory: - explorer: false - explorer: false - "/users/{user_id}/permissions/{permission_id}/resources": - get: - x-doc: - title: List all resources for a user with a permission - category: Resource and resourcegroup - filename: get-users-permissions-resources.html - subcategory: - explorer: false - explorer: false - "/users/{user_id}/resources": - get: - x-doc: - title: List all resources for a user - category: Resource and resourcegroup - filename: get-users-resources.html - subcategory: - explorer: false - explorer: false - "/users/{user_id}/resources/{resource_id}": - get: - x-doc: - title: Check if a user has permission for a resource - category: Resource and resourcegroup - filename: get-users-resources-.html - subcategory: - explorer: false - explorer: false - "/users/{user_id}/resources/{resource_id}/permissions": - get: - x-doc: - title: List all permissions a user has for a resource - category: Permission - filename: get-users-resources-permissions.html - subcategory: - explorer: false - explorer: false - "/users/{user_id}/resources/{resource_id}/permissions/{permission_id}": - get: - x-doc: - title: Retrieve a permission on a resource for a user - category: Permission - filename: get-users-resources-permissions-.html - subcategory: - explorer: false - explorer: false - "/users/{user_id}/roles": - get: - x-doc: - title: List all the roles for a user - category: Role - filename: get-users-roles.html - subcategory: - explorer: false - explorer: false - resources/{resource_id}/permissions/{permission_id}/users: - get: - x-doc: - title: List all users that have a permission for a resource - category: User and usergroup - filename: getresources-permissions-users.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/roles/{role_id}/users": - post: - x-doc: - title: Associate a set of users for a folder with a role - category: User and usergroup - filename: post-folders-roles-users.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/roles/{role_id}/users/{user_id}": - delete: - x-doc: - title: Remove a user from a folder - category: User and usergroup - filename: delete-folders-roles-users-.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/roles/{role_id}/users/{user_id}": - delete: - x-doc: - title: Remove a user from an organization - category: User and usergroup - filename: delete-organizations-roles-users-.html - subcategory: - explorer: false - explorer: false - "/projects/{project_id}/roles/{role_id}/users": - post: - x-doc: - title: Associate a set of users to a project with a role - category: User and usergroup - filename: post-projects-roles-users.html - subcategory: - explorer: false - explorer: false - "/projects/{project_id}/roles/{role_id}/users/{user_id}": - delete: - x-doc: - title: Remove a user from a project - category: User and usergroup - filename: delete-projects-roles-users-.html - subcategory: - explorer: false - explorer: false - "/ui/organizations/{organization_id}/uihierarchy": - get: - x-doc: - title: Full organization hierarchy summary - category: UI - filename: get-ui-organizations-uihierarchy.html - subcategory: - explorer: false - explorer: false - "/ui/organizations/{organization_id}/uiresources": - get: - x-doc: - title: Lists scope/tags counts for a list of resources of an organization - category: UI - filename: get-ui-organizations-uiresources.html - subcategory: - explorer: false - explorer: false - "/ui/organizations/{organization_id}/users/{user_id}/uipermissions": - get: - x-doc: - title: Lists permissions for user on all resources - category: UI - filename: get-ui-organizations-users-uipermissions.html - subcategory: - explorer: false - explorer: false - "/ui/organizations/{organization_id}/users/{user_id}/uiroles": - get: - x-doc: - title: Lists roles for user on all hierarchy resources - category: UI - filename: get-ui-organizations-users-uiroles.html - subcategory: - explorer: false - explorer: false - "/organizations/{organization_id}/organizations/{childorganization_id}": - delete: - x-doc: - title: Remove a child organization from a parent organization - category: Hierarchy - filename: delete-organizations-organizations-.html - subcategory: - explorer: false - explorer: false - "/folders/{folder_id}/roles/{role_id}/usergroups": - post: - x-doc: - title: Create a new user group in a folder - category: User and Usergroup - filename: post-folders-roles-usergroups.html - subcategory: - explorer: false - "/organizations/{organization_id}/roles/{role_id}/usergroups": - post: - x-doc: - title: Create a new user group in an organization - category: User and Usergroup - filename: post-organizations-roles-usergroups.html - subcategory: - explorer: false - "/organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys": - get: - x-doc: - title: List all the public keys for a service account - category: User and Usergroup - filename: get-organizations-serviceaccounts-publickeys.html - subcategory: - explorer: false - post: - x-doc: - title: Create a public key for a service account - category: User and Usergroup - filename: post-organizations-serviceaccounts-publickeys.html - subcategory: - explorer: false - "/organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys/{publickey_id}": - delete: - x-doc: - title: Delete a public key for a service account - category: User and Usergroup - filename: delete-organizations-serviceaccounts-publickeys-.html - subcategory: - explorer: false - patch: - x-doc: - title: Partially update a public key for a service account - category: User and Usergroup - filename: patch-organizations-serviceaccounts-publickeys-.html - subcategory: - explorer: false - "/partnerships/{partnership_id}/grants": - get: - x-doc: - title: List all grants for a partnership - category: Partnership - filename: get-partnerships-grants.html - subcategory: - explorer: false - post: - x-doc: - title: Create a new grant - category: Partnership - filename: post-partnerships-grants.html - subcategory: - explorer: false - "/partnerships/{partnership_id}/grants/{grant_id}": - delete: - x-doc: - title: Delete a grant - category: Partnership - filename: delete-partnerships-grants-.html - subcategory: - explorer: false - get: - x-doc: - title: Retrieve a grant - category: Partnership - filename: get-partnerships-grants-.html - subcategory: - explorer: false - "/partnerships/{partnership_id}/grants/{grant_id}/resources": - get: - x-doc: - title: List all resources for a grant in a partnership - category: Resource and Resourcegroup - filename: get-partnerships-grants-resources.html - subcategory: - explorer: false - post: - x-doc: - title: Add resources to a grant in a partnership - category: Resource and Resourcegroup - filename: post-partnerships-grants-resources.html - subcategory: - explorer: false - "/partnerships/{partnership_id}/grants/{grant_id}/resources/{resource_id}": - delete: - x-doc: - title: Remove a resource from a grant in a partnership - category: Resource and Resourcegroup - filename: delete-partnerships-grants-resources-.html - subcategory: - explorer: false - get: - x-doc: - title: Retrieve a resource from a grant in a partnership - category: Resource and Resourcegroup - filename: get-partnerships-grants-resources-.html - subcategory: - explorer: false - "/partnerships/{partnership_id}/grants/{grant_id}/users": - get: - x-doc: - title: List all users for a grant in a partnership - category: User and Usergroup - filename: get-partnerships-grants-users.html - subcategory: - explorer: false - post: - x-doc: - title: Add users to a grant in a partnership - category: User and Usergroup - filename: post-partnerships-grants-users.html - subcategory: - explorer: false - "/partnerships/{partnership_id}/grants/{grant_id}/users/{user_id}": - delete: - x-doc: - title: Remove a user from a grant in a partnership - category: User and Usergroup - filename: delete-partnerships-grants-users-.html - subcategory: - explorer: false - get: - x-doc: - title: Retrieve a user with a grant in a partnership - category: User and Usergroup - filename: get-partnerships-grants-users-.html - subcategory: - explorer: false - "/partnerships/{partnership_id}/resourceadmins": - get: - x-doc: - title: List all users for a partnership - category: User and Usergroup - filename: get-partnerships-resourceadmins.html - subcategory: - explorer: false - post: - x-doc: - title: Add users with the ResourceAdmin role to a partnership - category: User and Usergroup - filename: post-partnerships-resourceadmins.html - subcategory: - explorer: false - "/partnerships/{partnership_id}/resourceadmins/{user_id}": - delete: - x-doc: - title: Remove a user from a partnership ResourceAdmin group - category: User and Usergroup - filename: delete-partnerships-resourceadmins-.html - subcategory: - explorer: false - get: - x-doc: - title: Retrieve a user in a partnership ResourceAdmin group - category: User and Usergroup - filename: get-partnerships-resourceadmins-.html - subcategory: - explorer: false - "/partnerships/{partnership_id}/useradmins": - get: - x-doc: - title: List all users with the UserAdmin role in a partnership - category: User and Usergroup - filename: get-partnerships-useradmins.html - subcategory: - explorer: false - post: - x-doc: - title: Add users to the UserAdmin role in a partnership - category: User and Usergroup - filename: post-partnerships-useradmins.html - subcategory: - explorer: false - "/partnerships/{partnership_id}/useradmins/{user_id}": - delete: - x-doc: - title: Remove a user from the UserAdmin group in a partnership - category: User and Usergroup - filename: delete-partnerships-useradmins-.html - subcategory: - explorer: false - get: - x-doc: - title: Retrieve a user in the UserAdmin group in a partnership - category: User and Usergroup - filename: get-partnerships-useradmins-.html - subcategory: - explorer: false - "/partnerships/{partnership_id}/users": - get: - x-doc: - title: List all users for a partnership - category: User and Usergroup - filename: get-partnerships-users.html - subcategory: - explorer: false - post: - x-doc: - title: Add users to a partnership - category: User and Usergroup - filename: post-partnerships-users.html - subcategory: - explorer: false - "/partnerships/{partnership_id}/users/{user_id}": - delete: - x-doc: - title: Remove a user from a partnership - category: User and Usergroup - filename: delete-partnerships-users-.html - subcategory: - explorer: false - get: - x-doc: - title: Retrieve a user in a partnership - category: User and Usergroup - filename: get-partnerships-users-.html - subcategory: - explorer: false - "/projects/{project_id}/roles/{role_id}/usergroups": - post: - x-doc: - title: Create a new user group in a project - category: User and Usergroup - filename: post-projects-roles-usergroups.html - subcategory: - explorer: false - "/resources/{resource_id}/permissions/{permission_id}/users/{user_id}": - get: - x-doc: - title: Retrieve a user with a permission for a resource - category: User and Usergroup - filename: get-resources-permissions-users-.html - subcategory: - explorer: false - "/users/{user_id}/partnerOrganizations": - get: - x-doc: - title: List all partnership organizations for the specified user - category: Resource and Resourcegroup - filename: get-users-partnerorganizations.html - subcategory: - explorer: false - "/users/{user_id}/permissions/{permission_id}/resources/{resource_id}": - get: - x-doc: - title: Retrieve a resource for a user with a permission - category: Resource and Resourcegroup - filename: get-users-permissions-resources-.html - subcategory: - explorer: false -categories: -- id: partnership - title: Partnership endpoints in the identity and access management REST API for the NetApp Console - permalink: partnership_overview.html -- id: resource and resourcegroup - title: Resource and resourcegroup endpoints in the identity and access management REST API for the NetApp Console - permalink: resource_and_resourcegroup_overview.html -- id: permission - title: Permission endpoints in the identity and access management REST API for the NetApp Console - permalink: permission_overview.html -- id: role - title: Role endpoints in the identity and access management REST API for the NetApp Console - permalink: role_overview.html -- id: hierarchy - title: Hierarchy endpoints in the identity and access management REST API for the NetApp Console - permalink: hierarchy_overview.html -- id: user and usergroup - title: User and usergroup endpoints in the identity and access management REST API for the NetApp Console - permalink: user_and_usergroup_overview.html \ No newline at end of file diff --git a/tenancyv4/tenancyv4.yaml b/tenancyv4/tenancyv4.yaml deleted file mode 100644 index 6a56460b..00000000 --- a/tenancyv4/tenancyv4.yaml +++ /dev/null @@ -1,14874 +0,0 @@ -components: - parameters: - continue: - description: |- - Indicates the token to resume from when listing a collection. - - - URL examples: "continue=[Continue Token from Collection Metadata]" - - - OpenAPI examples: "[Continue Token from Collection Metadata]" - in: query - name: continue - schema: - $ref: '#/components/schemas/query_continue' - count: - description: |- - Indicates if the total number of resources should be returned in the response object. - - - URL examples: "count=true" - - - OpenAPI examples: "true" - in: query - name: count - schema: - $ref: '#/components/schemas/query_count' - filter: - description: |- - Specifies which fields should be matched in order to return a resource when listing a collection. - - - Supported operators: - * eq - Equality - * lt/gt - Less than/greater than - * lte/gte - Less than or equal to/greater than or equal to - - - URL example: "filter=field%20eq%20%27value%27" - - - OpenAPI examples: "field eq 'value'" - in: query - name: filter - schema: - $ref: '#/components/schemas/query_filter' - include: - description: |- - Specifies which fields should be returned when listing a collection. - - - URL examples: "include=id", "include=id,name" - - - OpenAPI examples: "id" - in: query - name: include - schema: - $ref: '#/components/schemas/query_include' - limit: - description: |- - Specifies the maximum number of resources to return when listing a collection. - - - URL examples: "limit=2" - - - OpenAPI examples: "2" - in: query - name: limit - schema: - $ref: '#/components/schemas/query_limit' - order_by: - description: |- - Indicates the sort order of resources when listing a collection. - - - URL examples: "orderBy=name", "orderBy=name%20desc" - - - OpenAPI examples: "name desc" - in: query - name: orderBy - schema: - $ref: '#/components/schemas/query_order_by' - skip: - description: |- - Specifies the number of resources to skip when listing a collection. - - - URL examples: "skip=1" - - - OpenAPI examples: "1" - in: query - name: skip - schema: - $ref: '#/components/schemas/query_skip' - responses: - 400BadRequest: - content: - application/vnd.netapp.bxp.problem+json: - example: - detail: The supplied query parameters are invalid. - status: "400" - title: Invalid query parameters - type: https://bluexp.netapp.io/problems/1 - schema: - $ref: '#/components/schemas/type_bxp_problem_detail' - description: Bad Request - 401Unauthorized: - content: - application/vnd.netapp.bxp.problem+json: - example: - detail: The request is missing the required bearer token. - status: "401" - title: Missing bearer token - type: https://bluexp.netapp.io/problems/1 - schema: - $ref: '#/components/schemas/type_bxp_problem_detail' - description: Unauthorized - 403Forbidden: - content: - application/vnd.netapp.bxp.problem+json: - example: - detail: The requested operation isn't permitted. - status: "403" - title: Operation not permitted - type: https://bluexp.netapp.io/problems/11 - schema: - $ref: '#/components/schemas/type_bxp_problem_detail' - description: Forbidden - 404NotFound: - content: - application/vnd.netapp.bxp.problem+json: - example: - detail: The collection specified in the request URI wasn't found. - status: "404" - title: Collection not found - type: https://bluexp.netapp.io/problems/2 - schema: - $ref: '#/components/schemas/type_bxp_problem_detail' - description: Not Found - 409Conflict: - content: - application/vnd.netapp.bxp.problem+json: - example: - detail: The request body JSON contains a field that conflicts with an idempotent value. - status: "409" - title: JSON resource conflict - type: https://bluexp.netapp.io/problems/10 - schema: - $ref: '#/components/schemas/type_bxp_problem_detail' - description: Conflict - schemas: - binding_1.0_get_response_body: - properties: - description: - description: |- - JSON string containing the description of the binding. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: Association between Acme Users, Acme resources and Admin Role - maxLength: 300 - minLength: 1 - type: string - expiration_date: - description: Date and time. Represents an expiration date for the binding's temporary assignment to Principals/Roles/Resources. - format: date-time - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - ownerOrganizationId: - description: JSON string containing the id of the Organization - format: uuid - type: string - permissions: - description: JSON array of tags (name/value pairs) representing permissions metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - principals: - description: JSON array of tags (name/value pairs) representing users and user groups metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - resources: - description: JSON array of tags (name/value pairs) representing resources and resource groups metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - tags: - description: JSON array of tags (name/value pairs) representing metadata for the resource. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.binding" - enum: - - application/vnd.netapp.bxp.binding - example: application/vnd.netapp.bxp.binding - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - principals - - permissions - - resources - - description - - ownerOrganizationId - type: object - binding_1.0_list_response_body: - properties: - continue: - format: uuid - type: string - count: - type: int - items: - items: - $ref: '#/components/schemas/binding_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - binding_1.0_patch_request_body: - properties: - description: - description: |- - JSON string containing the binding name (for example: "system", "volumes", ...). - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: system - maxLength: 300 - minLength: 1 - type: string - expiration_date: - description: Date and time. Represents an expiration date for the binding's temporary assignment to Principals/Roles/Resources. - format: date-time - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - permissions: - description: JSON array of tags (name/value pairs) representing permissions metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - principals: - description: JSON array of tags (name/value pairs) representing users and user groups metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - resources: - description: JSON array of tags (name/value pairs) representing resources and resource groups metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - tags: - description: JSON array of tags (name/value pairs) representing metadata for the resource. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.binding" - enum: - - application/vnd.netapp.bxp.binding - example: application/vnd.netapp.bxp.binding - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - binding_1.0_post_request_body: - properties: - description: - description: |- - JSON string containing the binding name (for example: "Storage Admin access to Acme systems", ...). - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: system - maxLength: 300 - minLength: 1 - type: string - expiration_date: - description: Date and time. Represents an expiration date for the binding's temporary assignment to Principals/Roles/Resources. - format: date-time - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - ownerOrganizationId: - description: JSON string containing the id of the Organization - format: uuid - type: string - permissions: - description: JSON array of tags (name/value pairs) representing permissions metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - principals: - description: JSON array of tags (name/value pairs) representing users and user groups metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - resources: - description: JSON array of tags (name/value pairs) representing resources and resource groups metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - tags: - description: JSON array of tags (name/value pairs) representing metadata for the resource. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.binding" - enum: - - application/vnd.netapp.bxp.binding - example: application/vnd.netapp.bxp.binding - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - principals - - permissions - - resources - - ownerOrganizationId - type: object - binding_1.0_post_response_body: - properties: - description: - description: |- - JSON string containing the binding name (for example: "system", "volumes", ...). - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: system - maxLength: 300 - minLength: 1 - type: string - expiration_date: - description: Date and time. Represents an expiration date for the binding's temporary assignment to Principals/Roles/Resources. - format: date-time - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - ownerOrganizationId: - description: JSON string containing the id of the Organization - format: uuid - type: string - permissions: - description: JSON array of tags (name/value pairs) representing permissions metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - principals: - description: JSON array of tags (name/value pairs) representing users and user groups metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - resources: - description: JSON array of tags (name/value pairs) representing resources and resource groups metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - tags: - description: JSON array of tags (name/value pairs) representing metadata for the resource. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.binding" - enum: - - application/vnd.netapp.bxp.binding - example: application/vnd.netapp.bxp.binding - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - description - - principals - - permissions - - resources - - metadata - - ownerOrganizationId - type: object - binding_1.0_put_request_body: - properties: - description: - description: |- - JSON string containing the binding name (for example: "system", "volumes", ...). - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: system - maxLength: 300 - minLength: 1 - type: string - expiration_date: - description: Date and time. Represents an expiration date for the binding's temporary assignment to Principals/Roles/Resources. - format: date-time - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - ownerOrganizationId: - description: JSON string containing the id of the Organization - format: uuid - type: string - permissions: - description: JSON array of tags (name/value pairs) representing permissions metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - principals: - description: JSON array of tags (name/value pairs) representing users and user groups metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - resources: - description: JSON array of tags (name/value pairs) representing resource and resource group metadata to add to this binding. - items: - additionalProperties: - type: string - type: object - type: array - tags: - description: 'description: JSON array of tags (name/value pairs) representing metadata for the resource.' - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.binding" - enum: - - application/vnd.netapp.bxp.binding - example: application/vnd.netapp.bxp.binding - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - principals - - permissions - - resources - - ownerOrganizationId - type: object - cache_1.0_get_response_body: - additionalProperties: false - properties: - cacheField: - description: JSON string containing the field to cache. - example: rawId - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - organizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - permissionRule: - description: JSON string containing permission plain text representation. - example: bxp:asset-read - type: string - resourceClass: - description: JSON string containing the Resource Class of the objects stored in the cache. - type: string - resourceType: - description: JSON string containing the Resource Type of the objects stored in the cache. - type: string - state: - description: "JSON string containing the state of the cache. \nDefined values are:\n* LOADED\n* LOADING\n* EVICTING" - enum: - - LOADED - - LOADING - - EVICTING - example: LOADED - type: string - ttl: - description: JSON string containing the Time-To-Live duration in ISO-8601 format. - example: PT1M30S - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.cache" - enum: - - application/vnd.netapp.bxp.cache - example: application/vnd.netapp.bxp.cache - type: string - userId: - description: JSON string containing the ID of the user. - format: uuid - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - userId - - organizationId - - resourceType - - resourceClass - - permissionRule - - cacheField - - ttl - type: object - cache_1.0_list_response_body: - properties: - count: - type: int - items: - items: - $ref: '#/components/schemas/cache_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - cache_1.0_post_request_body: - additionalProperties: false - properties: - cacheField: - description: JSON string containing the field to cache. - example: rawId - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - organizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - permissionRule: - description: JSON string containing permission plain text representation. - example: bxp:asset-read - type: string - resourceClass: - description: JSON string containing the Resource Class of the objects stored in the cache. - type: string - resourceType: - description: JSON string containing the Resource Type of the objects stored in the cache. - type: string - ttl: - description: JSON string containing the Time-To-Live duration in ISO-8601 format. - example: PT1M30S - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.cache" - enum: - - application/vnd.netapp.bxp.cache - example: application/vnd.netapp.bxp.cache - type: string - userId: - description: JSON string containing the ID of the user. - format: uuid - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - userId - - organizationId - - resourceType - - resourceClass - - cacheField - - permissionRule - - ttl - type: object - cache_1.0_post_response_body: - additionalProperties: false - properties: - cacheField: - description: JSON string containing the field to cache. - example: rawId - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - organizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - permissionRule: - description: JSON string containing permission plain text representation. - example: bxp:asset-read - type: string - resourceClass: - description: JSON string containing the Resource Class of the objects stored in the cache. - type: string - resourceType: - description: JSON string containing the Resource Type of the objects stored in the cache. - type: string - state: - description: "JSON string containing the state of the cache. \nDefined values are:\n* LOADED\n* LOADING\n* EVICTING" - enum: - - LOADED - - LOADING - - EVICTING - example: LOADED - type: string - ttl: - description: JSON string containing the Time-To-Live duration in ISO-8601 format. - example: PT1M30S - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.cache" - enum: - - application/vnd.netapp.bxp.cache - example: application/vnd.netapp.bxp.cache - type: string - userId: - description: JSON string containing the ID of the user. - format: uuid - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - userId - - organizationId - - resourceType - - resourceClass - - permissionRule - - cacheField - - ttl - type: object - grant_1.0_get_extended_resource_response_body: - properties: - resourceClass: - description: JSON string containing the resource class. - type: string - resourceId: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - resourceName: - description: JSON string containing the resource name. - type: string - resourceType: - description: JSON string containing the resource type. - type: string - type: object - grant_1.0_get_extended_user_response_body: - properties: - lastLoginDate: - description: The date and time when the user last logged in. - example: "2026-06-24T16:25:08Z" - format: date-time - type: string - userEmail: - description: User email address. - example: email@acme.com - format: email - pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ - type: string - userId: - description: |- - Globally unique identifier of the user. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - userName: - description: JSON string containing the user name. - type: string - type: object - grant_1.0_get_response_body: - additionalProperties: false - properties: - description: - description: JSON string containing the description of the grant. - example: Partner Users managing the Dev pool - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - - * "false" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: JSON string containing the associated name. - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization that owns this resource. - format: uuid - type: string - resources: - items: - $ref: '#/components/schemas/grant_1.0_get_extended_resource_response_body' - type: array - uniqueItems: true - role: - description: JSON string containing the associated role ID. - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the resource. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.grant" - enum: - - application/vnd.netapp.bxp.grant - example: application/vnd.netapp.bxp.grant - type: string - users: - items: - $ref: '#/components/schemas/grant_1.0_get_extended_user_response_body' - type: array - uniqueItems: true - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - description - - role - - name - type: object - grant_1.0_list_response_body: - properties: - continue: - format: uuid - type: string - count: - type: int - items: - items: - $ref: '#/components/schemas/grant_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - grant_1.0_post_request_body: - additionalProperties: false - properties: - description: - description: JSON string containing the description of the grant. - example: Partner Users managing the Dev pool - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - - * "false" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the grant. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: ScopeAdminGrant - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization that owns the resource. - format: uuid - type: string - resources: - description: JSON array of resource UUIDs. - items: - format: uuid - type: string - type: array - uniqueItems: true - role: - description: JSON string containing the associated role ID. - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the resource. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.grant - enum: - - application/vnd.netapp.bxp.grant - example: application/vnd.netapp.bxp.grant - type: string - userGroupId: - description: JSON string containing the UserGroupId. If the userGroupId is specified there should be no users specified in this API request body. - type: string - users: - description: JSON array of users. - items: - properties: - aadId: - type: string - auth0Id: - type: string - emailId: - format: email - pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ - type: string - userId: - format: uuid - type: string - type: object - type: array - uniqueItems: true - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - role - - ownerOrganizationId - - name - type: object - grant_1.0_post_response_body: - additionalProperties: false - properties: - description: - description: JSON string containing the description of the grant. - example: Partner Users managing the Dev pool - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - - * "false" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: JSON string containing the associated name. - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - role: - description: JSON string containing the associated role ID. - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the resource. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.grant" - enum: - - application/vnd.netapp.bxp.grant - example: application/vnd.netapp.bxp.grant - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - metadata - - ownerOrganizationId - - role - - name - type: object - hierarchycounts_1.0_get_response_body: - additionalProperties: false - properties: - ancestors: - description: Comma-separated list of parent chain IDs of the hierarchy element. Each ID is a UUID. - example: 000a3f38-d4fa-5b62-a391-a69029758d32,012a3f38-d4fa-5b62-a391-a69029758d32,666a3f38-d4fa-5b62-a391-a69029758d32 - type: string - id: - description: |- - Globally unique identifier of the hierarchy element. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - parentId: - description: |- - Globally unique identifier of the hierarchy element parent. Null if no parent (top of the hierarchy) exists. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - resourceClass: - description: JSON string containing the resource class of the hierarchy element. This should be "hierarchy". - example: hierarchy - type: string - resourceCount: - description: JSON string containing number of resources contained in the hierarchy element. - example: 3 - type: string - resourceType: - description: JSON string containing the resource type of the hierarchy element. This value can be "folder", "organization", or "project". - enum: - - organization - - folder - - project - example: project - type: string - userCount: - description: JSON string containing the number of users contained in the hierarchy element. - example: 2 - type: string - required: - - id - - ancestors - - parentId - - resourceType - - resourceClass - - userCount - - resourceCount - type: object - hierarchycounts_1.0_list_response_body: - additionalProperties: false - properties: - count: - type: int - items: - items: - $ref: '#/components/schemas/hierarchycounts_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - organization_1.0_patch_request_body: - properties: - safeMode: - description: Used to patch an organization to safeMode. Specify as true or false to set organization to safeMode or not. - enum: - - "true" - - "false" - example: "true" - type: string - required: - - safeMode - type: object - partnership_1.0_get_response_body: - additionalProperties: false - properties: - destinationOrganizationId: - description: The ID of the destination organization that shares its users. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - maxLength: 254 - minLength: 1 - type: string - destinationOrganizationName: - description: The name of the destination organization that shares its users. - example: Acme - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - initiatedUserEmail: - description: The email address of the user who initiated the partnership. - maxLength: 254 - minLength: 1 - type: string - initiatedUserName: - description: The name of the user who initiated the partnership. - maxLength: 254 - minLength: 1 - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - - * "false" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing the partnership name (for example: "Partnership between Acme and PopShop", ...). - Defined values are: - * Minimum length: 1 - * Maximum length: 254 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: Partnership between Acme and PopShop - maxLength: 254 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - partnershipType: - description: Type of partnership. - example: msp - maxLength: 254 - minLength: 1 - type: string - sourceOrganizationId: - description: The ID of the source organization that shares its resources. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - maxLength: 254 - minLength: 1 - type: string - sourceOrganizationName: - description: The name of the source organization that shares its resources. - example: NetApp - maxLength: 254 - minLength: 1 - type: string - state: - description: |- - State of this record. - Defined values are: - - * Minimum length: 1 - - * Maximum length: 254 - - Possible values are: - - * SOURCE_INITIATED - - * DESTINATION_INITIATED - - * APPROVED - - * REJECTED - - * HOLD - enum: - - SOURCE_INITIATED - - DESTINATION_INITIATED - - APPROVED - - REJECTED - - HOLD - example: SOURCE_INITIATED - maxLength: 254 - minLength: 1 - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for this partnership. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.partnership" - enum: - - application/vnd.netapp.bxp.partnership - example: application/vnd.netapp.bxp.partnership - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - - state - type: object - partnership_1.0_list_response_body: - properties: - continue: - format: uuid - type: string - count: - type: int - items: - items: - $ref: '#/components/schemas/partnership_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - partnership_1.0_patch_request_body: - additionalProperties: false - properties: - stateDesired: - description: |- - The state to which you want to move the resource. - Defined values are: - - * Minimum length: 1 - - * Maximum length: 254 - - Possible values are: - - * APPROVED - - * REJECTED - - * HOLD - enum: - - APPROVED - - REJECTED - - HOLD - example: APPROVED - maxLength: 254 - minLength: 1 - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.partnership" - enum: - - application/vnd.netapp.bxp.partnership - example: application/vnd.netapp.bxp.partnership - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - stateDesired - type: object - partnership_1.0_post_request_body: - additionalProperties: false - properties: - destinationOrganizationId: - description: The ID of the destination organization that shares its users. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - maxLength: 254 - minLength: 1 - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - - * "false" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing the partnership name (for example: "Partnership between Acme and PopShop", ...). - Defined values are: - * Minimum length: 1 - * Maximum length: 254 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: Partnership between Acme and PopShop - maxLength: 254 - minLength: 1 - type: string - partnershipType: - description: Type of partnership. - example: msp - maxLength: 254 - minLength: 1 - type: string - sourceOrganizationId: - description: The ID of the source organization that shares its resources. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - maxLength: 254 - minLength: 1 - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for this partnership. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.partnership" - enum: - - application/vnd.netapp.bxp.partnership - example: application/vnd.netapp.bxp.partnership - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - name - - sourceOrganizationId - - destinationOrganizationId - - partnershipType - type: object - partnership_1.0_post_response_body: - additionalProperties: false - properties: - destinationOrganizationId: - description: The ID of the destination organization that shares its users. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - - * "false" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing the partnership name (for example: "Partnership between Acme and PopShop", ...). - Defined values are: - * Minimum length: 1 - * Maximum length: 254 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: Partnership between Acme and PopShop - maxLength: 254 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - partnershipType: - description: Type of partnership. - example: msp - maxLength: 254 - minLength: 1 - type: string - sourceOrganizationId: - description: The ID of the source organization that shares its resources. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - maxLength: 254 - minLength: 1 - type: string - state: - description: |- - State of this record. - Defined values are: - - * Minimum length: 1 - - * Maximum length: 254 - - Possible values are: - - * SOURCE_INITIATED - - * DESTINATION_INITIATED - - * APPROVED - - * REJECTED - - * HOLD - enum: - - SOURCE_INITIATED - - DESTINATION_INITIATED - - APPROVED - - REJECTED - - HOLD - example: SOURCE_INITIATED - maxLength: 254 - minLength: 1 - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for this partnership. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.partnership" - enum: - - application/vnd.netapp.bxp.partnership - example: application/vnd.netapp.bxp.partnership - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - - metadata - - state - type: object - partnershiptype_1.0_get_response_body: - additionalProperties: false - properties: - allowOrganizationSwitch: - description: |- - JSON string indicating if users of this partnership can switch organizations. - Defined values are: - * true - * false - example: true - maxLength: 5 - minLength: 4 - type: string - description: - description: 'JSON string containing the description of the partnershipType Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: Added new partnershipType - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing the partnershipType name (for example: "reseller", "distributor", ...). - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: reseller - maxLength: 254 - minLength: 1 - type: string - roles: - description: JSON array of UUIDs. Represents the list of roles (by role ID) that are allowed to be used in this partnership type. - items: - format: uuid - type: string - type: array - tags: - description: JSON array of tags (name/value pairs) representing metadata for this partnershipType. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.partnershipType" - enum: - - application/vnd.netapp.bxp.partnershipType - example: application/vnd.netapp.bxp.partnershipType - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - type: object - partnershiptype_1.0_list_response_body: - properties: - continue: - format: uuid - type: string - count: - type: int - items: - items: - $ref: '#/components/schemas/partnershiptype_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - partnershiptype_1.0_patch_request_body: - additionalProperties: false - properties: - allowOrganizationSwitch: - description: |- - JSON string indicating if users of this partnership can switch organizations. - Defined values are: - * true - * false - example: true - maxLength: 5 - minLength: 4 - type: string - description: - description: 'JSON string containing the description of the partnershipType Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: Added new partnershipType - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing the partnershipType name (for example: "reseller", "distributor", ...). - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: reseller - maxLength: 254 - minLength: 1 - type: string - roles: - description: JSON array of UUIDs. Represents the list of roles (by role ID) that are allowed to be used in this partnership type. - items: - format: uuid - type: string - type: array - tags: - description: JSON array of tags (name/value pairs) representing metadata for this partnershipType. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.partnershipType" - enum: - - application/vnd.netapp.bxp.partnershipType - example: application/vnd.netapp.bxp.partnershipType - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - partnershiptype_1.0_post_request_body: - additionalProperties: false - properties: - allowOrganizationSwitch: - description: |- - JSON string indicating if users of this partnership can switch organizations. - Defined values are: - * true - * false - example: true - maxLength: 5 - minLength: 4 - type: string - description: - description: 'JSON string containing the description of the partnershipType Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: Added new partnershipType - maxLength: 254 - minLength: 1 - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing the partnershipType name (for example: "reseller", "distributor", ...). - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: reseller - maxLength: 254 - minLength: 1 - type: string - roles: - description: JSON array of UUIDs. Represents the list of roles (by role ID) that are allowed to be used in this partnership type. - items: - format: uuid - type: string - type: array - tags: - description: JSON array of tags (name/value pairs) representing metadata for this partnershipType. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.partnershipType" - enum: - - application/vnd.netapp.bxp.partnershipType - example: application/vnd.netapp.bxp.partnershipType - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - name - - roles - type: object - partnershiptype_1.0_post_response_body: - additionalProperties: false - properties: - allowOrganizationSwitch: - description: |- - JSON string indicating if users of this partnership can switch organizations. - Defined values are: - * true - * false - example: true - maxLength: 5 - minLength: 4 - type: string - description: - description: 'JSON string containing the description of the partnershipType Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: Added new partnershipType - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing the partnershipType name (for example: "reseller", "distributor", ...). - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: reseller - maxLength: 254 - minLength: 1 - type: string - roles: - description: JSON array of UUIDs. Represents the list of roles (by role ID) that are allowed to be used in this partnership type. - items: - format: uuid - type: string - type: array - tags: - description: JSON array of tags (name/value pairs) representing metadata for this partnershipType. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.partnershipType" - enum: - - application/vnd.netapp.bxp.partnershipType - example: application/vnd.netapp.bxp.partnershipType - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - - metadata - type: object - partnershiptype_1.0_put_request_body: - additionalProperties: false - properties: - allowOrganizationSwitch: - description: |- - JSON string indicating if users of this partnership can switch organizations. - Defined values are: - * true - * false - example: true - maxLength: 5 - minLength: 4 - type: string - description: - description: 'JSON string containing the description of the partnershipType Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: Added new partnershipType - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing the partnershipType name (for example: "reseller", "distributor", ...). - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: reseller - maxLength: 254 - minLength: 1 - type: string - roles: - description: JSON array of UUIDs. Represents the list of roles (by role ID) that are allowed to be used in this partnership type. - items: - format: uuid - type: string - type: array - tags: - description: JSON array of tags (name/value pairs) representing metadata for this partnershipType. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.partnershipType" - enum: - - application/vnd.netapp.bxp.partnershipType - example: application/vnd.netapp.bxp.partnershipType - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - name - - roles - - id - type: object - permission_1.0_get_response_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of the permission. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: Added a permission which allow user to read in aiq - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - rule: - description: |- - JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: aiq:system-read - maxLength: 254 - minLength: 1 - type: string - service_application: - description: JSON string containing the serviceApplication associated with this permission. - example: aiq - maxLength: 50 - minLength: 1 - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the permission. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.permission" - enum: - - application/vnd.netapp.bxp.permission - example: application/vnd.netapp.bxp.permission - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - rule - - service_application - type: object - permission_1.0_list_response_body: - properties: - continue: - format: uuid - type: string - count: - type: int - items: - items: - anyOf: - - $ref: '#/components/schemas/permission_1.0_get_response_body' - - type: array - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - permission_1.0_patch_request_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of the permission. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: Added a permission which allow user to read in aiq - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - rule: - description: |- - JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: aiq:system-read - maxLength: 254 - minLength: 1 - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the permission. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.permission" - enum: - - application/vnd.netapp.bxp.permission - example: application/vnd.netapp.bxp.permission - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - permission_1.0_post_bulk_id_request_body: - properties: - permissions: - description: JSON array of permission UUIDs. - items: - format: uuid - type: string - type: array - uniqueItems: true - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.permissionbulk" - enum: - - application/vnd.netapp.bxp.permissionbulk - example: application/vnd.netapp.bxp.permissionbulk - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - permissions - type: object - permission_1.0_post_request_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of the permission. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: Added a permission which allow user to read in aiq - maxLength: 254 - minLength: 1 - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - rule: - description: |- - JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. - Defined values are: - * Minimum length: 1 - * Maximum length: 254 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: aiq:system-read - maxLength: 254 - minLength: 1 - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the permission. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.permission" - enum: - - application/vnd.netapp.bxp.permission - example: application/vnd.netapp.bxp.permission - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - rule - type: object - permission_1.0_post_response_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of the permission. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: Added a permission which allow user to read in aiq - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - rule: - description: |- - JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: aiq:system-read - maxLength: 254 - minLength: 1 - type: string - serviceApplication: - description: JSON string containing the serviceApplication associated with this permission. - example: aiq - maxLength: 50 - minLength: 1 - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the permission. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.permission" - enum: - - application/vnd.netapp.bxp.permission - example: application/vnd.netapp.bxp.permission - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - rule - - serviceApplication - - tags - - metadata - type: object - permission_1.0_put_request_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of the permission. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: Added a permission which allow user to read in aiq - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - rule: - description: |- - JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]]. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: aiq:system-read - maxLength: 254 - minLength: 1 - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the permission. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.permission" - enum: - - application/vnd.netapp.bxp.permission - example: application/vnd.netapp.bxp.permission - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - rule - type: object - query_continue: - description: Format of the continue query parameter. - pattern: ^([A-Za-z0-9+/]{4})*(([A-Za-z0-9+/]{2})==|([A-Za-z0-9+/]{3})=)?$ - type: string - x-common: true - query_count: - description: Format of the count query parameter. - pattern: ^true$ - type: string - x-common: true - query_filter: - description: Format of the filter query parameter. - pattern: ^(([0-9a-zA-Z]+(\[\*\])?)((\.[0-9a-zA-Z]+(\[\*\])?)+)? (eq|lt|gt|lte|gte|in) '([0-9a-zA-Z.,-_:@ {}\"])+')(,(\1))*$ - type: string - x-common: true - query_include: - description: Format of the include query parameter. - pattern: ^([0-9a-zA-Z]+)(,[0-9a-zA-Z]+)*$ - type: string - x-common: true - query_limit: - description: Format of the limit query parameter. - pattern: ^([1-9][0-9]*)$ - type: string - x-common: true - query_order_by: - description: Format of the order_by query parameter. - pattern: ^(([0-9a-zA-Z]+)( desc)?)$ - type: string - x-common: true - query_skip: - description: Format of the skip query parameter. - pattern: ^([1-9][0-9]*)$ - type: string - x-common: true - resource_1.0_get_response_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: Added a new resource of ResourceType volume - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyId: - description: Unique identifier as understood by the previous version of this service. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the resource. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: clusterA - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - parentId: - description: JSON string containing the ID of the hierarchy. - format: uuid - type: string - rawId: - description: JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. - maxLength: 400 - minLength: 1 - type: string - resourceClass: - description: JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. - type: string - resourceType: - description: JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. - type: string - state: - description: "Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process \nor available, which indicates the resources is currently available.\nDefined values are:\n* \"reconciling\"\n* \"available\"" - enum: - - reconciling - - available - example: reconciling - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the resource. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resource" - enum: - - application/vnd.netapp.bxp.resource - example: application/vnd.netapp.bxp.resource - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - - resourceType - - resourceClass - type: object - resource_1.0_list_response_body: - properties: - continue: - format: uuid - type: string - count: - type: int - items: - items: - $ref: '#/components/schemas/resource_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - resource_1.0_patch_request_body: - additionalProperties: false - properties: - description: - description: |- - JSON string containing the description of the resource. - Defined values are: - * Minimum length: 1 - * Maximum length: 254 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: Added a new resource of ResourceType volume - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyId: - description: Unique identifier as understood by the previous version of this service. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the resource. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: ClusterA - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - parentId: - description: JSON string containing the ID of the hierarchy. - format: uuid - type: string - rawId: - description: JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. - maxLength: 400 - minLength: 1 - type: string - resourceClass: - description: JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. - type: string - resourceType: - description: JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. - type: string - state: - description: "Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process \nor available, which indicates the resources is currently available.\nDefined values are:\n* \"reconciling\"\n* \"available\"" - enum: - - reconciling - - available - example: reconciling - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the resource. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resource" - enum: - - application/vnd.netapp.bxp.resource - example: application/vnd.netapp.bxp.resource - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - resource_1.0_post_bulk_id_request_body: - properties: - resources: - description: JSON array of resource UUIDs. - items: - format: uuid - type: string - type: array - uniqueItems: true - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resourcebulk" - enum: - - application/vnd.netapp.bxp.resourcebulk - example: application/vnd.netapp.bxp.resourcebulk - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - resources - type: object - resource_1.0_post_request_body: - additionalProperties: false - properties: - description: - description: |- - JSON string containing the description of the resource. - Defined values are: - * Minimum length: 1 - * Maximum length: 254 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: Added a new resource of ResourceType volume - maxLength: 254 - minLength: 1 - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the resource. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - parentId: - description: JSON string containing the ID of the hierarchy. - format: uuid - type: string - rawId: - description: JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. - maxLength: 400 - minLength: 1 - type: string - resourceClass: - description: JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. - type: string - resourceType: - description: JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the resource. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resource" - enum: - - application/vnd.netapp.bxp.resource - example: application/vnd.netapp.bxp.resource - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - name - - resourceType - - resourceClass - type: object - resource_1.0_post_response_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: Added a new resource of ResourceType volume - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyId: - description: Unique identifier as understood by the previous version of this service. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the resource. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - parentId: - description: JSON string containing the ID of the hierarchy. - format: uuid - type: string - rawId: - description: JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. - maxLength: 400 - minLength: 1 - type: string - resourceClass: - description: JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. - type: string - resourceType: - description: JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. - type: string - state: - description: "Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process \nor available, which indicates the resources is currently available.\nDefined values are:\n* \"reconciling\"\n* \"available\"" - enum: - - reconciling - - available - example: reconciling - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the resource. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resource" - enum: - - application/vnd.netapp.bxp.resource - example: application/vnd.netapp.bxp.resource - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - - metadata - - resourceType - - resourceClass - type: object - resource_1.0_put_request_body: - properties: - description: - description: |- - JSON string containing the description of the resource. - Defined values are: - * Minimum length: 1 - * Maximum length: 254 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: Added a new resource of ResourceType volume - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyId: - description: Unique identifier as understood by the previous version of this service. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the resource. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: ClusterA - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - parentId: - description: JSON string containing the ID of the hierarchy. - format: uuid - type: string - rawId: - description: JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control. - maxLength: 400 - minLength: 1 - type: string - resourceClass: - description: JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. - type: string - resourceType: - description: JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. - type: string - state: - description: "Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process \nor available, which indicates the resources is currently available.\nDefined values are:\n* \"reconciling\"\n* \"available\"" - enum: - - reconciling - - available - example: reconciling - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the resource. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resource" - enum: - - application/vnd.netapp.bxp.resource - example: application/vnd.netapp.bxp.resource - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - name - - resourceType - - resourceClass - type: object - resourcegroup_1.0_get_response_body: - properties: - description: - description: 'JSON string containing the description of this resource group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This resourcegroup is part of NetApp sales group - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the resource group. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for this resource group. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resourcegroup" - enum: - - application/vnd.netapp.bxp.resourcegroup - example: application/vnd.netapp.bxp.resourcegroup - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - - ownerOrganizationId - type: object - resourcegroup_1.0_list_response_body: - properties: - continue: - format: uuid - type: string - count: - type: int - items: - items: - $ref: '#/components/schemas/resourcegroup_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - resourcegroup_1.0_patch_request_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of this resource group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This resourcegroup is part of NetApp sales group - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the resource group. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for this resource group. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resourcegroup" - enum: - - application/vnd.netapp.bxp.resourcegroup - example: application/vnd.netapp.bxp.resourcegroup - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - resourcegroup_1.0_post_bulk_id_request_body: - additionalProperties: false - properties: - resourcegroups: - items: - properties: - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - name: - description: |- - JSON string containing a name for the resource group. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - type: object - type: array - uniqueItems: true - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resourcegroupbulk" - enum: - - application/vnd.netapp.bxp.resourcegroupbulk - example: application/vnd.netapp.bxp.resourcegroupbulk - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - resourcegroups - type: object - resourcegroup_1.0_post_request_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of this resource group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This resourcegroup is part of NetApp sales group - maxLength: 254 - minLength: 1 - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the resource group. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for this resource group. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resourcegroup" - enum: - - application/vnd.netapp.bxp.resourcegroup - example: application/vnd.netapp.bxp.resourcegroup - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - name - - ownerOrganizationId - type: object - resourcegroup_1.0_post_response_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of this resource group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This resourcegroup is part of NetApp sales group - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the resource group. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for this resource group. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resourcegroup" - enum: - - application/vnd.netapp.bxp.resourcegroup - example: application/vnd.netapp.bxp.resourcegroup - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - - metadata - - ownerOrganizationId - type: object - resourcegroup_1.0_put_request_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of this resource group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This resourcegroup is part of NetApp sales group - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the resourcegroup. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for this resource group. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resourcegroup" - enum: - - application/vnd.netapp.bxp.resourcegroup - example: application/vnd.netapp.bxp.resourcegroup - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - resourcescounts_1.0_get_response_body: - additionalProperties: false - properties: - id: - description: |- - Globally unique identifier of the hierarchy element. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - name: - description: |- - JSON string containing a name for the resource. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: Cluster1 - maxLength: 300 - minLength: 1 - type: string - resourceClass: - description: JSON string containing the resource class. This should be one of the allowed resource classes, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. - example: ON_PREM - type: string - resourceType: - description: JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. - example: ON_PREM - type: string - scopeCount: - description: JSON string containing the number of associated scopes (organizations, projects, folders). - example: 3 - type: string - tagCount: - description: JSON string containing the number of associated tags. - example: 4 - type: string - required: - - id - - name - - resourceType - - resourceClass - - scopeCount - - tagCount - type: object - resourcescounts_1.0_list_response_body: - additionalProperties: false - properties: - count: - type: int - items: - items: - $ref: '#/components/schemas/resourcescounts_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - resourcetype_1.0_get_response_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of this resourceType. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This represents a CVO instance in AWS - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyResourceClass: - description: |- - JSON string containing the legacy resource class (for example: "ON_PREM", "CAPACITY_BASED_LICENSE", ...) associated with the new resource class/type record. - If a resource class/type is new, the value for legacyResourceClass and legacyResourceType is null. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: ON_PREM - maxLength: 254 - minLength: 1 - type: string - legacyResourceType: - description: |- - JSON string containing the legacy resource type (for example: "ON_PREM", "AWS", ...) associated with the new resource class/type record. - If a resource class/type is new, the value for legacyResourceClass and legacyResourceType is null. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: AWS - maxLength: 254 - minLength: 1 - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - resourceClass: - description: |- - JSON string containing the resource class (for example: "internal", "license", ...). This is case-sensitive and should be provided in lowercase. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: system - maxLength: 254 - minLength: 1 - type: string - resourceType: - description: |- - JSON string containing the resource type under a resource class (for example: "capacity", "cluster", ...). This is case-sensitive and should be provided in lowercase. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: cluster - maxLength: 254 - minLength: 1 - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resourcetype" - enum: - - application/vnd.netapp.bxp.resourcetype - example: application/vnd.netapp.bxp.resourcetype - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - resourceClass - - resourceType - type: object - resourcetype_1.0_list_response_body: - properties: - continue: - format: uuid - type: string - count: - type: int - items: - items: - $ref: '#/components/schemas/resourcetype_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - resourcetype_1.0_patch_request_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of this resourceType. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This represents a CVO instance in Azure - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyResourceClass: - description: |- - JSON string containing the legacy resource class (for example: "ON_PREM", "CAPACITY_BASED_LICENSE", ...) associated with the new resource class/type record. - If a resource class/type is new, the value for legacyResourceClass and legacyResourceType is null. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: ON_PREM - maxLength: 254 - minLength: 1 - type: string - legacyResourceType: - description: |- - JSON string containing the legacy resource type (for example: "ON_PREM", "AWS", ...) associated with the new resource class/type record. - If a resource class/type is new, the value for legacyResourceClass and legacyResourceType is null. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: AWS - maxLength: 254 - minLength: 1 - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - resourceClass: - description: |- - JSON string containing the resource class (for example: "internal", "license", ...). This is case-sensitive and should be provided in lowercase. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: system - maxLength: 254 - minLength: 1 - type: string - resourceType: - description: |- - JSON string containing the resource type under a resource class (for example: "capacity", "cluster", ...). This is case-sensitive and should be provided in lowercase. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: cluster - maxLength: 254 - minLength: 1 - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resourcetype" - enum: - - application/vnd.netapp.bxp.resourcetype - example: application/vnd.netapp.bxp.resourcetype - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - resourcetype_1.0_post_request_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of this resourceType. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This represent a CVO instance in AWS - maxLength: 254 - minLength: 1 - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyResourceClass: - description: |- - JSON string containing the legacy resource class (for example: "ON_PREM", "CAPACITY_BASED_LICENSE", ...) associated with the new resource class/type record. - If a resource class/type is new, the value for legacyResourceClass and legacyResourceType is null. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: ON_PREM - maxLength: 254 - minLength: 1 - type: string - legacyResourceType: - description: |- - JSON string containing the legacy resource type (for example: "ON_PREM", "AWS", ...) associated with the new resource class/type record. - If a resource class/type is new, the value for legacyResourceClass and legacyResourceType is null. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: AWS - maxLength: 254 - minLength: 1 - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - resourceClass: - description: |- - JSON string containing the resource class (for example: "internal", "license", ...). This is case-sensitive and should be provided in lowercase. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: system - maxLength: 254 - minLength: 1 - type: string - resourceType: - description: |- - JSON string containing the resource type under a resource class (for example: "capacity", "cluster", ...). This is case-sensitive and should be provided in lowercase. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: cluster - maxLength: 254 - minLength: 1 - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resourcetype" - enum: - - application/vnd.netapp.bxp.resourcetype - example: application/vnd.netapp.bxp.resourcetype - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - resourceClass - - resourceType - - description - type: object - resourcetype_1.0_post_response_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of this resourceType. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: Added new resourceType - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyResourceClass: - description: |- - JSON string containing the legacy resource class (for example: "ON_PREM", "CAPACITY_BASED_LICENSE", ...) associated with the new resource class/type record. - If a resource class/type is new, the value for legacyResourceClass and legacyResourceType is null. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: ON_PREM - maxLength: 254 - minLength: 1 - type: string - legacyResourceType: - description: |- - JSON string containing the legacy resource type (for example: "ON_PREM", "AWS", ...) associated with the new resource class/type record. - If a resource class/type is new, the value for legacyResourceClass and legacyResourceType is null. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: AWS - maxLength: 254 - minLength: 1 - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - resourceClass: - description: |- - JSON string containing the resource class (for example: "internal", "license", ...). This is case-sensitive and should be provided in lowercase. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: system - maxLength: 254 - minLength: 1 - type: string - resourceType: - description: |- - JSON string containing the resource type under a resource class (for example: "capacity", "cluster", ...). This is case-sensitive and should be provided in lowercase. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: cluster - maxLength: 254 - minLength: 1 - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resourcetype" - enum: - - application/vnd.netapp.bxp.resourcetype - example: application/vnd.netapp.bxp.resourcetype - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - resourceClass - - resourceType - - metadata - type: object - resourcetype_1.0_put_request_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of this resourceType. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This represents a CVO instance in Azure - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyResourceClass: - description: |- - JSON string containing the legacy resource class (for example: "ON_PREM", "CAPACITY_BASED_LICENSE", ...) associated with the new resource class/type record. - If a resource class/type is new, the value for legacyResourceClass and legacyResourceType is null. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: ON_PREM - maxLength: 254 - minLength: 1 - type: string - legacyResourceType: - description: |- - JSON string containing the legacy resource type (for example: "ON_PREM", "AWS", ...) associated with the new resource class/type record. - If a resource class/type is new, the value for legacyResourceClass and legacyResourceType is null. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: AWS - maxLength: 254 - minLength: 1 - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - resourceClass: - description: |- - JSON string containing the resource class (for example: "internal", "license", ...). This is case-sensitive and should be provided in lowercase. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: system - maxLength: 254 - minLength: 1 - type: string - resourceType: - description: |- - JSON string containing the resource type under a resource class (for example: "capacity", "cluster", ...). This is case-sensitive and should be provided in lowercase. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: cluster - maxLength: 254 - minLength: 1 - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.resourcetype" - enum: - - application/vnd.netapp.bxp.resourcetype - example: application/vnd.netapp.bxp.resourcetype - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - resourceType - - resourceClass - type: object - role_1.0_get_response_body: - additionalProperties: false - properties: - category: - description: Specifies the classification of the role. - enum: - - IAM - - ONTAP-MEDIATOR - - SNAPCENTER - example: IAM - type: string - description: - description: 'JSON string containing the description of the role. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This role have alpha & beta permissions for NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isAgentRole: - description: |- - Specifies if the role can be used for a Agent. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isServiceAccountRole: - description: |- - Specifies if the role can be used for a Service Account. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isUserRole: - description: |- - Specifies if the role can be used for a User. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the role. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 63 - minLength: 1 - type: string - roleInternalName: - description: |- - JSON string containing a internal name for the role used by UI to validate role name changes. Value will be same as internalName in private field - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: ORGANIZATION_ADMIN - maxLength: 63 - minLength: 1 - type: string - roles: - description: Array containing the UUIDs of child roles. Each UUID in the array represents a role that is a child of the aggregate (parent) role. - example: - - 33475e47-e975-48db-936d-73c53d96450b - - 04779339-9192-462c-88ee-8df050ef06c8 - items: - format: uuid - type: string - type: array - uniqueItems: true - tags: - description: JSON array of tags (name/value pairs). - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.role" - enum: - - application/vnd.netapp.bxp.role - example: application/vnd.netapp.bxp.role - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - type: object - role_1.0_list_response_body: - properties: - continue: - format: uuid - type: string - count: - type: int - items: - items: - $ref: '#/components/schemas/role_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - role_1.0_patch_request_body: - additionalProperties: false - properties: - category: - description: Specifies the classification of the role. - enum: - - IAM - - ONTAP-MEDIATOR - - SNAPCENTER - example: IAM - type: string - description: - description: 'JSON string containing the description of the role. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This role have alpha & beta permissions for NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isAgentRole: - description: |- - Specifies if the role can be used for a Agent. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isServiceAccountRole: - description: |- - Specifies if the role can be used for a Service Account. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isUserRole: - description: |- - Specifies if the role can be used for a User. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the account. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 63 - minLength: 1 - type: string - roles: - description: Array containing the UUIDs of child roles. Each UUID in the array represents a role that is a child of the aggregate (parent) role. - example: - - 33475e47-e975-48db-936d-73c53d96450b - - 04779339-9192-462c-88ee-8df050ef06c8 - items: - format: uuid - type: string - type: array - uniqueItems: true - tags: - description: JSON array of tags (name/value pairs). - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.role" - enum: - - application/vnd.netapp.bxp.role - example: application/vnd.netapp.bxp.role - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - role_1.0_post_request_body: - additionalProperties: false - properties: - category: - description: Specifies the classification of the role. - enum: - - IAM - - ONTAP-MEDIATOR - - SNAPCENTER - example: IAM - type: string - description: - description: 'JSON string containing the description of the role. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This role have alpha & beta permissions for NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - isAgentRole: - description: |- - Specifies if the role can be used for a Agent. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isServiceAccountRole: - description: |- - Specifies if the role can be used for a Service Account. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isUserRole: - description: |- - Specifies if the role can be used for a User. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the role. - Defined values are: - * Minimum length: 1 * Maximum length: 63 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 63 - minLength: 1 - type: string - roles: - description: Array containing the UUIDs of child roles. Each UUID in the array represents a role that is a child of the aggregate (parent) role. - example: - - 33475e47-e975-48db-936d-73c53d96450b - - 04779339-9192-462c-88ee-8df050ef06c8 - items: - format: uuid - type: string - type: array - uniqueItems: true - tags: - description: JSON array of tags (name/value pairs). - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.role" - enum: - - application/vnd.netapp.bxp.role - example: application/vnd.netapp.bxp.role - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - name - type: object - role_1.0_post_response_body: - additionalProperties: false - properties: - category: - description: Specifies the classification of the role. - enum: - - IAM - - ONTAP-MEDIATOR - - SNAPCENTER - example: IAM - type: string - description: - description: 'JSON string containing the description of the role. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This role have alpha & beta permissions for NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isAgentRole: - description: |- - Specifies if the role can be used for a Agent. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isServiceAccountRole: - description: |- - Specifies if the role can be used for a Service Account. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isUserRole: - description: |- - Specifies if the role can be used for a User. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the role. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: Acme Co - maxLength: 63 - minLength: 1 - type: string - roleInternalName: - description: |- - JSON string containing a internal name for the role used by UI to validate role name changes. Value will be same as internalName in private field - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: ORGANIZATION_ADMIN - maxLength: 63 - minLength: 1 - type: string - roles: - description: Array containing the UUIDs of child roles. Each UUID in the array represents a role that is a child of the aggregate (parent) role. - example: - - 33475e47-e975-48db-936d-73c53d96450b - - 04779339-9192-462c-88ee-8df050ef06c8 - items: - format: uuid - type: string - type: array - uniqueItems: true - tags: - description: JSON array of tags (name/value pairs). - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.role" - enum: - - application/vnd.netapp.bxp.role - example: application/vnd.netapp.bxp.role - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - - tags - - metadata - type: object - role_1.0_put_request_body: - additionalProperties: false - properties: - category: - description: Specifies the classification of the role. - enum: - - IAM - - ONTAP-MEDIATOR - - SNAPCENTER - example: IAM - type: string - description: - description: 'JSON string containing the description of the role. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This role have alpha & beta permissions for NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isAgentRole: - description: |- - Specifies if the role can be used for a Agent. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isServiceAccountRole: - description: |- - Specifies if the role can be used for a Service Account. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - isUserRole: - description: |- - Specifies if the role can be used for a User. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the account. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 63 - minLength: 1 - type: string - roles: - description: Array containing the UUIDs of child roles. Each UUID in the array represents a role that is a child of the aggregate (parent) role. - example: - - 33475e47-e975-48db-936d-73c53d96450b - - 04779339-9192-462c-88ee-8df050ef06c8 - items: - format: uuid - type: string - type: array - uniqueItems: true - tags: - description: JSON array of tags (name/value pairs). - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.role" - enum: - - application/vnd.netapp.bxp.role - example: application/vnd.netapp.bxp.role - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - tag_1.0_get_response_body: - additionalProperties: false - properties: - collections: - description: Array of collections this tag can appear in - items: - type: string - type: array - description: - description: 'JSON string containing the description of the tag. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This tag represents NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing the name of the tag. - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: internal:aiq:salesTerritory - maxLength: 254 - minLength: 1 - type: string - service: - description: Service owning the tag - example: This Service represents NetApp Sales Territory tag - maxLength: 254 - minLength: 1 - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.tag" - enum: - - application/vnd.netapp.bxp.tag - example: application/vnd.netapp.bxp.tag - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - type: object - tag_1.0_list_response_body: - properties: - continue: - format: uuid - type: string - count: - type: int - items: - items: - anyOf: - - $ref: '#/components/schemas/tag_1.0_get_response_body' - - type: array - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - tag_1.0_patch_request_body: - additionalProperties: false - properties: - collections: - description: Array of collections this tag can appear in - items: - type: string - type: array - description: - description: 'JSON string containing the description of the tag. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This tag represents NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing name of the tag - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: internal:aiq:salesTerritory - maxLength: 254 - minLength: 1 - type: string - service: - description: Service owning the tag - example: This Service represents NetApp Sales Territory tag - maxLength: 254 - minLength: 1 - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.tag" - enum: - - application/vnd.netapp.bxp.tag - example: application/vnd.netapp.bxp.tag - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - tag_1.0_post_request_body: - additionalProperties: false - properties: - collections: - description: Array of collections this tag can appear in - items: - type: string - type: array - description: - description: 'JSON string containing the description of the tag. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This tag represents NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing name of the tag - Defined values are: - * Minimum length: 1 - * Maximum length: 254 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: internal:aiq:salesTerritory - maxLength: 254 - minLength: 1 - type: string - service: - description: Service owning the tag - example: This Service represents NetApp Sales Territory tag - maxLength: 254 - minLength: 1 - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.tag" - enum: - - application/vnd.netapp.bxp.tag - example: application/vnd.netapp.bxp.tag - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - name - type: object - tag_1.0_post_response_body: - additionalProperties: false - properties: - collections: - description: Array of collections this tag can appear in - items: - type: string - type: array - description: - description: 'JSON string containing the description of the tag. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This tag represents NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing name of the tag - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: internal:aiq:salesTerritory - maxLength: 254 - minLength: 1 - type: string - service: - description: Service owning the tag - example: This Service represents NetApp Sales Territory tag - maxLength: 254 - minLength: 1 - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.tag" - enum: - - application/vnd.netapp.bxp.tag - example: application/vnd.netapp.bxp.tag - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - - metadata - type: object - tag_1.0_put_request_body: - additionalProperties: false - properties: - collections: - description: Array of collections this tag can appear in - items: - type: string - type: array - description: - description: 'JSON string containing the description of the tag. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This tag represents NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing name of the tag - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: internal:aiq:salesTerritory - maxLength: 254 - minLength: 1 - type: string - service: - description: Service owning the tag - example: This Service represents NetApp Sales Territory tag - maxLength: 254 - minLength: 1 - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.tag" - enum: - - application/vnd.netapp.bxp.tag - example: application/vnd.netapp.bxp.tag - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - name - type: object - type_bxp_api_relative_uri: - description: String describing a relative URI. - pattern: ^(\/([-0-9a-zA-Z])+)+$ - type: string - x-common: true - type_bxp_identifier: - description: |- - JSON string containing a Resource ID. - Defined values are: * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - x-common: true - type_bxp_invalid_reason: - properties: - details: - description: | - The description of the invalid reasons. The possible values are: - 1. CERT_NOT_YET_VALID: The certificate is not yet valid. - 2. CERT_HOST_MISMATCH: The host name does not match the CN or subject alt name. - 3. CERT_WEAK_ENCRYPTION_KEY_SIZE: The certificate has weak encryption key size. - 4. CERT_CHAIN_BROKEN: The certificate chain is broken. - 5. CERT_INVALID_SIGNATURE: The certificate has an invalid signature. - 6. OTHER: Any other invalid reason. - example: Host name is not matching with CN or subject alt name - type: string - error: - description: The error enum value for the invalid certificate. - enum: - - CERT_NOT_YET_VALID - - CERT_HOST_MISMATCH - - CERT_WEAK_ENCRYPTION_KEY_SIZE - - CERT_CHAIN_BROKEN - - CERT_INVALID_SIGNATURE - - OTHER - example: CERT_HOST_MISMATCH - type: string - type: object - x-common: true - type_bxp_label: - description: Name/value pair. - example: - name: secure - value: "true" - properties: - name: - description: Name of the label. - type: string - value: - description: Value of the label. - type: string - required: - - name - - value - type: object - x-common: true - type_bxp_labels: - description: JSON Array of Name/value pairs. - example: - - name: secure - value: "true" - items: - $ref: '#/components/schemas/type_bxp_label' - type: array - uniqueItems: true - x-common: true - type_bxp_link: - description: Link relationship - properties: - hints: - properties: - accept-post: - description: Provides details about which media types are accepted when creating a resource. - type: object - accept-put: - description: Indicates details about what media types are accepted when updating a resource. - type: object - allow: - description: |- - An array of methods that can be used to interact with the link target. - - Defined values for collections: - - "POST" - Indicates if new resources can be created in the collection. - Defined values for resources: - - "PUT" - Indicates if the resource can be modified - "DELETE" - Indicates if the resource can be deleted - items: - enum: - - POST - - GET - - PUT - - DELETE - type: string - type: array - permissions: - description: List of the permissions required to use the link. - items: - pattern: ^([a-z]([a-zA-Z])*)(-[a-z]([a-zA-Z])*){1,2}$ - type: string - type: array - status: - description: |- - Indicates if the target of the link is deprecated. - - Defined values are: - - "deprecated" - enum: - - deprecated - type: string - type: object - href: - $ref: '#/components/schemas/type_bxp_api_relative_uri' - rel: - description: The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. - enum: - - self - - canonical - - collection - - up - - related - - service-doc - - service-desc - type: string - targetSchema: - description: |- - Link to a JSON schema that can be used to validate the target of the link (response body). - - The preferred format is a $ref link to an external schema. - - This field is optional and should only be included when there is a known schema for the target of the href. - - See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. - type: object - title: - description: |- - Label of a link such that it can be used as a human-readable identifier (e.g., a menu entry). - - Minimum length: 0 - Maximum length: 1023 - maxLength: 1023 - minLength: 1 - type: string - type: - description: |- - The media type of the target of the href. - - This field is optional and should be included when there is a known media type for the target of the href. - - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. - pattern: ^((application\/vnd\.netapp(\.(([a-z])([a-zA-Z0-9]){0,30})){1,3})(-v(([0-9]){1,3}))?)$ - type: string - required: - - rel - - href - type: object - x-common: true - type_bxp_links: - description: Array of link relationships associated with the resource or ID. - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - x-common: true - type_bxp_metadata: - description: Metadata associated with the resource. - properties: - createdBy: - description: UUID of the user who created the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - creationTimestamp: - description: Resource creation date. - example: "2022-10-06T20:58:16.305662Z" - format: date-time - type: string - labels: - description: Array of name/value pairs representing additional information for the resource. - items: - $ref: '#/components/schemas/type_bxp_label' - type: array - uniqueItems: true - modificationTimestamp: - description: Resource modification date. - example: "2022-10-06T20:58:16.305662Z" - format: date-time - type: string - modifiedBy: - description: UUID of the user who modified the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - type: object - x-common: true - type_bxp_metadata_list: - description: Metadata associated with a list of resources. - properties: - count: - type: number - createdBy: - description: UUID of the user who created the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - creationTimestamp: - description: Resource creation date. - example: "2022-10-06T20:58:16.305662Z" - format: date-time - type: string - labels: - description: Array of name/value pairs representing additional information for the resource. - items: - $ref: '#/components/schemas/type_bxp_label' - type: array - uniqueItems: true - modificationTimestamp: - description: Resource modification date. - example: "2022-10-06T20:58:16.305662Z" - format: date-time - type: string - modifiedBy: - description: UUID of the user who modified the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - type: object - x-common: true - type_bxp_metadata_update: - description: Metadata associated to an updated resource. - properties: - createdBy: - description: UUID of the user who created the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - creationTimestamp: - description: Resource creation date. - example: "2022-10-06T20:58:16.305662Z" - format: date-time - type: string - labels: - description: Array of name/value pairs representing additional information for the resource. - items: - $ref: '#/components/schemas/type_bxp_label' - type: array - uniqueItems: true - modificationTimestamp: - description: Resource modification date. - example: "2022-10-06T20:58:16.305662Z" - format: date-time - type: string - modifiedBy: - description: UUID of the user who modified the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - type: object - x-common: true - type_bxp_problem_detail: - additionalProperties: true - description: Represents a problem detail returned by an API in case of error. - properties: - correlationId: - description: Internal UUID representing the request or trace ID related. - format: uuid - type: string - detail: - description: Details about the problem. - enum: - - The resource specified in the request URI wasn't found. - type: string - invalidParams: - description: List of invalid parameters. - items: - properties: - name: - description: Name of the invalid parameter. - type: string - reason: - description: Reason why the parameter is invalid. - type: string - required: - - name - - reason - type: object - minItems: 1 - type: array - uniqueItems: true - status: - description: HTTP error code related to the problem. - enum: - - "404" - type: string - title: - description: Title description of the problem. - enum: - - Resource not found - type: string - type: - description: Content-type of the object. - enum: - - https://bluexp.netapp.io/problems/1 - type: string - required: - - type - - title - - description - - status - type: object - x-common: true - type_bxp_state_details: - description: Array of all possible states and their detailed description. - items: - properties: - detail: - description: Detailed description for the state. - maxLength: 511 - minLength: 1 - type: string - title: - description: Name of the state. - maxLength: 40 - minLength: 1 - type: string - type: - description: Represents a state detail. - type: string - required: - - type - - title - - detail - type: object - type: array - uniqueItems: true - x-common: true - type_bxp_state_transitions: - description: Array representing the state machine associated with the object. - items: - properties: - from: - type: string - to: - items: - type: string - type: array - uniqueItems: true - required: - - from - - to - type: object - type: array - uniqueItems: true - x-common: true - type_dns_1123: - description: Represents a Domain Name as defined in RFC 1123. - maxLength: 63 - minLength: 1 - pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ - type: string - x-common: true - type_json: - description: JSON Representation. - type: object - x-common: true - type_json_schema: - description: Represents a JSON Schema. - properties: - $schema: - enum: - - http://json-schema.org/draft-07/schema# - type: string - additionalProperties: - enum: - - false - type: boolean - properties: - type: object - required: - items: - type: string - type: array - uniqueItems: true - type: - enum: - - object - type: string - required: - - $schema - - type - - properties - - additionalProperties - - required - type: object - x-common: true - type_swver: - description: Represents a software version in the format Major.Minor.Patch . - pattern: ^([0-9]+)\.([0-9]+)\.([0-9]+)(\-[a-zA-Z0-9-]+)*$ - type: string - x-common: true - user_1.0_get_response_body: - additionalProperties: false - properties: - aadId: - description: User AAD ID. - example: 8cb0fe27-484b-4226-a19b-9d8811f6fb6a - type: string - auth0Id: - description: User auth0 ID. - example: KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - type: string - description: - description: 'JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This user is part of NetApp Sales Territory - maxLength: 300 - minLength: 1 - type: string - editable: - description: partner organization is editable or not. - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyId: - description: Unique identifier as understood by the previous version of this service. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: User name. - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - partner: - description: partner organization name. - type: string - serviceAccount: - description: Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. - properties: - audience: - description: The value that must be included in the 'audience' claim of the private key JWT token. - example: https://netapp-cloud-account.auth0.com/ - type: string - authenticationMethod: - description: |- - Authentication method used by the service account. - Defined values are: - * "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. - * "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. - enum: - - CLIENT_SECRET - - PRIVATE_KEY_JWT - example: PRIVATE_KEY_JWT - type: string - expirationNotificationPeriod: - description: |- - The time period when expiration notifications are generated. Defined values are: - * "P7D" - Notifications are sent daily 7 days before expiration. - * "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. - enum: - - P7D - - P30D - example: P30D - type: string - publicKeys: - description: List of public keys associated with the service account. - example: - - audience: https://netapp-cloud-account.auth0.com/ - expirationTimestamp: "2026-06-24T16:25:08Z" - fingerprint: 33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8 - id: 4336388b-2992-43af-81de-ba9284b7dc36 - keyType: X509_CERTIFICATE - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2025-06-24T16:25:08Z" - modificationTimestamp: "2025-06-24T16:25:08Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - state: ENABLED - type: application/vnd.netapp.bxp.publickey+json - version: "1.0" - items: - $ref: '#/components/schemas/user_1.0_public_key_get_response_body' - type: array - uniqueItems: true - type: object - state: - description: |- - Current state of the user. - Defined values are: - * "ACTIVE" - * "INACTIVE" - enum: - - ACTIVE - - INACTIVE - example: ACTIVE - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the user. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.user" - enum: - - application/vnd.netapp.bxp.user - example: application/vnd.netapp.bxp.user - type: string - userType: - description: Type of user. - example: serviceAccount - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - ownerOrganizationId - type: object - user_1.0_list_response_body: - properties: - continue: - format: uuid - type: string - count: - example: 1 - type: integer - items: - items: - $ref: '#/components/schemas/user_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - user_1.0_patch_request_body: - additionalProperties: false - properties: - aadId: - description: User AAD ID - example: 8cb0fe27-484b-4226-a19b-9d8811f6fb6a - type: string - auth0Id: - description: User auth0 ID - example: KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - type: string - description: - description: 'JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This user is part of NetApp Sales Territory - maxLength: 300 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyId: - description: Unique identifier as understood by the previous version of this service. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: User name - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - password: - description: User password in plain text. - format: password - type: string - serviceAccount: - description: Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod property is only applicable when authenticationMethod=PRIVATE_KEY_JWT. - properties: - expirationNotificationPeriod: - description: |- - The time period when expiration notifications are generated. Defined values are: - * "P7D" - Notifications are sent daily 7 days before expiration. - * "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. - enum: - - P7D - - P30D - example: P30D - type: string - type: object - stateDesired: - description: |- - Expected state of the user. - Defined values are: - * "CREATE" - * "UPDATE" - * "LOGIN_USER" - * "REFRESH_USER" - * "LOGOUT_USER" - * "AIDP_LOGIN" - enum: - - CREATE - - UPDATE - - LOGIN_USER - - REFRESH_USER - - LOGOUT_USER - - AIDP_LOGIN - example: CREATE - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the user. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.user" - enum: - - application/vnd.netapp.bxp.user - example: application/vnd.netapp.bxp.user - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - user_1.0_post_bulk_id_request_body: - properties: - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.userbulk" - enum: - - application/vnd.netapp.bxp.userbulk - example: application/vnd.netapp.bxp.userbulk - type: string - users: - description: JSON array of user UUIDs. - items: - format: uuid - type: string - type: array - uniqueItems: true - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - user_1.0_post_request_body: - additionalProperties: false - properties: - aadId: - description: User AAD ID. - example: 8cb0fe27-484b-4226-a19b-9d8811f6fb6a - type: string - auth0Id: - description: User auth0 ID. - example: KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - type: string - description: - description: 'JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This user is part of NetApp Sales Territory - maxLength: 300 - minLength: 1 - type: string - email: - description: User email address. - example: email@acme.com - format: email - pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: User name. - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - password: - description: User password in plain text. - format: password - type: string - serviceAccount: - description: Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod, expirationTimestamp, and publicKey properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. - properties: - authenticationMethod: - default: CLIENT_SECRET - description: |- - Authentication method used by the service account. - Defined values are: - * "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. - * "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. - enum: - - CLIENT_SECRET - - PRIVATE_KEY_JWT - example: CLIENT_SECRET - type: string - expirationNotificationPeriod: - description: |- - The time period when expiration notifications are generated. Defined values are: - * "P7D" - Notifications are sent daily 7 days before expiration. - * "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. - enum: - - P7D - - P30D - example: P30D - type: string - expirationTimestamp: - description: The date and time when the public key expires. This is only applicable when an RSA key is provided for the public key. When a certificate is provided, the value is set to the certificate's expiration timestamp. - example: "2026-06-24T16:25:08Z" - format: date-time - type: string - publicKey: - description: Public X.509 certificate or RSA key in PEM format converted to a string with escaped new line characters (`\n`). - example: '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0B...\n-----END PUBLIC KEY-----\n' - type: string - required: - - authenticationMethod - type: object - stateDesired: - description: |- - Expected state of the user. - Defined values are: - * "CREATE" - * "UPDATE" - enum: - - CREATE - - UPDATE - example: CREATE - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the user. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.user" - enum: - - application/vnd.netapp.bxp.user - example: application/vnd.netapp.bxp.user - type: string - userType: - description: Type of user. - example: serviceAccount - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - ownerOrganizationId - type: object - user_1.0_post_response_body: - properties: - aadId: - description: User AAD ID. - example: 8cb0fe27-484b-4226-a19b-9d8811f6fb6a - type: string - auth0ClientSecret: - description: Auth0 Client Secret. - type: string - auth0Id: - description: User auth0 ID. - example: KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - type: string - description: - description: 'JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This user is part of NetApp Sales Territory - maxLength: 300 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyId: - description: Unique identifier as understood by the previous version of this service. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: User name. - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - serviceAccount: - description: Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. - properties: - audience: - description: The value that must be included in the 'audience' claim of the private key JWT token. - example: https://netapp-cloud-account.auth0.com/ - type: string - authenticationMethod: - description: |- - Authentication method used by the service account. - Defined values are: - * "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. - * "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. - enum: - - CLIENT_SECRET - - PRIVATE_KEY_JWT - example: CLIENT_SECRET - type: string - expirationNotificationPeriod: - description: |- - The time period when expiration notifications are generated. Defined values are: - * "P7D" - Notifications are sent daily 7 days before expiration. - * "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. - enum: - - P7D - - P30D - example: P30D - type: string - publicKeys: - description: List of public keys associated with the service account. - example: - - audience: https://netapp-cloud-account.auth0.com/ - expirationTimestamp: "2026-06-24T16:25:08Z" - fingerprint: 33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8 - id: 4336388b-2992-43af-81de-ba9284b7dc36 - keyType: RSA_KEY - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2025-06-24T16:25:08Z" - modificationTimestamp: "2025-06-24T16:25:08Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - state: ENABLED - type: application/vnd.netapp.bxp.publickey+json - version: "1.0" - items: - $ref: '#/components/schemas/user_1.0_public_key_get_response_body' - type: array - uniqueItems: true - type: object - state: - description: |- - Current state of the user. - Defined values are: - * "ACTIVE" - * "INACTIVE" - enum: - - ACTIVE - - INACTIVE - example: ACTIVE - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the user. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.user" - enum: - - application/vnd.netapp.bxp.user - example: application/vnd.netapp.bxp.user - type: string - userType: - description: Type of user. - example: serviceAccount - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - ownerOrganizationId - type: object - user_1.0_post_scope_object_bulk_id_request_body: - properties: - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.userbulk" - enum: - - application/vnd.netapp.bxp.userbulk - example: application/vnd.netapp.bxp.userbulk - type: string - users: - description: JSON array of users. - items: - properties: - aadId: - type: string - auth0Id: - type: string - emailId: - format: email - pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ - type: string - userId: - format: uuid - type: string - type: object - type: array - uniqueItems: true - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - user_1.0_public_key_get_response_body: - properties: - audience: - description: The value that must be included in the 'audience' claim of the private key JWT token. - example: https://netapp-cloud-account.auth0.com/ - type: string - credentialId: - description: The Auth0 credential ID associated with the public key. - example: cred_fh4agpsm4BphW5QZiYhHR8 - type: string - expirationTimestamp: - description: The date and time when the public key expires. - example: "2026-06-24T16:25:08Z" - format: date-time - type: string - fingerprint: - description: The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. - example: 33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8 - type: string - id: - description: Globally unique identifier of the resource conforming to the UUIDv4 schema. - example: 4336388b-2992-43af-81de-ba9284b7dc36 - format: uuid - type: string - keyType: - description: |- - Type of the public key. - Defined values are: - * "X509_CERTIFICATE" - The public key is an X.509 certificate. - * "RSA_KEY" - The public key is an RSA key. - enum: - - X509_CERTIFICATE - - RSA_KEY - example: RSA_KEY - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - state: - description: |- - The state of the public key. Defined values are: - * "ENABLED" - The public key is enabled. - * "DISABLED" - The public key is disabled. - enum: - - ENABLED - - DISABLED - example: ENABLED - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.publickey" - enum: - - application/vnd.netapp.bxp.publickey - example: application/vnd.netapp.bxp.publickey - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - type: object - user_1.0_public_key_list_response_body: - example: - items: - - audience: https://netapp-cloud-account.auth0.com/ - credentialId: cred_fh4agpsm4BphW5QZiYhHR8 - expirationTimestamp: "2026-06-24T16:25:08Z" - fingerprint: 33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8 - id: 4336388b-2992-43af-81de-ba9284b7dc36 - keyType: RSA_KEY - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2025-06-24T16:25:08Z" - modificationTimestamp: "2025-06-24T16:25:08Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - state: ENABLED - type: application/vnd.netapp.bxp.publickey+json - version: "1.0" - properties: - items: - items: - $ref: '#/components/schemas/user_1.0_public_key_get_response_body' - type: array - uniqueItems: true - required: - - items - type: object - user_1.0_public_key_patch_request_body: - properties: - expirationTimestamp: - description: The date and time when the public key expires. This is only applicable when the public key is an RSA key. - example: "2026-06-24T16:25:08Z" - format: date-time - type: string - stateDesired: - description: |- - Expected state of the public key. Defined values are: - * "ENABLED" - The public key is enabled. - * "DISABLED" - The public key is disabled. - enum: - - ENABLED - - DISABLED - example: DISABLED - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.publickey" - enum: - - application/vnd.netapp.bxp.publickey - example: application/vnd.netapp.bxp.publickey - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - user_1.0_public_key_post_request_body: - properties: - expirationTimestamp: - description: The date and time when the public key expires. This is only applicable when an RSA key is provided for the public key. When a certificate is provided, the value is set to the certificate's expiration timestamp. - example: "2026-06-24T16:25:08Z" - format: date-time - type: string - publicKey: - description: Public X.509 certificate or RSA key in PEM format converted to a string with escaped new line characters (`\n`). - example: '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0B...\n-----END PUBLIC KEY-----\n' - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.publickey" - enum: - - application/vnd.netapp.bxp.publickey - example: application/vnd.netapp.bxp.publickey - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - publicKey - type: object - user_1.0_public_key_post_response_body: - properties: - audience: - description: The value that must be included in the 'audience' claim of the private key JWT token. - example: https://netapp-cloud-account.auth0.com/ - type: string - expirationTimestamp: - description: The date and time when the public key expires. - example: "2026-06-24T16:25:08Z" - format: date-time - type: string - fingerprint: - description: The SHA-1 fingerprint of the public X.509 certificate or RSA key that was provided for the public key. - example: 33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8 - type: string - id: - description: Globally unique identifier of the resource conforming to the UUIDv4 schema. - example: 4336388b-2992-43af-81de-ba9284b7dc36 - format: uuid - type: string - keyType: - description: |- - Type of the public key. - Defined values are: - * "X509_CERTIFICATE" - The public key is an X.509 certificate. - * "RSA_KEY" - The public key is an RSA key. - enum: - - X509_CERTIFICATE - - RSA_KEY - example: RSA_KEY - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - state: - description: |- - The state of the public key. Defined values are: - * "ENABLED" - The public key is enabled. - * "DISABLED" - The public key is disabled. - enum: - - ENABLED - - DISABLED - example: ENABLED - type: string - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.publickey" - enum: - - application/vnd.netapp.bxp.publickey - example: application/vnd.netapp.bxp.publickey - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - fingerprint - - keyType - - state - - expirationTimestamp - - audience - - metadata - type: object - user_1.0_put_request_body: - additionalProperties: false - properties: - aadId: - description: User AAD ID. - example: 8cb0fe27-484b-4226-a19b-9d8811f6fb6a - type: string - auth0Id: - description: User auth0 ID. - example: KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - type: string - description: - description: 'JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This user is part of NetApp Sales Territory - maxLength: 300 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyId: - description: Unique identifier as understood by the previous version of this service. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: User name. - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - password: - description: User password in plain text. - format: password - type: string - serviceAccount: - description: Properties specific to users with userType=serviceAccount. The expirationNotificationPeriod, expirationTimestamp, and publicKey properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. - properties: - authenticationMethod: - default: CLIENT_SECRET - description: |- - Authentication method used by the service account. - Defined values are: - * "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. - * "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. - enum: - - CLIENT_SECRET - - PRIVATE_KEY_JWT - example: CLIENT_SECRET - type: string - expirationNotificationPeriod: - description: |- - The time period when expiration notifications are generated. Defined values are: - * "P7D" - Notifications are sent daily 7 days before expiration. - * "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. - enum: - - P7D - - P30D - example: P30D - type: string - expirationTimestamp: - description: The date and time when the public key expires. This is only applicable when an RSA key is provided for the public key. When a certificate is provided, the value is set to the certificate's expiration timestamp. - example: "2026-06-24T16:25:08Z" - format: date-time - type: string - publicKey: - description: Public X.509 certificate or RSA key in PEM format converted to a string with escaped new line characters (`\n`). - example: '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0B...\n-----END PUBLIC KEY-----\n' - type: string - required: - - authenticationMethod - type: object - stateDesired: - description: |- - Expected state of the user. - Defined values are: - * "CREATE" - * "UPDATE" - enum: - - CREATE - - UPDATE - example: CREATE - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the user. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.user" - enum: - - application/vnd.netapp.bxp.user - example: application/vnd.netapp.bxp.user - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - ownerOrganizationId - type: object - user_1.0_put_response_body: - properties: - aadId: - description: User AAD ID. - example: 8cb0fe27-484b-4226-a19b-9d8811f6fb6a - type: string - auth0ClientSecret: - description: Auth0 Client Secret. - type: string - auth0Id: - description: User auth0 ID. - example: KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - type: string - description: - description: 'JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This user is part of NetApp Sales Territory - maxLength: 300 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - legacyId: - description: Unique identifier as understood by the previous version of this service. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: User name. - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - serviceAccount: - description: Properties specific to users with userType=serviceAccount. The audience, expirationNotificationPeriod, and publicKeys properties are only applicable when authenticationMethod=PRIVATE_KEY_JWT. - properties: - audience: - description: The value that must be included in the 'audience' claim of the private key JWT token. - example: https://netapp-cloud-account.auth0.com/ - type: string - authenticationMethod: - description: |- - Authentication method used by the service account. - Defined values are: - * "CLIENT_SECRET" - Service account uses a client id and secret to authenticate when requesting an access token. - * "PRIVATE_KEY_JWT" - Service account uses a JWT token signed with a private key to authenticate when requesting an access token. - enum: - - CLIENT_SECRET - - PRIVATE_KEY_JWT - example: CLIENT_SECRET - type: string - expirationNotificationPeriod: - description: |- - The time period when expiration notifications are generated. Defined values are: - * "P7D" - Notifications are sent daily 7 days before expiration. - * "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration. - enum: - - P7D - - P30D - example: P30D - type: string - publicKeys: - description: List of public keys associated with the service account. - example: - - audience: https://netapp-cloud-account.auth0.com/ - expirationTimestamp: "2026-06-24T16:25:08Z" - fingerprint: 33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8 - id: 4336388b-2992-43af-81de-ba9284b7dc36 - keyType: RSA_KEY - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2025-06-24T16:25:08Z" - modificationTimestamp: "2025-06-24T16:25:08Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - state: ENABLED - type: application/vnd.netapp.bxp.publickey+json - version: "1.0" - items: - $ref: '#/components/schemas/user_1.0_public_key_get_response_body' - type: array - uniqueItems: true - type: object - state: - description: |- - Current state of the user. - Defined values are: - * "ACTIVE" - * "INACTIVE" - enum: - - ACTIVE - - INACTIVE - example: ACTIVE - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the user. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.user" - enum: - - application/vnd.netapp.bxp.user - example: application/vnd.netapp.bxp.user - type: string - userType: - description: Type of user. - example: serviceAccount - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - ownerOrganizationId - type: object - userelevated_1.0_patch_request_body: - additionalProperties: false - properties: - elevatedStateDesired: - description: |- - Indicate when a user wants to elevate or downscope his role(s) - Defined values are: - * ELEVATED - * DOWNSCOPED - enum: - - ELEVATED - - DOWNSCOPED - example: ELEVATED - type: string - required: - - elevatedStateDesired - type: object - usergroup_1.0_get_response_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This usergroup is part of NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the user group. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the user group. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.usergroup" - enum: - - application/vnd.netapp.bxp.usergroup - example: application/vnd.netapp.bxp.usergroup - type: string - usergroupType: - description: |- - Specifies type of userGroup. - Defined values are: - * SYSTEM - * FEDERATED - * USERGROUP - Defaults to SYSTEM - enum: - - FEDERATED - - USERGROUP - - SYSTEM - example: SYSTEM - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - - ownerOrganizationId - type: object - usergroup_1.0_list_response_body: - properties: - continue: - format: uuid - type: string - count: - type: int - items: - items: - $ref: '#/components/schemas/usergroup_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - usergroup_1.0_patch_request_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This usergroup is part of NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the user group. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the user group. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.usergroup" - enum: - - application/vnd.netapp.bxp.usergroup - example: application/vnd.netapp.bxp.usergroup - type: string - usergroupType: - description: |- - Specifies type of userGroup. - Defined values are: - * SYSTEM - * FEDERATED - * USERGROUP - Defaults to SYSTEM - enum: - - FEDERATED - - USERGROUP - - SYSTEM - example: SYSTEM - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - usergroup_1.0_post_bulk_id_request_body: - properties: - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.usergroupbulk" - enum: - - application/vnd.netapp.bxp.usergroupbulk - example: application/vnd.netapp.bxp.usergroupbulk - type: string - usergroups: - items: - properties: - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - name: - description: |- - JSON string containing a name for the user group. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - type: object - type: array - uniqueItems: true - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - usergroups - type: object - usergroup_1.0_post_request_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This usergroup is part of NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the user group. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the user group. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.usergroup" - enum: - - application/vnd.netapp.bxp.usergroup - example: application/vnd.netapp.bxp.usergroup - type: string - usergroupType: - description: |- - Specifies type of userGroup. - Defined values are: - * SYSTEM - * FEDERATED - * USERGROUP - Defaults to SYSTEM - enum: - - FEDERATED - - USERGROUP - - SYSTEM - example: SYSTEM - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - name - - ownerOrganizationId - type: object - usergroup_1.0_post_response_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This usergroup is part of NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - links: - items: - $ref: '#/components/schemas/type_bxp_link' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the user group. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the user group. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.usergroup" - enum: - - application/vnd.netapp.bxp.usergroup - example: application/vnd.netapp.bxp.usergroup - type: string - usergroupType: - description: |- - Specifies type of userGroup. - Defined values are: - * SYSTEM - * FEDERATED - * USERGROUP - Defaults to SYSTEM - enum: - - FEDERATED - - USERGROUP - - SYSTEM - example: SYSTEM - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - - id - - name - - metadata - - ownerOrganizationId - type: object - usergroup_1.0_put_request_body: - additionalProperties: false - properties: - description: - description: 'JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks.' - example: This usergroup is part of NetApp Sales Territory - maxLength: 254 - minLength: 1 - type: string - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - isSystem: - description: |- - Specifies if an object is system generated. - Defined values are: - * "true" - enum: - - "true" - - "false" - example: "true" - type: string - metadata: - $ref: '#/components/schemas/type_bxp_metadata' - name: - description: |- - JSON string containing a name for the user group. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: StorageAdmin - maxLength: 300 - minLength: 1 - type: string - ownerOrganizationId: - description: JSON string containing the ID of the organization. - format: uuid - type: string - tags: - description: JSON array of tags (name/value pairs) representing metadata for the user group. - items: - additionalProperties: - type: string - type: object - type: array - type: - description: |- - Media type of the resource. - Defined values are: - * "application/vnd.netapp.bxp.usergroup" - enum: - - application/vnd.netapp.bxp.usergroup - example: application/vnd.netapp.bxp.usergroup - type: string - usergroupType: - description: |- - Specifies type of userGroup. - Defined values are: - * SYSTEM - * FEDERATED - * USERGROUP - Defaults to SYSTEM - enum: - - FEDERATED - - USERGROUP - - SYSTEM - example: SYSTEM - type: string - version: - description: |- - Version of the resource. - Defined values are: - * "1.0" - enum: - - "1.0" - example: "1.0" - type: string - required: - - type - - version - type: object - userpermissions_1.0_get_response_body: - additionalProperties: false - properties: - id: - description: |- - Globally unique identifier of the resource. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - legacyId: - description: |- - JSON string containing the id as understood by the previous version of this service or a copy of the current ID if the public ID doesn't exist. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: resource-vzvPlNPG - maxLength: 300 - minLength: 1 - type: string - name: - description: |- - JSON string containing a name for the resource. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: Cluster1 - maxLength: 300 - minLength: 1 - type: string - permissions: - description: JSON array of permissions. Contains all permissions the user has on a particular resource. - items: - properties: - id: - description: |- - Globally unique identifier of the permission. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - rule: - description: |- - JSON string containing the permission in the format [serviceApplication]:[resourceType]-[action][-[modifier]] - Defined values are: - * Minimum length: 1 - * Maximum length: 63 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: aiq:system-read - maxLength: 254 - minLength: 1 - type: string - required: - - id - - rule - type: object - minItems: 1 - type: array - uniqueItems: true - resourceClass: - description: JSON string containing the resource class. This should be one of the allowed resource classes, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. - example: ON_PREM - type: string - resourceType: - description: JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. - example: ON_PREM - type: string - required: - - id - - name - - resourceType - - resourceClass - - permissions - type: object - userpermissions_1.0_list_response_body: - properties: - count: - type: int - items: - items: - $ref: '#/components/schemas/userpermissions_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - userroles_1.0_get_response_body: - additionalProperties: false - properties: - id: - description: |- - Globally unique identifier of the resource of type hierarchy. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - legacyId: - description: |- - JSON string containing the id as understood by the previous version of this service or a copy of the current ID if the public ID doesn't exist. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: resource-vzvPlNPG - maxLength: 300 - minLength: 1 - type: string - name: - description: |- - JSON string containing a name for the resource of type hierarchy. - Defined values are: - * Minimum length: 1 - * Maximum length: 300 - * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. - example: Cluster1 - maxLength: 300 - minLength: 1 - type: string - resourceClass: - description: JSON string containing the resource class. This should be one of the allowed resource classes, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. - example: ON_PREM - type: string - resourceType: - description: JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the NetApp Console IAM system. - example: ON_PREM - type: string - roles: - description: JSON array of roles. Contains all roles the user is assigned in a particular hierarchy. - items: - properties: - id: - description: |- - Globally unique identifier of the role. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - format: uuid - type: string - partnershipId: - description: |- - Globally unique identifier of the partnership. - Defined values are: - * Conforms to the UUIDv4 Schema - example: 5928084a-616d-44d0-b464-6fd1ba3248fb - format: uuid - type: string - required: - - id - type: object - minItems: 1 - type: array - uniqueItems: true - required: - - id - - name - - resourceType - - resourceClass - - roles - type: object - userroles_1.0_list_response_body: - properties: - count: - type: int - items: - items: - $ref: '#/components/schemas/userroles_1.0_get_response_body' - type: array - uniqueItems: true - metadata: - $ref: '#/components/schemas/type_bxp_metadata_list' - required: - - items - type: object - securitySchemes: - bxp_api_token: - in: header - name: X-API-BXP - type: apiKey - bxp_bearer_auth: - scheme: bearer - type: http -info: - description: "The NetApp Console identity and access management (IAM) service provides a centralized point for managing customer and partner information. \nIAM endpoints enable you to manage and control access to the Console resources.\n\nIf you're using the Console in standard mode, you no longer have a NetApp Console account. Instead, you have an organization in the Console that you manage using IAM. \n\nThe following six components are defined within the IAM service.\n
    • hierarchy
      • \n
    • permission
      • \n
    • partnership
      • \n
    • resource and resourcegroup
      • \n
    • role
    • user and usergroup
      • \n
    \n\nIAM uses predefined roles that include sets of permissions which are required to manage and view data. You can have multiple roles within the same organization or set of resources.\nYou should verify that you have the appropriate permissions when using IAM API endpoints. With the appropriate permissions, you can manage an organization hierarchy modeled as folders (subdivisions of an organization using criteria such as department or region) and projects (a workspace in the Console). After organizing your resources into folders and projects, you can grant granular access to resources by providing organization members with permissions to specific folders and projects.\n\n\nThe actions available through the IAM REST API are a superset of what's available through the web UI.\n\n

    Note: Before using the API reference documentation, review the \nGet started section for the Console APIs. For more information about the security tokens and identifiers you'll need when using the API, review the Common workflows and tasks section.

    \n\n
    \n
    \nREST implementation\n

    HTTP methods

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    MethodDescription
    POSTCreate an object instance
    GETRetrieve an object instance or collection
    PATCHUpdate specific fields of an existing resource instance based on the supplied input values
    PUTUpdate an existing resource instance based on the supplied input values
    DELETERemove an existing object
    \n

    Request headers

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Request HeaderDescription
    AuthorizationRequired. Contains a JWT access token
    \n

    Query parameters

    \n

    You can use query parameters with endpoints in the following components:

    \n
    ComponentQuery Parameter
    Hierarchyfilter,
    skip,
    include,
    orderBy,
    limit,
    count,
    continue,

    metadata,

    links
    Permissionfilter,
    skip,
    include,
    orderBy,
    limit,
    count,
    continue,

    metadata,

    links
    Resource and resourcegroupfilter,
    skip,
    include,
    orderBy,
    limit,
    count,
    continue,

    metadata,

    links
    Rolefilter,
    skip,
    include,
    orderBy,
    limit,
    count,
    continue,

    metadata,

    links
    User and usergroupfilter,
    skip,
    include,
    orderBy,
    limit,
    count,
    continue,

    metadata,

    links
    \n

    Response headers

    \n

    This API uses the standard HTTP response headers common with all APIs in the Console. See REST implementation for more information.

    \n

    HTTP status codes

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    HTTP Status CodeDescription
    200OK: Returned for successful operation completion
    201The resource was successfully created.
    204The operation was completed successfully and the server did not send a response message.
    400Bad Request: Returned if the input is malformed and could not be parsed
    401Unauthorized: Returned if user authentication failed or the token has expired
    403Forbidden: Returned for authorization errors depending on the resource and token
    \n
    \n
    \n
    \nError handling\n

    The following processes are involved with error handling and processing.

    \n
      \n
    • The error is logged for supportability
      • \n
    • The error is also returned to the caller for any specific handling
      • \n" - license: - name: NetApp Console License - termsOfService: https://www.netapp.com/media/10784-cloud-data-services-terms.pdf - title: (documentation) Tenancy API - version: "1.0" -openapi: 3.0.3 -paths: - /folders: - get: - description: Lists all folders in the collection. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of all folders. - headers: - Location: - description: Location of folders. - schema: - format: uri - type: string - "401": - $ref: '#/components/responses/401Unauthorized' - summary: Lists all folders. - tags: - - Hierarchy - x-cache-control: no-cache - x-permission: bxp:folder-read - x-private-path: /resources - x-scope: documentation,public - post: - description: Creates a new folder. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - name: netapp-sales - ownerOrganizationId: bc806791-5fbb-4c08-9111-90722412c6e3 - parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - resourceClass: hierarchy - resourceType: folder - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_request_body' - description: Indicates the desired values for the folder that is to be created. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp-sales - resourceType: folder - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_response_body' - description: Returns the new folder in the JSON response body. - headers: - Location: - description: Location of the newly created folder. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new folder - tags: - - Hierarchy - x-permission: bxp:folder-create - x-private-path: /resources - x-scope: documentation,public - /folders/{folder_id}: - delete: - description: Deletes the specified folder. - responses: - "204": - description: Indicates if the folder was deleted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Delete a specific folder. - tags: - - Hierarchy - x-permission: bxp:folder-delete - x-private-path: /resources/{folder_id} - x-scope: documentation,public - get: - description: Retrieves the specified folder. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp-sales - resourceType: folder - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored folder in the JSON response body. - summary: Retrieve a folder - tags: - - Hierarchy - x-permission: bxp:folder-read - x-private-path: /resources/{folder_id} - x-scope: documentation,public - parameters: - - description: ID of the folder. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: folder_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates the specified folder with partial information. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: netapp-sales - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_patch_request_body' - description: Replaces the specified attributes in the request body with the values provided. - required: true - responses: - "204": - description: Indicates if the folder was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Partially update a folder. - tags: - - Hierarchy - x-permission: bxp:folder-modify - x-private-path: /resources/{folder_id} - x-scope: documentation,public - put: - description: Replaces the specified folder with new information. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: netapp-sales - resourceType: folder - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_put_request_body' - description: Replaces the entire stored folder with the supplied JSON request body while preserving the key values that are not user-modifiable. - required: true - responses: - "204": - description: Indicates if the folder was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Modify a specific folder - tags: - - Hierarchy - x-permission: bxp:folder-modify - x-private-path: /resources/{folder_id} - x-scope: documentation,public - /folders/{folder_id}/folders: - get: - description: Lists all folders under the specified parent folder. - parameters: - - description: ID of the folder. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: folder_id - required: true - schema: - format: uuid - type: string - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of all folders under a parent folder. - headers: - Location: - description: Location of the folders. - schema: - format: uri - type: string - "401": - $ref: '#/components/responses/401Unauthorized' - summary: List all folders under a parent folder - tags: - - Hierarchy - x-cache-control: no-cache - x-permission: bxp:folder-read - x-private-path: /resources - x-scope: documentation,public - post: - description: Creates a new folder under the specified parent folder. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - name: netapp-sales - ownerOrganizationId: bc806791-5fbb-4c08-9111-90722412c6e3 - parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - resourceClass: hierarchy - resourceType: folder - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_request_body' - description: Indicates the desired values for the folder to be created under a parent folder. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp-sales - resourceType: folder - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_response_body' - description: Returns the newly created folder in the JSON response body. - headers: - Location: - description: Location of the newly created folder. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new folder under a parent folder - tags: - - Hierarchy - x-permission: bxp:folder-create - x-private-path: /resources - x-scope: documentation,public - /folders/{folder_id}/folders/{childfolder_id}: - delete: - description: Removes the specified child folder from a parent folder. - responses: - "204": - description: Indicates if the child folder was removed from the parent folder. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a child folder from a parent folder - tags: - - Hierarchy - x-permission: bxp:folder-delete - x-persistence: false - x-scope: documentation,private,public - get: - description: Retrieves a child folder under the specified parent folder. - parameters: - - $ref: '#/components/parameters/filter' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp-sales - resourceType: folder - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored folder in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a child folder under a parent folder - tags: - - Hierarchy - x-permission: bxp:folder-read - x-persistence: false - x-private-path: /resources/{childfolder_id} - x-scope: documentation,public - parameters: - - description: ID of the folder. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: folder_id - required: true - schema: - format: uuid - type: string - - description: ID of the child folder. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: childfolder_id - required: true - schema: - format: uuid - type: string - /folders/{folder_id}/projects: - get: - description: Lists all projects under the specified folder. - parameters: - - description: ID of the folder. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: folder_id - required: true - schema: - format: uuid - type: string - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of all projects under a parent folder - headers: - Location: - description: Location of project resources. - schema: - format: uri - type: string - "401": - $ref: '#/components/responses/401Unauthorized' - summary: List all projects under a folder - tags: - - Hierarchy - x-cache-control: no-cache - x-permission: bxp:project-read - x-persistence: false - x-private-path: /resources - x-scope: documentation,public - parameters: - - description: ID of the folder. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: folder_id - required: true - schema: - format: uuid - type: string - post: - description: Creates a project under the specified folder. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - name: netapp-project-1 - resourceType: project - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_request_body' - description: Indicates the desired values for the project to be created under a folder. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp-project-1 - resourceType: project - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_response_body' - description: Returns the newly created project in the JSON response body. - headers: - Location: - description: Location of the newly created project. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new project under a folder - tags: - - Hierarchy - x-permission: bxp:project-create - x-persistence: false - x-private-path: /resources - x-scope: documentation,public - /folders/{folder_id}/projects/{project_id}: - delete: - description: Removes a project from the specified folder. - responses: - "204": - description: Indicates if the project was removed from the folder. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a project from a folder - tags: - - Hierarchy - x-permission: bxp:project-delete - x-persistence: false - x-scope: documentation,private,public - get: - description: Retrieves a project under the specified folder. - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp-project-1 - resourceType: project - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored project in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a project under a folder - tags: - - Hierarchy - x-permission: bxp:project-read - x-persistence: false - x-private-path: /resources/{project_id} - x-scope: documentation,public - parameters: - - description: ID of the folder. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: folder_id - required: true - schema: - format: uuid - type: string - - description: ID of the project. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: project_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates a project under the specified folder with partial information. - parameters: - - $ref: '#/components/parameters/filter' - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: netapp-project-1 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_patch_request_body' - description: Replaces the specified attributes in the request body with the values provided. - required: true - responses: - "204": - description: Indicates if the project was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Partially update a project - tags: - - Hierarchy - x-permission: bxp:project-modify - x-persistence: false - x-private-path: /resources/{project_id} - x-scope: documentation,private,public - put: - description: Replaces a project in the specified folder with new information. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: netapp-project-1 - resourceType: project - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_put_request_body' - description: Replaces the entire stored project with the supplied JSON request body while preserving the key values that are not user-modifiable. - required: true - responses: - "204": - description: Indicates if the project was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Modify a specific project - tags: - - Hierarchy - x-permission: bxp:project-modify - x-persistence: false - x-private-path: /resources/{project_id} - x-scope: documentation,private,public - /folders/{folder_id}/resources: - get: - description: Lists all resources under the specified folder. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of resources in a folder. - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: List all resources under a folder. - tags: - - Resource and Resourcegroup - x-cache-control: no-cache - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,public - parameters: - - description: The ID of the folder that contains the resources. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: folder_id - required: true - schema: - format: uuid - type: string - post: - description: Adds resources to the specified folder. - requestBody: - content: - application/vnd.netapp.bxp.resourcebulk+json: - example: - resources: - - a94ac68f-ea20-47aa-add8-8d41be0d8466 - - b04ac68f-da27-578a-cee8-9e45bq0d8466 - type: application/vnd.netapp.bxp.resourcebulk - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_bulk_id_request_body' - description: Indicates the resources to add to the folder. - required: true - responses: - "202": - description: Indicates the resources request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add resources to a folder - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-create - x-persistence: true - x-scope: documentation,private,public - /folders/{folder_id}/resources/{resource_id}: - delete: - description: Removes a resource from the specified folder. - responses: - "204": - description: Indicates if the resource was removed from a folder. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a resource from a folder - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a resource under the specified folder. - parameters: - - $ref: '#/components/parameters/filter' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - description: Added a resource of resourceType volume - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: volume-1 - rawId: cluster-1-volume-1 - resourceType: volume - tags: - - internal:bxp:folderId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored resource in the JSON response body if it belongs to the folder. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a resource under a folder - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the folder. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: folder_id - required: true - schema: - format: uuid - type: string - - description: ID of the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - /folders/{folder_id}/roles/{role_id}/usergroups: - post: - description: Creates a new user group. - requestBody: - content: - application/vnd.netapp.bxp.usergroup+json: - example: - description: This tag represents NetApp Sales Territory - name: fed-pepsico-com-samlp_admin - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.usergroup - usergroupType: USERGROUP - version: "1.0" - schema: - $ref: '#/components/schemas/usergroup_1.0_post_request_body' - description: Indicates the desired values for the user group to be created. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.usergroup+json: - example: - description: This tag represents NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: fed-pepsico-com-samlp_admin - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.usergroup - usergroupType: USERGROUP - version: "1.0" - schema: - $ref: '#/components/schemas/usergroup_1.0_post_response_body' - description: Returns the newly created user group in the JSON response body. - headers: - Location: - description: Location of the newly created resource. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new user group - tags: - - User and Usergroup - x-permission: bxp:usergroup-create - x-persistence: true - x-scope: documentation,private,public - /folders/{folder_id}/roles/{role_id}/users/{user_id}: - delete: - description: Removes a user from the specified folder. - responses: - "204": - description: Indicates if the user was removed from a folder. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a user from a folder - tags: - - User and Usergroup - x-permission: bxp:user-delete - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the folder. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: folder_id - required: true - schema: - format: uuid - type: string - - description: ID of the user. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - - description: ID of the role. - example: 778f8579-a5b1-48ab-91c5-361acc2ee7fe - in: path - name: role_id - required: true - schema: - format: uuid - type: string - /folders/{folder_id}/users: - get: - description: Lists all users associated with the specified folder. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.users+json: - schema: - $ref: '#/components/schemas/user_1.0_list_response_body' - description: List of all users for this folder. - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: List all users associated with a folder - tags: - - User and Usergroup - x-cache-control: no-cache - x-permission: bxp:user-read - x-persistence: true - x-private-path: /resources/{folder_id}/users - x-scope: documentation,public - parameters: - - description: Folder ID used to display users. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: folder_id - required: true - schema: - format: uuid - type: string - post: - description: Adds users to the specified folder. - requestBody: - content: - application/vnd.netapp.bxp.userbulk+json: - example: - type: application/vnd.netapp.bxp.userbulk - users: - - a94ac68f-ea20-47aa-add8-8d41be0d8466 - - b04ac68f-da27-578a-cee8-9e45bq0d8466 - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_post_bulk_id_request_body' - description: Indicates the users to be added. - required: true - responses: - "202": - description: Indicates the users request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add users to a folder - tags: - - User and Usergroup - x-permission: bxp:user-create - x-persistence: true - x-scope: documentation,private,public - /folders/{folder_id}/users/{user_id}: - delete: - description: Removes a user from the specified folder. - responses: - "204": - description: Indicates if the user was removed from the folder. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a user from a folder - tags: - - User and Usergroup - x-permission: bxp:user-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a user associated with the specified folder. - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - description: Adding user to NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: user-1 - state: ACTIVE - tags: - - internal:bxp:folderId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_get_response_body' - description: Returns the stored user in the JSON response body if it belongs to the folder. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a user associated with a folder - tags: - - User and Usergroup - x-permission: bxp:user-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the folder. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: folder_id - required: true - schema: - format: uuid - type: string - - description: ID of the user. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - /organizations: - get: - description: Lists all organizations. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of all organizations. - headers: - Location: - description: Location of organizations. - schema: - format: uri - type: string - "401": - $ref: '#/components/responses/401Unauthorized' - summary: List all organizations - tags: - - Hierarchy - x-cache-control: no-cache - x-permission: bxp:organization-read - x-persistence: false - x-private-path: /resources - x-scope: documentation,public - post: - description: Creates a new organization. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - name: netapp - resourceType: organization - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:crmId: a1a6ddeb-2a15-4907-a801-9b9c3f40a7b7 - - internal:bxp:cmatId: 2e007562-f061-4b18-b9bd-16ef3bde524b - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_request_body' - description: Indicates the desired values for the organization to be created. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp - resourceType: organization - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:crmId: a1a6ddeb-2a15-4907-a801-9b9c3f40a7b7 - - internal:bxp:cmatId: 2e007562-f061-4b18-b9bd-16ef3bde524b - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_response_body' - description: Returns the newly created organization in the JSON response body. - headers: - Location: - description: Location of the newly created organization resource. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new organization - tags: - - Hierarchy - x-permission: bxp:organization-create - x-persistence: false - x-private-path: /resources - x-scope: documentation,public - /organizations/{organization_id}: - get: - description: Retrieves the specified organization. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp - resourceType: organization - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32, 48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:crmId: a1a6ddeb-2a15-4907-a801-9b9c3f40a7b7 - - internal:bxp:cmatId: 2e007562-f061-4b18-b9bd-16ef3bde524b - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored organization in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve an organization - tags: - - Hierarchy - x-permission: bxp:organization-read - x-persistence: false - x-private-path: /resources/{organization_id} - x-scope: documentation,public - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates the specified organization with partial information. - requestBody: - content: - application/vnd.netapp.bxp.organization+json: - example: - safeMode: true - schema: - $ref: '#/components/schemas/organization_1.0_patch_request_body' - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: netapp - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:crmId: a1a6ddeb-2a15-4907-a801-9b9c3f40a7b7 - - internal:bxp:cmatId: 2e007562-f061-4b18-b9bd-16ef3bde524b - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_patch_request_body' - description: |- - With content-type "application/vnd.netapp.bxp.resource+json", replaces the specified attributes in the request body with the values provided. - With content-type "application/vnd.netapp.bxp.organization+json", allow changing specific settings for this organization. - required: true - responses: - "204": - description: Indicates if the organization was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Partially update an organization - tags: - - Hierarchy - x-permission: bxp:organization-modify - x-persistence: false - x-private-path: /organizations/{organization_id} - x-scope: documentation,public - put: - description: Replaces the specified organization with new information. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: netapp - resourceType: organization - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:crmId: a1a6ddeb-2a15-4907-a801-9b9c3f40a7b7 - - internal:bxp:cmatId: 2e007562-f061-4b18-b9bd-16ef3bde524b - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_put_request_body' - description: Replaces the entire stored organization resource with the supplied JSON request body while preserving the key values that are not user-modifiable. - required: true - responses: - "204": - description: Indicates if the organization was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Modify a specific organization - tags: - - Hierarchy - x-permission: bxp:organization-modify - x-persistence: false - x-private-path: /resources/{organization_id} - x-scope: documentation,public - /organizations/{organization_id}/folders: - get: - description: Lists all folders under the specified organization. - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of all folders under an organization. - headers: - Location: - description: Location of resources. - schema: - format: uri - type: string - "401": - $ref: '#/components/responses/401Unauthorized' - summary: List all folders under an organization - tags: - - Hierarchy - x-cache-control: no-cache - x-permission: bxp:folder-read - x-private-path: /resources - x-scope: documentation,public - post: - description: Creates a new folder under the specified organization. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - name: netapp-sales - ownerOrganizationId: bc806791-5fbb-4c08-9111-90722412c6e3 - parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - resourceClass: hierarchy - resourceType: folder - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_request_body' - description: Indicates the desired values for the folder to be created under an organization. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp-sales - resourceType: folder - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_response_body' - description: Returns the newly created folder in the JSON response body. - headers: - Location: - description: Location of the newly created folder. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new folder under an organization. - tags: - - Hierarchy - x-permission: bxp:folder-create - x-private-path: /resources - x-scope: documentation,public - /organizations/{organization_id}/folders/{folder_id}: - delete: - description: Removes a folder from the specified organization. - responses: - "204": - description: Indicates if the folder was removed from an organization. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a folder from an organization - tags: - - Hierarchy - x-permission: bxp:folder-delete - x-persistence: false - x-scope: documentation,private,public - get: - description: Retrieves a folder under the specified organization. - parameters: - - $ref: '#/components/parameters/filter' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp-sales - resourceType: folder - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored folders in the JSON response body if they belong to the organization. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a folder under an organization - tags: - - Hierarchy - x-permission: bxp:folder-read - x-persistence: false - x-private-path: /resources/{folder_id} - x-scope: documentation,public - parameters: - - description: ID of the folder. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: folder_id - required: true - schema: - format: uuid - type: string - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates a folder under the specified organization with partial information. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: netapp-sales - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_patch_request_body' - description: Replaces the specified attributes in the request body with the values provided. - required: true - responses: - "204": - description: Indicates if the folder was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Partially update a folder. - tags: - - Hierarchy - x-permission: bxp:folder-modify - x-scope: documentation,private,public - put: - description: Replaces a folder under the specified organization with new information. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: netapp-sales - resourceType: folder - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_put_request_body' - description: Replaces the entire stored folder with the supplied JSON request body while preserving the key values that are not user-modifiable. - required: true - responses: - "204": - description: Indicates if the folder was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Modify a specific folder - tags: - - Hierarchy - x-permission: bxp:folder-modify - x-private-path: /resources/{folder_id} - x-scope: documentation,private,public - /organizations/{organization_id}/organizations/{childorganization_id}: - delete: - description: Removes the specified child organization from a parent organization. - responses: - "204": - description: Indicates if the child organization was removed from the parent organization. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a child organization from a parent organization - tags: - - Hierarchy - x-permission: bxp:organization-delete - x-persistence: false - x-scope: documentation,private,public - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - - description: ID of the child organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: childorganization_id - required: true - schema: - format: uuid - type: string - /organizations/{organization_id}/projects: - get: - description: Lists all projects under the specified organization. - parameters: - - description: ID of the folder. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: folder_id - required: true - schema: - format: uuid - type: string - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of all projects under an organization. - headers: - Location: - description: Location of projects under the organization. - schema: - format: uri - type: string - "401": - $ref: '#/components/responses/401Unauthorized' - summary: List all projects under an organization - tags: - - Hierarchy - x-cache-control: no-cache - x-permission: bxp:project-read - x-persistence: false - x-private-path: /resources - x-scope: documentation,public - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - post: - description: Creates a new project under the specified organization. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - name: netapp-project-1 - resourceType: project - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_request_body' - description: Indicates the desired values for the project to be created under an organization. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp-project-1 - resourceType: project - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_response_body' - description: Returns the newly created project in the JSON response body. - headers: - Location: - description: Location of the newly created project. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new project resource - tags: - - Hierarchy - x-permission: bxp:project-create - x-persistence: false - x-private-path: /resources - x-scope: documentation,public - /organizations/{organization_id}/projects/{project_id}: - delete: - description: Removes a project from the specified organization. - responses: - "204": - description: Indicates if the project was removed from an organization. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a project from an organization - tags: - - Hierarchy - x-permission: bxp:project-delete - x-persistence: false - x-scope: documentation,private,public - get: - description: Retrieves a project under the specified organization. - parameters: - - $ref: '#/components/parameters/filter' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp-project-1 - resourceType: project - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored project in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a project under an organization - tags: - - Hierarchy - x-permission: bxp:project-read - x-persistence: true - x-private-path: /resources/{project_id} - x-scope: documentation,public - parameters: - - description: ID of the project. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: project_id - required: true - schema: - format: uuid - type: string - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates a project under the specified organization with partial information. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: netapp-project-1 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_patch_request_body' - description: Replaces the specified attributes in the request body with the values provided. - required: true - responses: - "204": - description: Indicates if the project was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Partially update a project - tags: - - Hierarchy - x-permission: bxp:project-modify - x-persistence: false - x-private-path: /resources/{project_id} - x-scope: documentation,private,public - put: - description: Replaces a project under the specified organization with new information. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: netapp-project-1 - resourceType: project - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_put_request_body' - description: Replaces the entire stored project with the supplied JSON request body while preserving the key values that are not user-modifiable. - required: true - responses: - "204": - description: Indicates if the project was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Modify a specific project - tags: - - Hierarchy - x-permission: bxp:project-modify - x-persistence: false - x-private-path: /resources/{project_id} - x-scope: documentation,private,public - /organizations/{organization_id}/resourcegroups: - get: - description: Lists all resource groups under the specified organization. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resourcegroups+json: - schema: - $ref: '#/components/schemas/resourcegroup_1.0_list_response_body' - description: List of all resource groups in an organization. - headers: - Location: - description: Location of the resource groups. - schema: - format: uri - type: string - summary: List all Resourcegroups under an organization - tags: - - Resource and Resourcegroup - x-cache-control: no-cache - x-permission: bxp:resourcegroup-read - x-persistence: true - x-scope: documentation,public - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - post: - description: Adds resource groups to the specified organization. - requestBody: - content: - application/vnd.netapp.bxp.resourcegroupbulk+json: - example: - resourcegroups: - - id: a94ac68f-ea20-47aa-add8-8d41be0d8466 - name: StorageAdmin - - name: StorageAdmin - type: application/vnd.netapp.bxp.resourcegroupbulk - version: "1.0" - schema: - $ref: '#/components/schemas/resourcegroup_1.0_post_bulk_id_request_body' - description: Indicates the resource groups to be added. - required: true - responses: - "202": - description: Indicates that the resourcegroup request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add resourcegroups to a organization. - tags: - - Resource and Resourcegroup - x-permission: bxp:resourcegroup-create - x-persistence: true - x-scope: documentation,private,public - /organizations/{organization_id}/resourcegroups/{resourcegroup_id}: - delete: - description: Removes a resource group from the specified organization. - responses: - "204": - description: Indicates if the resource group was removed from an organization. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a resource group from an organization - tags: - - Resource and Resourcegroup - x-permission: bxp:resourcegroup-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a resource group under the specified organization. - responses: - "200": - content: - application/vnd.netapp.bxp.resourcegroup+json: - example: - description: This resourcegroup is part of NetApp sales group - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: AcmeUsers - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - tags: - - internal:bxp:organizationId: a411662b-98b7-4137-a726-cd0f9f54a471 - type: application/vnd.netapp.bxp.resourcegroup - version: "1.0" - schema: - $ref: '#/components/schemas/resourcegroup_1.0_get_response_body' - description: Returns the stored resource group in the JSON response body if it belongs to the organization. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a Resourcegroup under an organization - tags: - - Resource and Resourcegroup - x-permission: bxp:resourcegroup-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - - description: ID of the resource group. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resourcegroup_id - required: true - schema: - format: uuid - type: string - /organizations/{organization_id}/resources: - get: - description: Lists all resources under the specified organization. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of resources under an organization. - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: List all resources under an organization - tags: - - Resource and Resourcegroup - x-cache-control: no-cache - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,public - parameters: - - description: Organization ID used to display resources. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - post: - description: Adds resources to the specified organization. - requestBody: - content: - application/vnd.netapp.bxp.resourcebulk+json: - example: - resources: - - a94ac68f-ea20-47aa-add8-8d41be0d8466 - - b04ac68f-da27-578a-cee8-9e45bq0d8466 - type: application/vnd.netapp.bxp.resourcebulk - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_bulk_id_request_body' - description: Indicates the resources to add to the folder. - required: true - responses: - "202": - description: Indicates the resources request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add resources to an organization - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-create - x-persistence: true - x-scope: documentation,private,public - /organizations/{organization_id}/resources/{resource_id}: - delete: - description: Removes a resource from the specified organization. - responses: - "204": - description: Indicates if the resource was removed from the organization. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a resource from an organization - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a resource under the specified organization. - parameters: - - $ref: '#/components/parameters/filter' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - description: Added a resource of resourceType volume - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: volume-1 - rawId: cluster-1-volume-1 - resourceType: volume - tags: - - internal:bxp:organizationId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored resource in the JSON response body if it belongs to the organization. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a resource under an organization - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - - description: ID of the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - /organizations/{organization_id}/roles/{role_id}/usergroups: - post: - description: Creates a new user group. - requestBody: - content: - application/vnd.netapp.bxp.usergroup+json: - example: - description: This tag represents NetApp Sales Territory - name: fed-pepsico-com-samlp_admin - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.usergroup - usergroupType: USERGROUP - version: "1.0" - schema: - $ref: '#/components/schemas/usergroup_1.0_post_request_body' - description: Indicates the desired values for the user group to be created. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.usergroup+json: - example: - description: This tag represents NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: fed-pepsico-com-samlp_admin - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.usergroup - usergroupType: USERGROUP - version: "1.0" - schema: - $ref: '#/components/schemas/usergroup_1.0_post_response_body' - description: Returns the newly created user group in the JSON response body. - headers: - Location: - description: Location of the newly created resource. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new user group - tags: - - User and Usergroup - x-permission: bxp:usergroup-create - x-persistence: true - x-scope: documentation,private,public - /organizations/{organization_id}/roles/{role_id}/users: - post: - description: Associates users with a role under the specified organization. - parameters: - - in: path - name: organization_id - required: true - schema: - type: string - - in: path - name: role_id - required: true - schema: - type: string - requestBody: - content: - application/vnd.netapp.bxp.userbulk+json: - example: - type: application/vnd.netapp.bxp.userbulk - users: - - aadId: a94ac68f-ea20-47aa-add8-8d41be0d8466 - userId: e837c373-2ec4-47a8-b016-ba430ebce321 - - auth0Id: auth0|5a09551d0d9ef535b823bd3f - userId: f837c373-2ec4-47a8-b016-ba430ebce321 - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_post_scope_object_bulk_id_request_body' - description: Indicates the desired values to associate multiple users with a specific role under an organization. - required: true - responses: - "202": - description: Indicates the users request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Associate users with an organization and a role - tags: - - User and Usergroup - x-permission: bxp:user-create - x-persistence: true - x-scope: documentation,private,public - /organizations/{organization_id}/roles/{role_id}/users/{user_id}: - delete: - description: Removes a user from the specified organization. - responses: - "204": - description: Indicates if the user was removed from the organization. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a user from an organization - tags: - - User and Usergroup - x-permission: bxp:user-delete - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - - description: ID of the user. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - - description: ID of the role. - example: 778f8579-a5b1-48ab-91c5-361acc2ee7fe - in: path - name: role_id - required: true - schema: - format: uuid - type: string - /organizations/{organization_id}/serviceAccounts: - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - post: - description: Creates a service account under an organization. - requestBody: - content: - application/vnd.netapp.bxp.user+json: - example: - name: service-account-1 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_post_request_body' - description: Indicates the desired values for the service account to be created. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0ClientSecret: Ka6heC13VEq5oWSw5s1Ms_iY2vd8EzIfYKPN8mqtJaLLkyuMDLhOCy0SO3x8onr2 - auth0Id: KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: service-account-1 - type: application/vnd.netapp.bxp.user+json - userType: serviceAccount - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_post_response_body' - description: Returns the newly created service account in the JSON response body. - headers: - Location: - description: Location of the newly created service account resource. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a service account under an organization - tags: - - User and Usergroup - x-permission: bxp:serviceaccount-create - x-persistence: false - x-private-path: /users - x-scope: documentation,public - /organizations/{organization_id}/serviceAccounts/{serviceaccount_id}: - delete: - description: Deletes a service account under an organization. - responses: - "204": - description: Indicates if the service account was deleted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Delete a service account under an organization - tags: - - User and Usergroup - x-permission: bxp:serviceaccount-delete - x-persistence: false - x-private-path: /users/{serviceaccount_id} - x-scope: documentation,public - get: - description: Retrieves a service account under an organization. - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - description: Adding user to NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: user-1 - state: ACTIVE - tags: - - internal:bxp:usergroupId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - userType: serviceAccount - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_get_response_body' - description: Returns the stored user in the JSON response body if it belongs to the user group. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a service account for an organization - tags: - - User and Usergroup - x-permission: bxp:serviceaccount-read - x-persistence: false - x-private-path: /users/{serviceaccount_id} - x-scope: documentation,public - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - - description: ID of the service account. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: serviceaccount_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates a service account under an organization with partial information. - requestBody: - content: - application/vnd.netapp.bxp.user+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: service-account-1 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_patch_request_body' - description: Replaces the specified attributes in the request body with the values provided. - required: true - responses: - "204": - description: Indicates if the service account was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Partially update a service account - tags: - - User and Usergroup - x-permission: bxp:serviceaccount-modify - x-persistence: false - x-private-path: /users/{serviceaccount_id} - x-scope: documentation,public - put: - description: Updates a service account under an organization. - requestBody: - content: - application/vnd.netapp.bxp.user+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: service-account-1 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_put_request_body' - description: Replaces the entire stored service account with the supplied JSON request body while preserving the key values that are not user-modifiable. - required: true - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: service-account-1 - type: application/vnd.netapp.bxp.user - userType: serviceAccount - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_put_response_body' - description: Indicates if the service account was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Update a service account under an organization - tags: - - User and Usergroup - x-permission: bxp:serviceaccount-modify - x-persistence: false - x-private-path: /users/{serviceaccount_id} - x-scope: documentation,public - /organizations/{organization_id}/serviceAccounts/{serviceaccount_id}/clientSecret: - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - - description: ID of the service account. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: serviceaccount_id - required: true - schema: - format: uuid - type: string - post: - description: Creates a new client secret for the specified service account. - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0ClientSecret": 5z3av5A-fk3JXStnPIn_3klyPrVlDXP0r5aYyuE7Ex_m_hcaN4WxGP1mr_ocq6wL - auth0Id: KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: service-account-1 - type: application/vnd.netapp.bxp.user - userType: serviceAccount - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_put_response_body' - description: Indicates if the service account was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new client secret for a service account - tags: - - User and Usergroup - x-permission: bxp:serviceaccount-clientsecret-create - x-persistence: false - x-private-path: /users/{serviceaccount_id} - x-scope: documentation,public - /organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys: - get: - description: Lists all public keys for the specified service account. - responses: - "200": - content: - application/vnd.netapp.bxp.publickeys+json: - schema: - $ref: '#/components/schemas/user_1.0_public_key_list_response_body' - description: List of all public keys for the service account. - headers: - Location: - description: Location of the resource. - schema: - format: uri - type: string - summary: List all the public keys for a service account - tags: - - User and Usergroup - x-permission: bxp:user-read - x-persistence: false - x-private-path: /users/{serviceaccount_id}/publickeys - x-scope: documentation,public - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - - description: ID of the service account. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: serviceaccount_id - required: true - schema: - format: uuid - type: string - post: - description: Creates a public key for the specified service account. - requestBody: - content: - application/vnd.netapp.bxp.publickey+json: - example: - expirationTimestamp: "2026-06-24T16:25:08Z" - publicKey: '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0B...\n-----END PUBLIC KEY-----\n' - type: application/vnd.netapp.bxp.publickey - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_public_key_post_request_body' - description: Indicates the desired values for the public key to be created. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.publickey+json: - example: - audience: https://netapp-cloud-account.auth0.com/ - expirationTimestamp: "2026-06-24T16:25:08Z" - fingerprint: 33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8 - id: 4336388b-2992-43af-81de-ba9284b7dc36 - keyType: RSA_KEY - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2025-06-24T16:25:08Z" - modificationTimestamp: "2025-06-24T16:25:08Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - state: ENABLED - type: application/vnd.netapp.bxp.publickey+json - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_public_key_post_response_body' - description: Returns information about the newly created public key in the JSON response body. - headers: - Location: - description: Location of the newly created public key resource. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a public key for a service account - tags: - - User and Usergroup - x-permission: bxp:user-modify - x-persistence: false - x-private-path: /users/{serviceaccount_id}/publickeys - x-scope: documentation,public - /organizations/{organization_id}/serviceaccounts/{serviceaccount_id}/publickeys/{publickey_id}: - delete: - description: Deletes a public key for the specified service account. - responses: - "204": - description: Indicates if the public key was deleted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Delete a public key for a service account - tags: - - User and Usergroup - x-permission: bxp:user-modify - x-persistence: false - x-private-path: /users/{serviceaccount_id}/publickeys/{publickey_id} - x-scope: documentation,public - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - - description: ID of the service account. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: serviceaccount_id - required: true - schema: - format: uuid - type: string - - description: ID of the public key. - example: 778f8579-a5b1-48ab-91c5-361acc2ee7fe - in: path - name: publickey_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates a public key for the specified service account with partial information. - requestBody: - content: - application/vnd.netapp.bxp.publickey+json: - example: - stateDesired: DISABLED - type: application/vnd.netapp.bxp.publickey - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_public_key_patch_request_body' - description: Replaces the specified attributes in the request body with the values provided. - required: true - responses: - "204": - description: Indicates if the public key was updated. - summary: Partially update a public key for a service account - tags: - - User and Usergroup - x-permission: bxp:user-modify - x-persistence: false - x-private-path: /users/{serviceaccount_id}/publickeys/{publickey_id} - x-scope: documentation,public - /organizations/{organization_id}/usergroups: - get: - description: Lists all user groups under the specified organization. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.usergroups+json: - schema: - $ref: '#/components/schemas/usergroup_1.0_list_response_body' - description: List of all user groups in the organization. - headers: - Location: - description: Location of user groups. - schema: - format: uri - type: string - summary: List all the Usergroups under an Organization - tags: - - User and Usergroup - x-cache-control: no-cache - x-permission: bxp:usergroup-read - x-persistence: true - x-scope: documentation,public - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - post: - description: Adds user groups to the specified organization. - requestBody: - content: - application/vnd.netapp.bxp.usergroupbulk+json: - example: - type: application/vnd.netapp.bxp.usergroupbulk - usergroups: - - id: a94ac68f-ea20-47aa-add8-8d41be0d8466 - - name: StorageAdmin - version: "1.0" - schema: - $ref: '#/components/schemas/usergroup_1.0_post_bulk_id_request_body' - description: Indicates the user groups to be added. - required: true - responses: - "202": - description: Indicates the usergroups request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add Usergroups to an organization. - tags: - - User and Usergroup - x-permission: bxp:usergroup-create - x-persistence: true - x-scope: documentation,private,public - /organizations/{organization_id}/usergroups/{usergroup_id}: - delete: - description: Removes a user group from the specified organization. - responses: - "204": - description: Indicates if the user group was removed from the organization. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a Usergroup from an organization - tags: - - User and Usergroup - x-permission: bxp:usergroup-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a user group under the specified organization. - responses: - "200": - content: - application/vnd.netapp.bxp.usergroup+json: - example: - description: This tag represents NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: AcmeUsers - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - tags: - - internal:bxp:organizationId: 36d4cc43-0b0f-4363-b922-eed1d80f8ea6 - type: application/vnd.netapp.bxp.usergroup - version: "1.0" - schema: - $ref: '#/components/schemas/usergroup_1.0_get_response_body' - description: Returns the stored user group in the JSON response body if it belongs to the organization. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a Usergroup under an organization - tags: - - User and Usergroup - x-permission: bxp:usergroup-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - - description: ID of the user group. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: usergroup_id - required: true - schema: - format: uuid - type: string - /organizations/{organization_id}/users: - get: - description: Lists all users under the specified organization. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.users+json: - schema: - $ref: '#/components/schemas/user_1.0_list_response_body' - description: List of all users. - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: List all users under an organization - tags: - - User and Usergroup - x-cache-control: no-cache - x-permission: bxp:user-read - x-persistence: true - x-private-path: /resources/{organization_id}/users - x-scope: documentation,public - parameters: - - description: Organization ID used to display users. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - post: - description: Adds users to the specified organization. - requestBody: - content: - application/vnd.netapp.bxp.userbulk+json: - example: - type: application/vnd.netapp.bxp.userbulk - users: - - a94ac68f-ea20-47aa-add8-8d41be0d8466 - - b04ac68f-da27-578a-cee8-9e45bq0d8466 - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_post_bulk_id_request_body' - description: Indicates the users to be added. - required: true - responses: - "202": - description: Indicates the users request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add users to an organization - tags: - - User and Usergroup - x-permission: bxp:user-create - x-persistence: true - x-scope: documentation,private,public - /organizations/{organization_id}/users/{user_id}: - delete: - description: Removes a user from the specified organization. - responses: - "204": - description: Indicates if the user was removed from an organization. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a user from an organization - tags: - - User and Usergroup - x-permission: bxp:user-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a user under the specified organization. - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - description: Adding user to NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: user-1 - state: ACTIVE - tags: - - internal:bxp:organizationId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_get_response_body' - description: Returns the stored user in the JSON response body if it belongs to the organization. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a user under an organization - tags: - - User and Usergroup - x-permission: bxp:user-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: organization_id - required: true - schema: - format: uuid - type: string - - description: ID of the user. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - patch: - description: Allow role(s) elevation or downscope for the specified user/organization - requestBody: - content: - application/vnd.netapp.bxp.userelevated+json: - example: - elevatedStateDesired: ELEVATED - schema: - $ref: '#/components/schemas/userelevated_1.0_patch_request_body' - description: Replaces the specified attributes in the request body with the values provided. - required: true - responses: - "204": - description: Indicates if the user was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Modify a user - tags: - - User and Usergroup - x-permission: bxp:user-modify - x-persistence: true - x-scope: documentation,private,public - /partnerships: - get: - description: Retrieves a list of all partnerships. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.partnerships+json: - example: - count: 2 - items: - - destinationOrganizationId: 666a3f38-d4fa-5b62-a391-a69029758d32 - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: Partnership between Prov and Acme - ownerOrganizationId: 8f84cf09-8036-51e4-b579-bd30cb07b269 - partnershipType: msp - sourceOrganizationId: 8f84cf09-8036-51e4-b579-bd30cb07b269 - state: APPROVED - type: application/vnd.netapp.bxp.partnership - version: "1.0" - - destinationOrganizationId: 467a3f38-d4fa-5b62-a391-a69029758d32 - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: Partnership between SubProv and Acme - ownerOrganizationId: 8f84cf09-8036-51e4-b579-bd30cb07b269 - partnershipType: reseller - sourceOrganizationId: 8f84cf09-8036-51e4-b579-bd30cb07b269 - state: APPROVED - type: application/vnd.netapp.bxp.partnership - version: "1.0" - schema: - $ref: '#/components/schemas/partnership_1.0_list_response_body' - description: List of partnerships. - headers: - Location: - description: Location of the partnerships. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: List all the partnership resources - tags: - - Partnership - x-permission: bxp:partnership-read - x-persistence: false - x-scope: private,public,documentation - post: - description: Creates a new partnership. - requestBody: - content: - application/vnd.netapp.bxp.partnership+json: - example: - destinationOrganizationId: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: Partnership between Prov and Acme - ownerOrganizationId: 8f84cf09-8036-51e4-b579-bd30cb07b269 - partnershipType: msp - sourceOrganizationId: 8f84cf09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.partnership - version: "1.0" - schema: - $ref: '#/components/schemas/partnership_1.0_post_request_body' - description: Indicates the desired values for the partnership to be created. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.partnership+json: - example: - destinationOrganizationId: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: Partnership between Prov and Acme - ownerOrganizationId: 8f84cf09-8036-51e4-b579-bd30cb07b269 - partnershipType: msp - sourceOrganizationId: 8f84cf09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.partnership - version: "1.0" - schema: - $ref: '#/components/schemas/partnership_1.0_post_response_body' - description: Returns the newly created partnership resource in the JSON response body. - headers: - Location: - description: Location of the newly created partnership resource. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Creates a new partnership resource - tags: - - Partnership - x-permission: bxp:partnership-create - x-persistence: false - x-scope: public,private,documentation - /partnerships/{partnership_id}: - delete: - description: Deletes the specified partnership. - responses: - "204": - description: Indicates that the partnership resource was successfully deleted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a partnership from the list of partnerships - tags: - - Partnership - x-permission: bxp:partnership-delete - x-persistence: false - x-scope: private,public,documentation - get: - description: Retrieves information about the specified partnership. - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - destinationOrganizationId: 666a3f38-d4fa-5b62-a391-a69029758d32 - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: Partnership between Prov and Acme - ownerOrganizationId: 8f84cf09-8036-51e4-b579-bd30cb07b269 - partnershipType: msp - sourceOrganizationId: 8f84cf09-8036-51e4-b579-bd30cb07b269 - state: APPROVED - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/partnership_1.0_get_response_body' - description: Returns the stored partnership in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieves a specific partnership resource - tags: - - Partnership - x-permission: bxp:partnership-read - x-persistence: false - x-scope: private,public,documentation - parameters: - - description: ID of the partnership. A partnership includes a type, a source organization, and a destination organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnership_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates the specified partnership with partial information. - requestBody: - content: - application/vnd.netapp.bxp.partnership+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - stateDesired: APPROVED - type: application/vnd.netapp.bxp.partnership - version: "1.0" - schema: - $ref: '#/components/schemas/partnership_1.0_patch_request_body' - description: Replaces the specified attributes in the request body with the values provided. - required: true - responses: - "204": - description: Indicates if the partnershipType resource was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Partially updates an partnership resource - tags: - - Partnership - x-permission: bxp:partnership-modify - x-persistence: true - x-scope: private,public,documentation - /partnerships/{partnership_id}/grants: - get: - description: Lists all the grants for the specified partnership. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.grant+json: - schema: - $ref: '#/components/schemas/grant_1.0_list_response_body' - application/vnd.netapp.bxp.grants+json: - example: - count: 2 - items: - - description: Associate users to manage Dev pool - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: ScopeAdminGrant - role: 9e94cf09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.grant - version: "1.0" - - description: Associate users to manage Prod pool - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: StorageAdminGrant - role: 9e94cf09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.grant - version: "1.0" - description: List of all grants. - headers: - Location: - description: Location of the newly created resource. - schema: - format: uri - type: string - summary: List all the grants resources from a partnership - tags: - - Partnership - x-permission: bxp:grant-read,bxp:partnership-read - x-persistence: true - x-scope: private,public,documentation - parameters: - - description: ID of the partnership resource. A partnership includes a type and a provider organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnership_id - required: true - schema: - format: uuid - type: string - post: - description: Creates a new grant in the specified partnership. - requestBody: - content: - application/vnd.netapp.bxp.grant+json: - example: - description: Associate users to manage Prod pool - name: ScopeAdminGrant - resources: - - a94ac68f-ea20-47aa-add8-8d41be0d8466 - - b04ac68f-da27-578a-cee8-9e45bq0d8466 - role: 9e94cf09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.grant - users: - - userId: e837c373-2ec4-47a8-b016-ba430ebce321 - - auth0Id: auth0|5a09551d0d9ef535b823bd3f - - emailId: test@netapp.com - version: "1.0" - schema: - $ref: '#/components/schemas/grant_1.0_post_request_body' - description: Indicates the desired values for the grant resource to be created. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.grant+json: - example: - description: Associate users to manage Dev pool - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - role: 9e94cf09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.grant - version: "1.0" - schema: - $ref: '#/components/schemas/grant_1.0_post_response_body' - description: Returns the newly created grant resource in the JSON response body. - headers: - Location: - description: Location of the newly created resource. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Creates a new Grant resource - tags: - - Partnership - x-permission: bxp:grant-create,bxp:partnership-manage - x-persistence: true - x-scope: private,public,documentation - /partnerships/{partnership_id}/grants/{grant_id}: - delete: - description: Deletes the specified grant from a partnership. - responses: - "204": - description: Indicates that the grant resource was successfully deleted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Deletes a specific Grant resource - tags: - - Partnership - x-permission: bxp:grant-delete,bxp:partnership-manage - x-persistence: true - x-scope: private,public,documentation - get: - description: Retrieves the specified grant and its components from a partnership. - responses: - "200": - content: - application/vnd.netapp.bxp.grant+json: - example: - description: Associate users to manage Dev pool - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: ScopeAdminGrant - role: 9e94cf09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.grant - version: "1.0" - schema: - $ref: '#/components/schemas/grant_1.0_get_response_body' - description: Returns the stored grant resource in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieves a specific grant from a partnership - tags: - - Partnership - x-permission: bxp:grant-read,bxp:partnership-read - x-persistence: true - x-scope: private,public,documentation - parameters: - - description: ID of the partnership resource. A partnership includes a type and a provider organization. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnership_id - required: true - schema: - format: uuid - type: string - - description: Grant ID. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: grant_id - required: true - schema: - format: uuid - type: string - /partnerships/{partnership_id}/grants/{grant_id}/resources: - get: - description: Lists all resources under the specified grant of a partnership. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of resources under the specified grant of a specific partnership. - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: List all resources under the specified grant of a specific partnership. - tags: - - Resource and Resourcegroup - - Partnership - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the partnership. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnership_id - required: true - schema: - format: uuid - type: string - - description: ID of the grant used to display users. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: grant_id - required: true - schema: - format: uuid - type: string - post: - description: Adds resources to the specified grant of a partnership. - requestBody: - content: - application/vnd.netapp.bxp.resourcebulk+json: - example: - resources: - - a94ac68f-ea20-47aa-add8-8d41be0d8466 - - b04ac68f-da27-578a-cee8-9e45bq0d8466 - type: application/vnd.netapp.bxp.resourcebulk - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_bulk_id_request_body' - description: Indicates the resources to add to the specified grant of a specific partnership. - required: true - responses: - "202": - description: Indicates the resources request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add resources to a folder - tags: - - Resource and Resourcegroup - - Partnership - x-permission: bxp:resource-create - x-persistence: true - x-scope: documentation,private,public - /partnerships/{partnership_id}/grants/{grant_id}/resources/{resource_id}: - delete: - description: Removes a resource from the specified grant of a partnership. - responses: - "204": - description: Indicates if the resource was removed from the specified grant of a specific partnership. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a resource from the specified grant of a specific partnership. - tags: - - Resource and Resourcegroup - - Partnership - x-permission: bxp:resource-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a resource under the specified grant of a partnership. - parameters: - - $ref: '#/components/parameters/filter' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - description: Added a resource of resourceType volume - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: volume-1 - rawId: cluster-1-volume-1 - resourceType: volume - tags: - - internal:bxp:folderId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored resource in the JSON response body if it belongs to the specified grant of a specific partnership. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a resource under a folder - tags: - - Resource and Resourcegroup - - Partnership - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the partnership. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnership_id - required: true - schema: - format: uuid - type: string - - description: ID of the grant used to display users. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: grant_id - required: true - schema: - format: uuid - type: string - - description: ID of the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - /partnerships/{partnership_id}/grants/{grant_id}/users: - get: - description: Lists all users in the specified grant for a partnership. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.users+json: - schema: - $ref: '#/components/schemas/user_1.0_list_response_body' - description: Lists all users in the specified grant for a specific partnership. - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: List all users for a grant in a partnership - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-read,bxp:partnership-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the partnership used to display users. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnership_id - required: true - schema: - format: uuid - type: string - - description: ID of the grant used to display users. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: grant_id - required: true - schema: - format: uuid - type: string - post: - description: Adds users to the specified grant in a partnership. - requestBody: - content: - application/vnd.netapp.bxp.userbulk+json: - example: - description: Adding users to the ClusterManagement grant of Wipro partnership - type: application/vnd.netapp.bxp.userbulk - users: - - aadId: a94ac68f-ea20-47aa-add8-8d41be0d8466 - - userId: f837c373-2ec4-47a8-b016-ba430ebce321 - - emailId: test@netapp.com - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_post_scope_object_bulk_id_request_body' - description: Indicates the users to be added. - required: true - responses: - "202": - description: Indicates the users request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add users to a specific grant in a specific partnership. - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-create,bxp:partnership-manage - x-persistence: true - x-scope: documentation,private,public - /partnerships/{partnership_id}/grants/{grant_id}/users/{user_id}: - delete: - description: Removes a user from the specified grant in a partnership. - responses: - "204": - description: Indicates that the user was removed from the specified grant in a specific partnership. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a specific user from the specified grant in a specific partnership - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a user in the specified grant in a partnership. - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - isServiceAccount: false - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: user-1 - state: ACTIVE - tags: - - internal:bxp:usergroupId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_get_response_body' - description: Returns the stored user in the JSON response body if it belongs to the specified grant from a specific partnership. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a user in specified grant from a specific partnership - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-read,bxp:partnership-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the partnership. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnership_id - required: true - schema: - format: uuid - type: string - - description: ID of the user. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - - description: ID of the grant used to display users. - example: 778f8579-a5b1-48ab-91c5-361acc2ee7fe - in: path - name: grant_id - required: true - schema: - format: uuid - type: string - /partnerships/{partnership_id}/resourceadmins: - get: - description: Lists all users with the ResourceAdmin role in the specified partnership. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.users+json: - schema: - $ref: '#/components/schemas/user_1.0_list_response_body' - description: List of all users for this partnership with the ResourceAdmin role. - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: List all users for a partnership - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-read,bxp:partnership-read - x-persistence: true - x-scope: documentation,public,private - parameters: - - description: ID of the partnership used to display users with the ResourceAdmin role. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnership_id - required: true - schema: - format: uuid - type: string - post: - description: Adds users to the ResourceAdmin role in the specified partnership. - requestBody: - content: - application/vnd.netapp.bxp.userbulk+json: - example: - description: Adding user to the partnership ResourceAdmin with Acme - type: application/vnd.netapp.bxp.userbulk - users: - - userId: e837c373-2ec4-47a8-b016-ba430ebce321 - - auth0Id: auth0|5a09551d0d9ef535b823bd3f - - emailId: test@netapp.com - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_post_scope_object_bulk_id_request_body' - description: Indicates the users to be added. - required: true - responses: - "202": - description: Indicates the users request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add users to a partnership ResourceAdmin Role. - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-create,bxp:partnership-manage - x-persistence: true - x-scope: documentation,private,public - /partnerships/{partnership_id}/resourceadmins/{user_id}: - delete: - description: Removes a user from the ResourceAdmin group in the specified partnership. - responses: - "204": - description: Indicates that the user was removed from a partnership ResourceAdmin group. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a specific user from a partnership ResourceAdmin group - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a user in the ResourceAdmin group of the specified partnership. - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - isServiceAccount: false - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: user-1 - state: ACTIVE - tags: - - internal:bxp:usergroupId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_get_response_body' - description: Returns the stored user in the JSON response body if it belongs to the partnership ResourceAdmin group. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a user in a partnership ResourceAdmin group - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-read,bxp:partnership-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the partnership. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnership_id - required: true - schema: - format: uuid - type: string - - description: ID of the user. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - /partnerships/{partnership_id}/useradmins: - get: - description: Lists all users with the UserAdmin role in the specified partnership. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.users+json: - schema: - $ref: '#/components/schemas/user_1.0_list_response_body' - description: List of all users for this partnership with the UserAdmin role. - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: List all users for a partnership - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-read,bxp:partnership-read - x-persistence: true - x-scope: documentation,public,private - parameters: - - description: ID of the partnership used to display users with the UserAdmin role. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnership_id - required: true - schema: - format: uuid - type: string - post: - description: Adds users with the UserAdmin role to the specified partnership. - requestBody: - content: - application/vnd.netapp.bxp.userbulk+json: - example: - description: Adding user to the partnership UserAdmin with Acme - type: application/vnd.netapp.bxp.userbulk - users: - - userId: e837c373-2ec4-47a8-b016-ba430ebce321 - - auth0Id: auth0|5a09551d0d9ef535b823bd3f - - emailId: test@netapp.com - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_post_scope_object_bulk_id_request_body' - description: Indicates the users to be added. - required: true - responses: - "202": - description: Indicates the users request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add users to a partnership UserAdmin Role. - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-create,bxp:partnership-manage - x-persistence: true - x-scope: documentation,private,public - /partnerships/{partnership_id}/useradmins/{user_id}: - delete: - description: Removes a user from the UserAdmin group of the specified partnership. - responses: - "204": - description: Indicates that the user was removed from a partnership UserAdmin group. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a specific user from a partnership UserAdmin group - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a user in the UserAdmin group in the specified partnership. - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - isServiceAccount: false - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: user-1 - state: ACTIVE - tags: - - internal:bxp:usergroupId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_get_response_body' - description: Returns the stored user in the JSON response body if it belongs to the partnership UserAdmin group. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a user in a partnership UserAdmin group - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-read,bxp:partnership-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the partnership. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnership_id - required: true - schema: - format: uuid - type: string - - description: ID of the user. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - /partnerships/{partnership_id}/users: - get: - description: Lists all users in the specified partnership. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.users+json: - schema: - $ref: '#/components/schemas/user_1.0_list_response_body' - description: List of all users for this partnership. - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: List all users for a partnership - tags: - - User and Usergroup - - Partnership - x-cache-control: no-cache - x-permission: bxp:user-read,bxp:partnership-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the partnership used to display users. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnership_id - required: true - schema: - format: uuid - type: string - post: - description: Adds users to the specified partnership. - requestBody: - content: - application/vnd.netapp.bxp.userbulk+json: - example: - description: Adding user to the partnership with Acme - type: application/vnd.netapp.bxp.userbulk - users: - - userId: e837c373-2ec4-47a8-b016-ba430ebce321 - - auth0Id: auth0|5a09551d0d9ef535b823bd3f - - emailId: test@netapp.com - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_post_scope_object_bulk_id_request_body' - description: Indicates the users to be added. - required: true - responses: - "202": - description: Indicates the users request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add users to a partnership. - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-create,bxp:partnership-manage - x-persistence: true - x-scope: documentation,private,public - /partnerships/{partnership_id}/users/{user_id}: - delete: - description: Removes a user from the specified partnership. - responses: - "204": - description: Indicates if the user was removed from a partnership. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a specific user from a partnership - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a user in the specified partnership. - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - isServiceAccount: false - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: user-1 - state: ACTIVE - tags: - - internal:bxp:usergroupId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_get_response_body' - description: Returns the stored user in the JSON response body if it belongs to the partnership. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a user in a partnership - tags: - - User and Usergroup - - Partnership - x-permission: bxp:user-read,bxp:partnership-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the partnership. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnership_id - required: true - schema: - format: uuid - type: string - - description: ID of the user. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - /partnershiptypes: - get: - description: Lists all partnership types. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.partnershiptypes+json: - schema: - $ref: '#/components/schemas/partnershiptype_1.0_list_response_body' - description: List of all partnershiptypes - headers: - Location: - description: Location of the newly created resource. - schema: - format: uri - type: string - summary: List all the partnershiptype resources in the collection - tags: - - Partnership - x-permission: bxp:partnershiptype-read - x-persistence: true - x-scope: private,public,documentation - /partnershiptypes/{partnershiptype_id}: - get: - description: Retrieves information about the specified partnership type. - responses: - "200": - content: - application/vnd.netapp.bxp.partnershiptype+json: - example: - allowOrganizationSwitch: true - description: Added new partnershipType - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: reseller - roles: - - 9e94cf09-8036-51e4-b579-bd30cb07b269 - - 09876f34-8036-51e4-b579-bd30cb07b465 - type: application/vnd.netapp.bxp.partnershiptype - version: "1.0" - schema: - $ref: '#/components/schemas/partnershiptype_1.0_get_response_body' - description: Returns the stored partnershipType in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieves a specific partnershiptype resource - tags: - - Partnership - x-permission: bxp:partnershiptype-read - x-persistence: true - x-scope: private,public,documentation - parameters: - - description: ID of the partnershipType. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: partnershiptype_id - required: true - schema: - format: uuid - type: string - /permissions: - get: - description: Lists all permissions. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.permissions+json: - example: - items: - - description: Added permission which allow user to read in aiq - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedby: 8f84cf09-8036-51e4-b579-bd30cb07b269 - rule: aiq:system-read - serviceApplication: aiq - type: application/vnd.netapp.bxp.permission - version: "1.0" - - description: Added permission which allow user to read in aiq - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedby: 8f84cf09-8036-51e4-b579-bd30cb07b269 - rule: bxp:organization-read - serviceApplication: bxp - type: application/vnd.netapp.bxp.permission - version: "1.0" - schema: - $ref: '#/components/schemas/permission_1.0_list_response_body' - description: List of all permissions. - headers: - Location: - description: Location of the newly created resource. - schema: - format: uri - type: string - summary: List all permissions - tags: - - Permission - x-cache-control: no-cache - x-permission: bxp:permission-read - x-persistence: true - x-scope: documentation,private,public - /permissions/{permission_id}: - get: - description: Retrieves the specified permission. - responses: - "200": - content: - application/vnd.netapp.bxp.permission+json: - example: - description: Added permission which allow user to read in aiq - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedby: 8f84cf09-8036-51e4-b579-bd30cb07b269 - rule: aiq:system-read - serviceApplication: aiq - type: application/vnd.netapp.bxp.permission - version: "1.0" - schema: - $ref: '#/components/schemas/permission_1.0_get_response_body' - description: Returns the stored permission in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a permission - tags: - - Permission - x-permission: bxp:permission-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the permission. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: permission_id - required: true - schema: - format: uuid - type: string - /projects: - get: - description: Lists all projects. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of all projects. - headers: - Location: - description: Location of projects. - schema: - format: uri - type: string - "401": - $ref: '#/components/responses/401Unauthorized' - summary: List all projects - tags: - - Hierarchy - x-cache-control: no-cache - x-permission: bxp:project-read - x-persistence: false - x-private-path: /resources - x-scope: documentation,public - post: - description: Creates a new project. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - name: netapp-project-1 - resourceType: project - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 48edfd48-3fed-4ffd-9aff-303c7008df7f, 999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_request_body' - description: Indicates the desired values for the project to be created. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp-project-1 - resourceType: project - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_response_body' - description: Returns the newly created project in the JSON response body. - headers: - Location: - description: Location of the newly created project. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new project - tags: - - Hierarchy - x-permission: bxp:project-create - x-persistence: false - x-private-path: /resources - x-scope: documentation,public - /projects/{project_id}: - delete: - description: Deletes the specified project. - responses: - "204": - description: Indicates if the project was deleted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Delete a project - tags: - - Hierarchy - x-permission: bxp:project-delete - x-persistence: false - x-private-path: /resources/{project_id} - x-scope: documentation,public - get: - description: Retrieves the specified project. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: netapp-project-1 - resourceType: project - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored resource in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a specific project - tags: - - Hierarchy - x-permission: bxp:project-read - x-persistence: false - x-private-path: /resources/{project_id} - x-scope: documentation,public - parameters: - - description: ID of the project. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: project_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates the specified project with partial information. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: netapp-project-1 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_patch_request_body' - description: Replaces the specified attributes in the request body with the values provided. - required: true - responses: - "204": - description: Indicates if the project was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Partially update a project - tags: - - Hierarchy - x-permission: bxp:project-modify - x-persistence: false - x-private-path: /resources/{project_id} - x-scope: documentation,public - put: - description: Replaces the specified project with new information. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: netapp-project-1 - resourceType: project - tags: - - internal:bxp:parentId: 777a3f38-d4fa-5b62-a391-a69029758d32 - - internal:bxp:ancestors: 666a3f38-d4fa-5b62-a391-a69029758d32,777a3f38-d4fa-5b62-a391-a69029758d32,48edfd48-3fed-4ffd-9aff-303c7008df7f,999a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_put_request_body' - description: Replaces the entire stored project with the supplied JSON request body while preserving the key values that are not user-modifiable. - required: true - responses: - "204": - description: Indicates if the project was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Modify a specific project - tags: - - Hierarchy - x-permission: bxp:project-modify - x-persistence: false - x-private-path: /resources/{project_id} - x-scope: documentation,public - /projects/{project_id}/resources: - get: - description: Lists all resources in the specified project. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of resources in a project. - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: List all resources in a project. - tags: - - Resource and Resourcegroup - x-cache-control: no-cache - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,public - parameters: - - description: Project ID used to display resources. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: project_id - required: true - schema: - format: uuid - type: string - post: - description: Adds resources to the specified project. - requestBody: - content: - application/vnd.netapp.bxp.resourcebulk+json: - example: - description: Added a resource of resourceType volume - resources: - - a94ac68f-ea20-47aa-add8-8d41be0d8466 - - b04ac68f-da27-578a-cee8-9e45bq0d8466 - type: application/vnd.netapp.bxp.resourcebulk - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_bulk_id_request_body' - description: Indicates the resources to add to the project. - required: true - responses: - "202": - description: Indicates the resources request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add resources to a project. - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-create - x-persistence: true - x-scope: documentation,private,public - /projects/{project_id}/resources/{resource_id}: - delete: - description: Removes a resource from the specified project. - responses: - "204": - description: Indicates if the resource was removed from the project. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a resource from a project - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a resource in a specified project. - parameters: - - $ref: '#/components/parameters/filter' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - description: Added a resource of resourceType volume - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: volume-1 - rawId: cluster-1-volume-1 - resourceType: volume - tags: - - internal:bxp:projectId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored resource in the JSON response body if it belongs to the project. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a resource in a project - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the project. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: project_id - required: true - schema: - format: uuid - type: string - - description: ID of the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - /projects/{project_id}/roles/{role_id}/usergroups: - post: - description: Creates a new user group. - requestBody: - content: - application/vnd.netapp.bxp.usergroup+json: - example: - description: This tag represents NetApp Sales Territory - name: fed-pepsico-com-samlp_admin - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.usergroup - usergroupType: USERGROUP - version: "1.0" - schema: - $ref: '#/components/schemas/usergroup_1.0_post_request_body' - description: Indicates the desired values for the user group to be created. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.usergroup+json: - example: - description: This tag represents NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: fed-pepsico-com-samlp_admin - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.usergroup - usergroupType: USERGROUP - version: "1.0" - schema: - $ref: '#/components/schemas/usergroup_1.0_post_response_body' - description: Returns the newly created user group in the JSON response body. - headers: - Location: - description: Location of the newly created resource. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new user group - tags: - - User and Usergroup - x-permission: bxp:usergroup-create - x-persistence: true - x-scope: documentation,private,public - /projects/{project_id}/roles/{role_id}/users/{user_id}: - delete: - description: Removes a user from the specified project. - responses: - "204": - description: Indicates if the user was removed from a project. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a user from a project - tags: - - User and Usergroup - x-permission: bxp:user-delete - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the project. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: project_id - required: true - schema: - format: uuid - type: string - - description: ID of the user. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - - description: ID of the role. - example: 778f8579-a5b1-48ab-91c5-361acc2ee7fe - in: path - name: role_id - required: true - schema: - format: uuid - type: string - /projects/{project_id}/users: - get: - description: Lists all users in the specified project. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.users+json: - schema: - $ref: '#/components/schemas/user_1.0_list_response_body' - description: List of all users for this project. - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: List all users for a project - tags: - - User and Usergroup - x-cache-control: no-cache - x-permission: bxp:user-read - x-persistence: true - x-private-path: /resources/{project_id}/users - x-scope: documentation,public - parameters: - - description: ID of the project used to display users. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: project_id - required: true - schema: - format: uuid - type: string - post: - description: Adds users to the specified project. - requestBody: - content: - application/vnd.netapp.bxp.userbulk+json: - example: - description: Adding user to NetApp Sales Territory - type: application/vnd.netapp.bxp.userbulk - users: - - a94ac68f-ea20-47aa-add8-8d41be0d8466 - - b04ac68f-da27-578a-cee8-9e45bq0d8466 - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_post_bulk_id_request_body' - description: Indicates the users to be added. - required: true - responses: - "202": - description: Indicates the users request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add users to a project. - tags: - - User and Usergroup - x-permission: bxp:user-create - x-persistence: true - x-scope: documentation,private,public - /projects/{project_id}/users/{user_id}: - delete: - description: Removes a user from the specified project. - responses: - "204": - description: Indicates if the user was removed from a project. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a user from a project - tags: - - User and Usergroup - x-permission: bxp:user-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a user under the specified project. - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - description: Adding user to NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: user-1 - state: ACTIVE - tags: - - internal:bxp:projectId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_get_response_body' - description: Returns the stored user in the JSON response body if it belongs to the project. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a user belonging to a project - tags: - - User and Usergroup - x-permission: bxp:user-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the project. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: project_id - required: true - schema: - format: uuid - type: string - - description: ID of the user. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - /resourcegroups: - get: - description: Lists all resource groups. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resourcegroups+json: - schema: - $ref: '#/components/schemas/resourcegroup_1.0_list_response_body' - description: List of all resource groups. - headers: - Location: - description: Location of the resource groups. - schema: - format: uri - type: string - summary: List all the resourcegroups in the collection - tags: - - Resource and Resourcegroup - x-cache-control: no-cache - x-permission: bxp:resourcegroup-read - x-persistence: true - x-scope: documentation,private,public - post: - description: Creates a new resource group. - requestBody: - content: - application/vnd.netapp.bxp.resourcegroup+json: - example: - name: AcmeSystems - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.resourcegroup - version: "1.0" - schema: - $ref: '#/components/schemas/resourcegroup_1.0_post_request_body' - description: Indicates the desired values for the resource group to be created. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.resourcegroup+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: AcmeSystems - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.resourcegroup - version: "1.0" - schema: - $ref: '#/components/schemas/resourcegroup_1.0_post_response_body' - description: Returns the newly created resource group in the JSON response body. - headers: - Location: - description: Location of the newly created resource group. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new resourcegroup - tags: - - Resource and Resourcegroup - x-permission: bxp:resourcegroup-create - x-persistence: true - x-scope: documentation,private,public - /resourcegroups/{resourcegroup_id}: - delete: - description: Deletes the specified resource group. - responses: - "204": - description: Indicates if the resource group was deleted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Delete a specific resource group - tags: - - Resource and Resourcegroup - x-permission: bxp:resourcegroup-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves the specified resource group. - responses: - "200": - content: - application/vnd.netapp.bxp.resourcegroup+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - description: This resourcegroup is part of NetApp sales group - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: AcmeSystems - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.resourcegroup - version: "1.0" - schema: - $ref: '#/components/schemas/resourcegroup_1.0_get_response_body' - description: Returns the stored resource group in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a specific resource group - tags: - - Resource and Resourcegroup - x-permission: bxp:resourcegroup-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the resource group. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resourcegroup_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates a resource group with partial information. - requestBody: - content: - application/vnd.netapp.bxp.resourcegroup+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: AcmeSystemsEurope - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.resourcegroup - version: "1.0" - schema: - $ref: '#/components/schemas/resourcegroup_1.0_patch_request_body' - description: Replaces the resource specified attributes in the request body with the values provided. - required: true - responses: - "204": - description: Indicates if the resource group was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Partially update a resource group - tags: - - Resource and Resourcegroup - x-permission: bxp:resourcegroup-modify - x-persistence: true - x-scope: documentation,private,public - put: - description: Replaces the specified resource group with new information. - requestBody: - content: - application/vnd.netapp.bxp.resourcegroup+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: AcmeSystemsUSA - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.resourcegroup - version: "1.0" - schema: - $ref: '#/components/schemas/resourcegroup_1.0_put_request_body' - description: Replaces the entire stored resource with the supplied JSON request body while preserving the key values that are not user-modifiable. - required: true - responses: - "204": - description: Indicates if the resource group was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Modify a resource group - tags: - - Resource and Resourcegroup - x-permission: bxp:resourcegroup-modify - x-persistence: true - x-scope: documentation,private,public - /resourcegroups/{resourcegroup_id}/resources: - get: - description: Lists all resources associated with a resource group. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of all resources. - headers: - Location: - description: Location of the resource. - schema: - format: uri - type: string - summary: List all the Resources for a given Resourcegroup - tags: - - Resource and Resourcegroup - x-cache-control: no-cache - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,public - parameters: - - description: ID of the resource group. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resourcegroup_id - required: true - schema: - format: uuid - type: string - post: - description: Adds resources to the specified resource group. - requestBody: - content: - application/vnd.netapp.bxp.resourcebulk+json: - example: - description: Added a resource of resourceType volume - resources: - - a94ac68f-ea20-47aa-add8-8d41be0d8466 - - b04ac68f-da27-578a-cee8-9e45bq0d8466 - type: application/vnd.netapp.bxp.resourcebulk - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_bulk_id_request_body' - description: Indicates the resources to add to the folder. - required: true - responses: - "202": - description: Indicates the resources request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add resources to a resource group - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-create - x-persistence: true - x-scope: documentation,private,public - /resourcegroups/{resourcegroup_id}/resources/{resource_id}: - delete: - description: Deletes a resource from the specified resource group. - responses: - "204": - description: Indicates if the resource was removed from a resource group. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Delete a resource from a resource group - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a resource in the specified resource group. - parameters: - - $ref: '#/components/parameters/filter' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - description: Added a resource of resourceType volume - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: volume-1 - rawId: cluster-1-volume-1 - resourceType: volume - tags: - - internal:bxp:resourcegroupId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored resource in the JSON response body if it belongs to the resource group. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieves a specific Resource belonging to a ResourceGroup - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the resource group. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resourcegroup_id - required: true - schema: - format: uuid - type: string - - description: ID of the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - /resources: - get: - description: Lists all resources. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of all resources. - headers: - Location: - description: Location of resources. - schema: - format: uri - type: string - "401": - $ref: '#/components/responses/401Unauthorized' - summary: List all resources - tags: - - Resource and Resourcegroup - x-cache-control: no-cache - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,private,public - post: - description: Creates a new resource. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - description: Added a resource of resourceType volume - name: volume-1 - rawId: cluster-1-volume-1 - resourceType: volume - tags: - - internal:bxp:organizationId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_request_body' - description: Indicates the desired values for the resource to be created. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.resource+json: - example: - description: Added a resource of resourceType volume - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: volume-1 - rawId: cluster-1-volume-1 - resourceType: volume - tags: - - internal:bxp:organizationId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_post_response_body' - description: Returns the newly created resource in the JSON response body. - headers: - Location: - description: Location of the newly created resource. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new resource - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-create - x-persistence: true - x-scope: documentation,private,public - /resources/{resource_id}: - delete: - description: Deletes the specified resource. - responses: - "204": - description: Indicates if the resource was deleted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Delete a specific resource - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves the specified resource. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - description: Added a resource of resourceType volume - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: volume-1 - rawId: cluster-1-volume-1 - resourceType: volume - tags: - - internal:bxp:organizationId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored resource in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a resource - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates the specified resource with partial information. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - description: Added a resource of resourceType volume - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: volume-1 - rawId: cluster-1-volume-1 - resourceType: volume - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_patch_request_body' - description: Replaces the specified attributes in the request body with the values provided. - required: true - responses: - "204": - description: Indicates if the resource was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Partially update a resource - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-modify - x-persistence: true - x-scope: documentation,private,public - put: - description: Replaces the specified resource with new information. - requestBody: - content: - application/vnd.netapp.bxp.resource+json: - example: - description: Added a resource of resourceType volume - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: volume-1 - rawId: cluster-1-volume-1 - resourceType: volume - tags: - - internal:bxp:organizationId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_put_request_body' - description: Replaces the entire stored resource with the supplied JSON request body while preserving the key values that are not user-modifiable. - required: true - responses: - "204": - description: Indicates if the resource was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Modify a specific resource - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-modify - x-persistence: true - x-scope: documentation,private,public - /resources/{resource_id}/permissions: - get: - description: Lists all permissions available on the specified resource. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.permissions+json: - example: - items: - - description: Added permission which allow user to read in aiq - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedby: 8f84cf09-8036-51e4-b579-bd30cb07b269 - rule: aiq:system-read - serviceApplication: aiq - type: application/vnd.netapp.bxp.permission - version: "1.0" - - description: Added permission which allow user to read in aiq - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedby: 8f84cf09-8036-51e4-b579-bd30cb07b269 - rule: bxp:organization-read - serviceApplication: bxp - type: application/vnd.netapp.bxp.permission - version: "1.0" - schema: - $ref: '#/components/schemas/permission_1.0_list_response_body' - description: List of all permissions. - headers: - Location: - description: Location of the matching permissions. - schema: - format: uri - type: string - summary: List all permissions available on the specified resource - tags: - - Permission - x-cache-control: no-cache - x-permission: bxp:permission-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - /resources/{resource_id}/permissions/{permission_id}/users: - get: - description: Lists all users with a specific permission for the specified resource. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.users+json: - schema: - $ref: '#/components/schemas/user_1.0_list_response_body' - description: List of users that have the permission on the resource. - headers: - Location: - description: Location of the collection - schema: - format: uri - type: string - summary: List all users with a permission for a resource - tags: - - User and Usergroup - x-cache-control: no-cache - x-permission: bxp:user-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - - description: ID of the permission. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: permission_id - required: true - schema: - format: uuid - type: string - /resources/{resource_id}/permissions/{permission_id}/users/{user_id}: - get: - description: Retrieves a user with a permission for a resource - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - description: Adding user to NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: user-1 - state: ACTIVE - tags: - - internal:bxp:projectId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_get_response_body' - description: Returns the stored user in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieves a user with a permission for a resource - tags: - - User and Usergroup - x-permission: bxp:user-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the user or aadId or auth0Id. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 or auth0|66e41be44594c8505b0dba75 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - - description: ID of the resource or legacyId. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 or account-Adcxyz - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - - description: ID of the permission or permission rule. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 or bxp:binding-read - in: path - name: permission_id - required: true - schema: - format: uuid - type: string - /resources/{resource_id}/users: - get: - description: Lists all users with permissions for the specified resource. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.users+json: - schema: - $ref: '#/components/schemas/user_1.0_list_response_body' - description: List of all users who have any permission on this resource - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: Lists all users with permissions for the specified resource - tags: - - User and Usergroup - x-cache-control: no-cache - x-permission: bxp:user-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - /roles: - get: - description: Lists all roles. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.roles+json: - schema: - $ref: '#/components/schemas/role_1.0_list_response_body' - description: List of all roles. - headers: - Location: - description: Location of the newly created resource. - schema: - format: uri - type: string - summary: List all roles - tags: - - Role - x-cache-control: no-cache - x-permission: bxp:role-read - x-persistence: true - x-scope: documentation,private,public - /roles/{role_id}: - get: - description: Retrieves the specified role. - responses: - "200": - content: - application/vnd.netapp.bxp.role+json: - example: - description: This role have alpha & beta permissions for NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: AstraStorageAdmin - roles: - - 33475e47-e975-48db-936d-73c53d96450b - - 04779339-9192-462c-88ee-8df050ef06c8 - type: application/vnd.netapp.bxp.role - version: "1.0" - schema: - $ref: '#/components/schemas/role_1.0_get_response_body' - description: Returns the stored role in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a specific role - tags: - - Role - x-permission: bxp:role-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the role. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: role_id - required: true - schema: - format: uuid - type: string - /roles/{role_id}/permissions: - get: - description: Lists all permissions for the specified role. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.permissions+json: - example: - items: - - description: Added permission which allow user to read in aiq - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedby: 8f84cf09-8036-51e4-b579-bd30cb07b269 - rule: aiq:system-read - serviceApplication: aiq - tags: - - internal:bxp:roleId: 9d84cf09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.permission - version: "1.0" - - description: Added permission which allow user to read in aiq - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedby: 8f84cf09-8036-51e4-b579-bd30cb07b269 - rule: bxp:organization-read - serviceApplication: bxp - tags: - - internal:bxp:roleId: 9d84cf09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.permission - version: "1.0" - schema: - $ref: '#/components/schemas/permission_1.0_list_response_body' - description: List of all permissions. - headers: - Location: - description: Location of the matching permissions. - schema: - format: uri - type: string - summary: List all permissions for a role. - tags: - - Permission - x-cache-control: no-cache - x-permission: bxp:permission-read - x-persistence: true - x-scope: documentation,public - parameters: - - description: ID of the role. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: role_id - required: true - schema: - format: uuid - type: string - /roles/{role_id}/permissions/{permission_id}: - get: - description: Retrieves a permission for the specified role. - responses: - "200": - content: - application/vnd.netapp.bxp.permission+json: - example: - description: Added permission which allow user to read in aiq - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedby: 8f84cf09-8036-51e4-b579-bd30cb07b269 - rule: aiq:system-read - serviceApplication: aiq - tags: - - internal:bxp:roleId: be845a62-652a-45b9-bb17-6e64ff19fcfc - type: application/vnd.netapp.bxp.permission - version: "1.0" - schema: - $ref: '#/components/schemas/permission_1.0_get_response_body' - description: Returns the stored permission in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a permission for a role - tags: - - Permission - x-permission: bxp:permission-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the permission. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: permission_id - required: true - schema: - format: uuid - type: string - - description: ID of the role. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: role_id - required: true - schema: - format: uuid - type: string - /usergroups: - get: - description: Lists all user groups in the collection. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.usergroups+json: - schema: - $ref: '#/components/schemas/usergroup_1.0_list_response_body' - description: List of all user groups. - headers: - Location: - description: Location of user groups. - schema: - format: uri - type: string - summary: List all user groups in the collection - tags: - - User and Usergroup - x-cache-control: no-cache - x-permission: bxp:usergroup-read - x-persistence: true - x-scope: documentation,private,public - post: - description: Creates a new user group. - requestBody: - content: - application/vnd.netapp.bxp.usergroup+json: - example: - description: This tag represents NetApp Sales Territory - name: AcmeUsers - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.usergroup - version: "1.0" - schema: - $ref: '#/components/schemas/usergroup_1.0_post_request_body' - description: Indicates the desired values for the user group to be created. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.usergroup+json: - example: - description: This tag represents NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: Acme Users - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.usergroup - version: "1.0" - schema: - $ref: '#/components/schemas/usergroup_1.0_post_response_body' - description: Returns the newly created user group in the JSON response body. - headers: - Location: - description: Location of the newly created resource. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new user group - tags: - - User and Usergroup - x-permission: bxp:usergroup-create - x-persistence: true - x-scope: documentation,private,public - /usergroups/{usergroup_id}: - delete: - description: Deletes the specified user group. - responses: - "204": - description: Indicates if the user group was deleted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Delete a specific user group - tags: - - User and Usergroup - x-permission: bxp:usergroup-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves the specified user group. - responses: - "200": - content: - application/vnd.netapp.bxp.usergroup+json: - example: - description: This tag represents NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: AcmeUsers - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.usergroup - version: "1.0" - schema: - $ref: '#/components/schemas/usergroup_1.0_get_response_body' - description: Returns the stored user group in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a specific user group - tags: - - User and Usergroup - x-permission: bxp:usergroup-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the user group. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: usergroup_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates the specified user group with partial information. - requestBody: - content: - application/vnd.netapp.bxp.usergroup+json: - example: - description: This tag represents NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: AcmeSystemsEurope - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.usergroup - version: "1.0" - schema: - $ref: '#/components/schemas/usergroup_1.0_patch_request_body' - description: Replaces the resource specified attributes in the request body with the values provided. - required: true - responses: - "204": - description: Indicates if the user group was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Partially update a user group - tags: - - User and Usergroup - x-permission: bxp:usergroup-modify - x-persistence: true - x-scope: documentation,private,public - put: - description: Replaces the specified user group with new information. - requestBody: - content: - application/vnd.netapp.bxp.usergroup+json: - example: - description: This tag represents NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: AcmeSystemsUSA - ownerOrganizationId: 6544af09-8036-51e4-b579-bd30cb07b269 - type: application/vnd.netapp.bxp.usergroup - version: "1.0" - schema: - $ref: '#/components/schemas/usergroup_1.0_put_request_body' - description: Replaces the entire stored resource with the supplied JSON request body while preserving the key values that are not user-modifiable. - required: true - responses: - "204": - description: Indicates if the user group was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Modify a specific user group - tags: - - User and Usergroup - x-permission: bxp:usergroup-modify - x-persistence: true - x-scope: documentation,private,public - /usergroups/{usergroup_id}/users: - get: - description: Lists all users for the specified user group. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.users+json: - schema: - $ref: '#/components/schemas/user_1.0_list_response_body' - description: List of all users. - headers: - Location: - description: Location of the resource. - schema: - format: uri - type: string - summary: List all users for a user group - tags: - - User and Usergroup - x-cache-control: no-cache - x-permission: bxp:user-read - x-persistence: true - x-scope: documentation,public - parameters: - - description: ID of the user group. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: usergroup_id - required: true - schema: - format: uuid - type: string - post: - description: Adds users to the specified user group. - requestBody: - content: - application/vnd.netapp.bxp.userbulk+json: - example: - type: application/vnd.netapp.bxp.userbulk - users: - - a94ac68f-ea20-47aa-add8-8d41be0d8466 - - b04ac68f-da27-578a-cee8-9e45bq0d8466 - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_post_bulk_id_request_body' - description: Indicates the users to be added. - required: true - responses: - "202": - description: Indicates the users request was accepted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Add users to a user group - tags: - - User and Usergroup - x-permission: bxp:user-create - x-persistence: true - x-scope: documentation,private,public - /usergroups/{usergroup_id}/users/{user_id}: - delete: - description: Removes a user from the specified user group. - responses: - "204": - description: Indicates if the user was removed from a user group. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Remove a specific user from a user group - tags: - - User and Usergroup - x-permission: bxp:user-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves a user in the specified user group. - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - description: Adding user to NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - isServiceAccount: false - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: user-1 - state: ACTIVE - tags: - - internal:bxp:usergroupId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_get_response_body' - description: Returns the stored user in the JSON response body if it belongs to the user group. - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a user in a user group - tags: - - User and Usergroup - x-permission: bxp:user-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the user group. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: usergroup_id - required: true - schema: - format: uuid - type: string - - description: ID of the user. - example: 118df263-44d0-4154-8daa-ff61cb471557 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - /users: - get: - description: Lists all users in the collection. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.users+json: - schema: - $ref: '#/components/schemas/user_1.0_list_response_body' - application/vnd.netapp.bxp.users.extended+json: - schema: - $ref: '#/components/schemas/user_1.0_list_response_body' - description: List of all users. - headers: - Location: - description: Location of the resource. - schema: - format: uri - type: string - summary: List all users in the collection - tags: - - User and Usergroup - x-cache-control: no-cache - x-permission: bxp:user-read - x-persistence: true - x-scope: documentation,private,public - post: - description: Indicates the desired values for the user to be created. - requestBody: - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - description: Adding user to NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: user-1 - password: '********' - stateDesired: CREATE - tags: - - internal:bxp:organizationId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_post_request_body' - description: Creates a new user. - required: true - responses: - "201": - content: - application/vnd.netapp.bxp.user+json: - example: - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: Acme Co - state: ACTIVE - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_post_response_body' - description: Returns the newly created user in the JSON response body. - headers: - Location: - description: Location of the newly created resource. - schema: - format: uri - type: string - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Create a new user. - tags: - - User and Usergroup - x-permission: bxp:user-create - x-persistence: true - x-scope: documentation,private,public - /users/{user_id}: - delete: - description: Deletes the specified user. - responses: - "204": - description: Indicates if the user was deleted. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Delete a specific user - tags: - - User and Usergroup - x-permission: bxp:user-delete - x-persistence: true - x-scope: documentation,private,public - get: - description: Retrieves the specified user. - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - description: Adding user to NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - isServiceAccount: true - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: user-1 - serviceAccount: - audience: https://netapp-cloud-account.auth0.com/ - authenticationMethod: PRIVATE_KEY_JWT - expirationNotificationPeriod: P7D - publicKeys: - items: - - audience: https://netapp-cloud-account.auth0.com/ - credentialId: cred_fh4agpsm4BphW5QZiYhHR8 - expirationTimestamp: "2024-10-01T12:00:00Z" - fingerprint: 33:0E:66:6A:D0:89:EA:78:10:7D:5A:35:FF:C5:51:E9:3A:CB:47:A8 - id: 4336388b-2992-43af-81de-ba9284b7dc36 - keyType: RSA_KEY - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: 2022-10-06T20:58:16.305662ZZ - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - state: ENABLED - type: application/vnd.netapp.bxp.publickey+json - version: "1.0" - state: ACTIVE - tags: - - internal:bxp:organizationId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_get_response_body' - description: Returns the stored user in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a specific user - tags: - - User and Usergroup - x-permission: bxp:user-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the user. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - patch: - description: Updates the specified user with partial information. - requestBody: - content: - application/vnd.netapp.bxp.user+json: - example: - description: Adding user to NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - name: user-1 - password: '********' - stateDesired: UPDATE - tags: - - internal:bxp:organizationId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_patch_request_body' - description: Replaces the specified attributes in the request body with the values provided. - required: true - responses: - "204": - description: Indicates if the user was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Partially update a user - tags: - - User and Usergroup - x-permission: bxp:user-modify - x-persistence: true - x-scope: documentation,private,public - put: - description: Replaces the specified user with new information. - requestBody: - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - description: Adding user to NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - isServiceAccount: false - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: user-1 - password: '********' - stateDesired: UPDATE - tags: - - internal:bxp:organizationId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_put_request_body' - description: Replaces the entire stored resource with the supplied JSON request body while preserving the key values that are not user-modifiable. - required: true - responses: - "200": - content: - application/vnd.netapp.bxp.user+json: - example: - auth0Id: waad|KBX6WeLgdwlmGyte01rm6Mvc7J-vYwyXHLL5jjtRltM - description: Adding user to NetApp Sales Territory - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: user-1 - state: ACTIVE - tags: - - internal:bxp:folderId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.user - version: "1.0" - schema: - $ref: '#/components/schemas/user_1.0_put_response_body' - description: Indicates if the user was updated. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - "409": - $ref: '#/components/responses/409Conflict' - summary: Modify a specific user - tags: - - User and Usergroup - x-permission: bxp:user-modify - x-persistence: true - x-scope: documentation,private,public - /users/{user_id}/partnerOrganizations: - get: - description: Lists all partnership organizations for the specified user. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of partnership organizations for the specified user. - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: Lists all partnership organizations for the specified user. - tags: - - Resource and Resourcegroup - - Partnership - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the user. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - /users/{user_id}/permissions: - get: - description: Lists all permissions for the specified user. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.permissions+json: - example: - items: - - description: Added permission which allow user to read in aiq - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedby: 8f84cf09-8036-51e4-b579-bd30cb07b269 - rule: aiq:system-read - serviceApplication: aiq - type: application/vnd.netapp.bxp.permission - version: "1.0" - - description: Added permission which allow user to read in aiq - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedby: 8f84cf09-8036-51e4-b579-bd30cb07b269 - rule: bxp:organization-read - serviceApplication: bxp - type: application/vnd.netapp.bxp.permission - version: "1.0" - schema: - $ref: '#/components/schemas/permission_1.0_list_response_body' - description: List of all permissions. - headers: - Location: - description: Location of the matching permissions. - schema: - format: uri - type: string - summary: List all permissions for a user - tags: - - Permission - x-cache-control: no-cache - x-permission: bxp:permission-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the user. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - /users/{user_id}/permissions/{permission_id}/resources: - get: - description: Lists all resources for a user with a specified permission. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of resources the user has the permission on. - headers: - Location: - description: Location of the collection - schema: - format: uri - type: string - summary: List all resources for a user with a permission - tags: - - Resource and Resourcegroup - x-cache-control: no-cache - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the user. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - - description: ID of the permission. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: permission_id - required: true - schema: - format: uuid - type: string - /users/{user_id}/permissions/{permission_id}/resources/{resource_id}: - get: - description: Retrieves a resource for which a user has given permission - parameters: - - $ref: '#/components/parameters/filter' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - description: Added a resource of resourceType volume - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: volume-1 - rawId: cluster-1-volume-1 - resourceType: volume - tags: - - internal:bxp:organizationId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored resource in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieves a resource for which a user has given permission - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the user or aadId or auth0Id. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 or auth0|66e41be44594c8505b0dba75 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - - description: ID of the permission or permission rule. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 or bxp:binding-read - in: path - name: permission_id - required: true - schema: - format: uuid - type: string - - description: ID of the resource or legacyId. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 or account-Adcxyz - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - /users/{user_id}/resources: - get: - description: Lists all resources for the specified user. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.resources+json: - schema: - $ref: '#/components/schemas/resource_1.0_list_response_body' - description: List of resources accessible to this user. - headers: - Location: - description: Location of the collection. - schema: - format: uri - type: string - summary: List all resources for a user. - tags: - - Resource and Resourcegroup - x-cache-control: no-cache - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the user. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - /users/{user_id}/resources/{resource_id}: - get: - description: Checks if a user has permission for a specified resource. - parameters: - - $ref: '#/components/parameters/filter' - responses: - "200": - content: - application/vnd.netapp.bxp.resource+json: - example: - description: Added a resource of resourceType volume - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - name: volume-1 - rawId: cluster-1-volume-1 - resourceType: volume - tags: - - internal:bxp:organizationId: 777a3f38-d4fa-5b62-a391-a69029758d32 - type: application/vnd.netapp.bxp.resource - version: "1.0" - schema: - $ref: '#/components/schemas/resource_1.0_get_response_body' - description: Returns the stored resource in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Check if a user has permission for a resource - tags: - - Resource and Resourcegroup - x-permission: bxp:resource-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - - description: ID of the user. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - /users/{user_id}/resources/{resource_id}/permissions: - get: - description: Lists all permissions a user has for the specified resource. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.permissions+json: - example: - items: - - description: Added permission which allow user to read in aiq - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedby: 8f84cf09-8036-51e4-b579-bd30cb07b269 - rule: aiq:system-read - serviceApplication: aiq - type: application/vnd.netapp.bxp.permission - version: "1.0" - - description: Added permission which allow user to read in aiq - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedby: 8f84cf09-8036-51e4-b579-bd30cb07b269 - rule: bxp:organization-read - serviceApplication: bxp - type: application/vnd.netapp.bxp.permission - version: "1.0" - schema: - $ref: '#/components/schemas/permission_1.0_list_response_body' - description: List of all permissions. - headers: - Location: - description: Location of the matching permissions. - schema: - format: uri - type: string - summary: List all permissions a user has for a resource - tags: - - Permission - x-cache-control: no-cache - x-permission: bxp:permission-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the user. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - - description: ID of the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - /users/{user_id}/resources/{resource_id}/permissions/{permission_id}: - get: - description: Retrieves a permission on a resource for the specified user. - responses: - "200": - content: - application/vnd.netapp.bxp.permission+json: - example: - description: Added permission which allow user to read in aiq - id: 666a3f38-d4fa-5b62-a391-a69029758d32 - metadata: - createdBy: 8f84cf09-8036-51e4-b579-bd30cb07b269 - creationTimestamp: "2022-10-06T20:58:16.305662Z" - labels: [] - modificationTimestamp: "2022-10-06T20:58:16.305662Z" - modifiedby: 8f84cf09-8036-51e4-b579-bd30cb07b269 - rule: aiq:system-read - serviceApplication: aiq - type: application/vnd.netapp.bxp.permission - version: "1.0" - schema: - $ref: '#/components/schemas/permission_1.0_get_response_body' - description: Returns the stored permission in the JSON response body. - "400": - $ref: '#/components/responses/400BadRequest' - "401": - $ref: '#/components/responses/401Unauthorized' - "403": - $ref: '#/components/responses/403Forbidden' - "404": - $ref: '#/components/responses/404NotFound' - summary: Retrieve a permission on a resource for a user - tags: - - Permission - x-permission: bxp:permission-read - x-persistence: true - x-scope: documentation,private,public - parameters: - - description: ID of the user. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: user_id - required: true - schema: - format: uuid - type: string - - description: ID of the resource. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: resource_id - required: true - schema: - format: uuid - type: string - - description: ID of the permission. - example: 666a3f38-d4fa-5b62-a391-a69029758d32 - in: path - name: permission_id - required: true - schema: - format: uuid - type: string - /users/{user_id}/roles: - get: - description: Lists all roles for the specified user. - parameters: - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/include' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/order_by' - - $ref: '#/components/parameters/count' - - $ref: '#/components/parameters/continue' - responses: - "200": - content: - application/vnd.netapp.bxp.roles+json: - schema: - $ref: '#/components/schemas/role_1.0_list_response_body' - description: List of all roles - headers: - Location: - description: Location of roles where a specific user is referenced. - schema: - format: uri - type: string - summary: List all roles for the specified user - tags: - - Role - x-cache-control: no-cache - x-permission: bxp:role-read - x-persistence: true - x-scope: documentation,private,public -security: - - bxp_bearer_auth: [] -servers: - - url: '{{.Server}}' -tags: - - description: "The partnership endpoints enable collaboration between two organizations in the NetApp Console.\n\nA partnership represents an organization sharing resources (the source organization) with users of a different organization (the destination organization). Partnership allows the source organization to grant permissions to users from the destination organization, enabling them to manage one or more organization's resources. Grants define the access (set of permissions) that a user from the destination organization has on a resource from the source organization.\n\nA partnership has multiple grants. A grant is defined by:\n
      • A list of users from the destination organization
        • \n
      • A list of resources from the source organization
        • \n
      • A role applicable between these two groups which is referenced in the partnershipType.
        • \n
      \n\nThe partnership type defines the possible roles that can be applied between users and resources. The current supported partnership types are Self-Service." - name: Partnership - - description: |- - The resource and resourcegroup endpoints enable management of NetApp Console identity and access management (IAM) ResourceTypes, resources, and resource groups. - - ResourceTypes represent the various types of resources that are stored in IAM and can only be modified by NetApp. - - A resource is a working environment that NetApp Console already manages or an undiscovered resource that is associated with your organization (for example, an on-premises ONTAP cluster). NetApp Console is aware of undiscovered resources based on your organization's telemetry data. - - A resource group is a set of resources that you can manage as a group. In IAM, you can manage implicit resource groups and explicit resource groups. In an implicit resource group, resources belong to the same organization, project, or folder. In an explicit resource group, resources can belong to different elements of a resource hierarchy. - name: Resource and Resourcegroup - - description: "The permission endpoints provide access to an internal collection of available permissions in NetApp Console identity and access management (IAM). Permissions are defined as a low-level string of characters that a user or service account can use to determine authorization.\n \nA user can have permissions for the resources in the entire organization or in specific folders and projects. Permissions prevent or allow a user to perform specific actions at a specific level of the resource hierarchy." - name: Permission - - description: "The role endpoints enable you to create and view roles, which are sets of permissions. \n\nIn NetApp Console identity and access management (IAM), you don't assign permissions directly to users in an organization. Instead, you assign each user a role. A role contains a set of permissions that enables a user to perform specific actions at a specific level of the resource hierarchy. Roles can represent actions or features, or the access level that user has for a particular service.\n\nIAM supports several predefined roles that you can assign to the users in your organization. Custom roles are not supported." - name: Role - - description: |- - The hierarchy endpoints enable you to accurately represent your organization's complete resource hierarchy using folders and projects. - - A Hierarchy is composed of multiple elements: -
        -
      • The organization is the top of the NetApp Console IAM hierarchy. Optionally, you can also have a child organization under a parent organization. An organization represents a purchaser of goods or services from NetApp.
        • -
      • Folders are children of the organization or of another folder. Folders are optional in NetApp Console IAM and can represent a city, department, region, deployment environment, and so on.
        • -
      • Projects are children of the organization or of a folder. Projects represent a working space in NetApp Console that organization members can access to manage resources.
        • -
      • Resources are associated with one or more folders or projects.
        • -
      - name: Hierarchy - - description: |- - The user and usergroup endpoints enable you to create and manage users and user groups. - - In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. - - A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. - name: User and Usergroup diff --git a/tenancyv4/user_and_usergroup_overview.adoc b/tenancyv4/user_and_usergroup_overview.adoc new file mode 100644 index 00000000..19a97377 --- /dev/null +++ b/tenancyv4/user_and_usergroup_overview.adoc @@ -0,0 +1,19 @@ +--- +sidebar: sidebar +api: true +explorer: false +permalink: 'tenancyv4/user_and_usergroup_overview.html' +summary: 'User and usergroup endpoints in the identity and access management REST API for the NetApp Console' +--- + += User and usergroup endpoints in the identity and access management REST API for the NetApp Console + + + +The user and usergroup endpoints enable you to create and manage users and user groups. + +In NetApp Console identity and access management (IAM), a user represents a human user, a service account, or an agent. For example, you can create a user that represents a Connector. + +A user group is a set of users that you can manage as a group. In NetApp Console IAM, you can manage implicit user groups and explicit user groups. In an implicit user group, users belong to the same organization, project, or folder. In an explicit user group, users can belong to different elements of the resource hierarchy. + +